ext

Documentation

Index

• type Constraint
• type Creator
• type Distribution
• type Document
• type Exporter
  • func NewExporter(store Lister, namespace string) *Exporter
  • func (e *Exporter) Export(ctx context.Context, w io.Writer) error
• type Flag
• type ImportOpt
  • func WithCreateNamespace() ImportOpt
  • func WithNamespace(ns string) ImportOpt
• type Importer
  • func NewImporter(store Creator, opts ...ImportOpt) *Importer
  • func (i *Importer) Import(ctx context.Context, r io.Reader) (err error)
• type IsSegment
• type Lister
• type Rollout
• type Rule
• type Segment
• type SegmentEmbed
  • func (s *SegmentEmbed) MarshalYAML() (interface{}, error)
  • func (s *SegmentEmbed) UnmarshalYAML(unmarshal func(interface{}) error) error
• type SegmentKey
  • func (s SegmentKey) IsSegment()
• type SegmentRule
• type Segments
  • func (s *Segments) IsSegment()
• type ThresholdRule
• type Variant

Types

type Constraint

type Constraint struct {
	Type        string `yaml:"type,omitempty"`
	Property    string `yaml:"property,omitempty"`
	Operator    string `yaml:"operator,omitempty"`
	Value       string `yaml:"value,omitempty"`
	Description string `yaml:"description,omitempty"`
}

type Creator

type Creator interface {
	GetNamespace(context.Context, *flipt.GetNamespaceRequest) (*flipt.Namespace, error)
	CreateNamespace(context.Context, *flipt.CreateNamespaceRequest) (*flipt.Namespace, error)
	CreateFlag(context.Context, *flipt.CreateFlagRequest) (*flipt.Flag, error)
	CreateVariant(context.Context, *flipt.CreateVariantRequest) (*flipt.Variant, error)
	CreateSegment(context.Context, *flipt.CreateSegmentRequest) (*flipt.Segment, error)
	CreateConstraint(context.Context, *flipt.CreateConstraintRequest) (*flipt.Constraint, error)
	CreateRule(context.Context, *flipt.CreateRuleRequest) (*flipt.Rule, error)
	CreateDistribution(context.Context, *flipt.CreateDistributionRequest) (*flipt.Distribution, error)
	CreateRollout(context.Context, *flipt.CreateRolloutRequest) (*flipt.Rollout, error)
}

type Distribution

type Distribution struct {
	VariantKey string  `yaml:"variant,omitempty"`
	Rollout    float32 `yaml:"rollout,omitempty"`
}

type Document

type Document struct {
	Version   string     `yaml:"version,omitempty"`
	Namespace string     `yaml:"namespace,omitempty"`
	Flags     []*Flag    `yaml:"flags,omitempty"`
	Segments  []*Segment `yaml:"segments,omitempty"`
}

type Exporter

type Exporter struct {
	// contains filtered or unexported fields
}

func NewExporter

func NewExporter(store Lister, namespace string) *Exporter

func (*Exporter) Export

func (e *Exporter) Export(ctx context.Context, w io.Writer) error

type Flag

type Flag struct {
	Key         string     `yaml:"key,omitempty"`
	Name        string     `yaml:"name,omitempty"`
	Type        string     `yaml:"type,omitempty"`
	Description string     `yaml:"description,omitempty"`
	Enabled     bool       `yaml:"enabled"`
	Variants    []*Variant `yaml:"variants,omitempty"`
	Rules       []*Rule    `yaml:"rules,omitempty"`
	Rollouts    []*Rollout `yaml:"rollouts,omitempty"`
}

type ImportOpt

type ImportOpt func(*Importer)

func WithCreateNamespace

func WithCreateNamespace() ImportOpt

func WithNamespace

func WithNamespace(ns string) ImportOpt

type Importer

type Importer struct {
	// contains filtered or unexported fields
}

func NewImporter

func NewImporter(store Creator, opts ...ImportOpt) *Importer

func (*Importer) Import

func (i *Importer) Import(ctx context.Context, r io.Reader) (err error)

type IsSegment

type IsSegment interface {
	IsSegment()
}

IsSegment is used to unify the two types of segments that can come in from the import.

type Lister

type Lister interface {
	ListFlags(context.Context, *flipt.ListFlagRequest) (*flipt.FlagList, error)
	ListSegments(context.Context, *flipt.ListSegmentRequest) (*flipt.SegmentList, error)
	ListRules(context.Context, *flipt.ListRuleRequest) (*flipt.RuleList, error)
	ListRollouts(context.Context, *flipt.ListRolloutRequest) (*flipt.RolloutList, error)
}

type Rollout

type Rollout struct {
	Description string         `yaml:"description,omitempty"`
	Segment     *SegmentRule   `yaml:"segment,omitempty"`
	Threshold   *ThresholdRule `yaml:"threshold,omitempty"`
}

type Rule

type Rule struct {
	Segment       *SegmentEmbed   `yaml:"segment,omitempty"`
	Rank          uint            `yaml:"rank,omitempty"`
	Distributions []*Distribution `yaml:"distributions,omitempty"`
}

type Segment

type Segment struct {
	Key         string        `yaml:"key,omitempty"`
	Name        string        `yaml:"name,omitempty"`
	Description string        `yaml:"description,omitempty"`
	Constraints []*Constraint `yaml:"constraints,omitempty"`
	MatchType   string        `yaml:"match_type,omitempty"`
}

type SegmentEmbed

type SegmentEmbed struct {
	IsSegment `yaml:"-"`
}

func (*SegmentEmbed) MarshalYAML

func (s *SegmentEmbed) MarshalYAML() (interface{}, error)

MarshalYAML tries to type assert to either of the following types that implement IsSegment, and returns the marshaled value.

func (*SegmentEmbed) UnmarshalYAML

func (s *SegmentEmbed) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML attempts to unmarshal a string or `SegmentKeys`, and fails if it can not do so.

type SegmentKey

type SegmentKey string

func (SegmentKey) IsSegment

func (s SegmentKey) IsSegment()

type SegmentRule

type SegmentRule struct {
	Key      string   `yaml:"key,omitempty"`
	Keys     []string `yaml:"keys,omitempty"`
	Operator string   `yaml:"operator,omitempty"`
	Value    bool     `yaml:"value,omitempty"`
}

type Segments

type Segments struct {
	Keys            []string `yaml:"keys,omitempty"`
	SegmentOperator string   `yaml:"operator,omitempty"`
}

func (*Segments) IsSegment

func (s *Segments) IsSegment()

type ThresholdRule

type ThresholdRule struct {
	Percentage float32 `yaml:"percentage,omitempty"`
	Value      bool    `yaml:"value,omitempty"`
}

type Variant

type Variant struct {
	Key         string      `yaml:"key,omitempty"`
	Name        string      `yaml:"name,omitempty"`
	Description string      `yaml:"description,omitempty"`
	Attachment  interface{} `yaml:"attachment,omitempty"`
}