v1

package

Go to main page

Versions in this module

v0

v0.6.0

Feb 17, 2022

Changes in this version

+ const SampleWorkloadAPIDomain

+ const SampleWorkloadAPIGroup

+ const SampleWorkloadAPIKind

+ const SampleWorkloadAPIVersion

+ var ErrAssociateResourceMarker = errors.New("unable to associate resource marker with field marker")

+ var ErrConvertArrayInterface = errors.New("unable to convert to []interface{}")

+ var ErrConvertArrayString = errors.New("unable to convert to []string")

+ var ErrConvertMapStringInterface = errors.New("unable to convert to map[string]interface{}")

+ var ErrConvertString = errors.New("unable to convert to string")

+ var ErrFieldMarkerInvalidType = errors.New("field marker type is invalid")

+ var ErrFileExists = errors.New("force was not requested and file exists")

+ var ErrMismatchedMarkerTypes = errors.New("resource marker and field marker have mismatched types")

+ var ErrNumberResourceMarkers = errors.New("expected only 1 resource marker")

+ var ErrReservedFieldMarker = errors.New("field marker cannot be used and is reserved for internal purposes")

+ var ErrResourceMarkerMissingFieldMarker = errors.New("resource marker has no associated 'field' or 'collectionField' marker")

+ var ErrResourceMarkerMissingFieldValue = errors.New("resource marker missing 'collectionField', 'field' or 'value'")

+ var ErrResourceMarkerMissingInclude = errors.New("resource marker missing 'include' value")

+ var ErrResourceMarkerUnknownValueType = errors.New("resource marker 'value' is of unknown type")

+ var ErrWriteFile = errors.New("unable to write to file")

+ var ErrWriteStdout = errors.New("unable to write to stdout")

+ func WriteConfig(options *InitConfigOptions) error

type APIFields

+ Last bool

type ChildResource

+ IncludeCode string

type CliCommand

+ IsRootcommand bool

+ IsSubcommand bool

+ func (cli *CliCommand) SetDefaults(workload WorkloadAPIBuilder, isSubcommand bool)

type ComponentWorkload

+ func NewComponentWorkload(name string, spec WorkloadAPISpec, resourceFiles, dependencies []string) *ComponentWorkload

+ func (c *ComponentWorkload) GetAPISpec() WorkloadAPISpec

+ func (c *ComponentWorkload) HasRootCmdName() bool

+ func (c *ComponentWorkload) SetRBAC()

+ type InitConfigOptions struct

+ Force bool

+ Path string

+ WorkloadConfig WorkloadInitializer

type MarkerType

+ const ResourceMarkerType

+ type RBACRoleRule struct

+ Groups RBACRoleRuleField

+ Resources RBACRoleRuleField

+ URLs RBACRoleRuleField

+ Verbs RBACRoleRuleField

+ type RBACRoleRuleField []string

type RBACRule

+ URLs []string

+ func (r *RBACRule) ToMarker() string

type RBACRules

+ func (rs *RBACRules) AddOrUpdateRoleRules(newRule *RBACRoleRule)

type Resource

+ func ResourcesFromFiles(resourceFiles []string) []*Resource

+ type ResourceMarker struct

+ CollectionField *string

+ Field *string

+ Include *bool

+ Value interface{}

+ func (rm ResourceMarker) String() string

type StandaloneWorkload

+ func NewStandaloneWorkload(name string, spec WorkloadAPISpec, resourceFiles []string) *StandaloneWorkload

+ func (s *StandaloneWorkload) GetAPISpec() WorkloadAPISpec

+ func (s *StandaloneWorkload) SetRBAC()

type WorkloadAPIBuilder

+ SetRBAC func()

type WorkloadAPISpec

+ func NewSampleAPISpec() *WorkloadAPISpec

type WorkloadCollection

+ func NewWorkloadCollection(name string, spec WorkloadAPISpec, componentFiles []string) *WorkloadCollection

+ func (c *WorkloadCollection) GetAPISpec() WorkloadAPISpec

+ func (c *WorkloadCollection) SetRBAC()

type WorkloadInitializer

+ GetWorkloadKind func() WorkloadKind

type WorkloadSpec

+ CollectionFieldMarkers []*CollectionFieldMarker

+ FieldMarkers []*FieldMarker

+ ForCollection bool

v0.5.1

Jan 19, 2022

v0.5.0

Dec 17, 2021

Changes in this version

+ func Glob(pattern string) ([]string, error)

type CliCommand

+ SubCommands *[]CliCommand

+ func (cli *CliCommand) GetSubCmdRelativeFileName(rootCmdName string, subCommandFolder string, group string, fileName string) string

type ComponentWorkload

+ func (c *ComponentWorkload) GetCollection() *WorkloadCollection

+ func (c *ComponentWorkload) GetRootCommand() *CliCommand

+ func (c *ComponentWorkload) GetSubCommand() *CliCommand

type ComponentWorkloadSpec

+ CompanionCliRootcmd CliCommand

type StandaloneWorkload

+ func (s *StandaloneWorkload) GetCollection() *WorkloadCollection

+ func (s *StandaloneWorkload) GetRootCommand() *CliCommand

+ func (s *StandaloneWorkload) GetSubCommand() *CliCommand

type WorkloadAPIBuilder

+ GetCollection func() *WorkloadCollection

+ GetRootCommand func() *CliCommand

+ GetSubCommand func() *CliCommand

type WorkloadCollection

+ func (c *WorkloadCollection) GetCollection() *WorkloadCollection

+ func (c *WorkloadCollection) GetRootCommand() *CliCommand

+ func (c *WorkloadCollection) GetSubCommand() *CliCommand

type WorkloadInitializer

+ GetRootCommand func() *CliCommand

+ IsCollection func() bool

type WorkloadSpec

+ Collection *WorkloadCollection

v0.4.0

Oct 29, 2021

Changes in this version

+ var ErrOverwriteExistingValue = errors.New("an attempt to overwrite existing value was made")

+ type APIFields struct

+ Children []*APIFields

+ Comments []string

+ Default string

+ Markers []string

+ Name string

+ Sample string

+ StructName string

+ Tags string

+ Type FieldType

+ func (api *APIFields) AddField(path string, fieldType FieldType, comments []string, sample interface{}, ...) error

+ func (api *APIFields) GenerateAPISpec(kind string) string

+ func (api *APIFields) GenerateSampleSpec() string

type CollectionFieldMarker

+ func (cfm CollectionFieldMarker) String() string

type ComponentWorkload

+ func (c *ComponentWorkload) LoadManifests(workloadPath string) error

type FieldType

+ const FieldStruct

+ type MarkerType int

+ const CollectionMarkerType

+ const FieldMarkerType

+ type OwnershipRules []OwnershipRule

+ type RBACRules []RBACRule

+ func (rs *RBACRules) AddOrUpdateRules(newRule *RBACRule)

+ type Resource struct

+ Content []byte

+ FileName string

+ func (r *Resource) UnmarshalYAML(node *yaml.Node) error

type StandaloneWorkload

+ func (s *StandaloneWorkload) LoadManifests(workloadPath string) error

type WorkloadAPIBuilder

+ LoadManifests func(workloadPath string) error

+ type WorkloadAPISpec struct

+ ClusterScoped bool

+ Domain string

+ Group string

+ Kind string

+ Version string

type WorkloadCollection

+ func (c *WorkloadCollection) LoadManifests(workloadPath string) error

type WorkloadKind

+ const WorkloadKindUnknown

+ func (wk *WorkloadKind) UnmarshalJSON(data []byte) error

+ func (wk *WorkloadKind) UnmarshalYAML(node *yaml.Node) error

+ func (wk WorkloadKind) String() string

+ type WorkloadSpec struct

+ APISpecFields *APIFields

+ OwnershipRules *OwnershipRules

+ RBACRules *RBACRules

+ Resources []*Resource

+ SourceFiles *[]SourceFile

v0.3.0

Oct 18, 2021

Changes in this version

+ var ErrMissingRequiredFields = errors.New("missing required fields")

+ var ErrNoComponentsOnComponent = errors.New("cannot set component workloads on a component workload - only on collections")

+ var ErrNoComponentsOnStandalone = errors.New("cannot set component workloads on a component workload - only on collections")

+ var ErrUnableToParseFieldType = errors.New("unable to parse field")

+ var ErrUnsupportedDataType = errors.New("unsupported data type in workload marker")

type ComponentWorkload

+ func (c *ComponentWorkload) GetDomain() string

+ func (c *ComponentWorkload) GetRootcommandVarName() string

+ func (c *ComponentWorkload) GetSubcommands() *[]CliCommand

+ func (c *ComponentWorkload) HasSubCmdDescription() bool

type FieldMarker

+ Replace *string

type SourceCodeTemplateData

+ OwnershipRules *[]OwnershipRule

+ RBACRules *[]RBACRule

+ SourceFiles *[]SourceFile

+ SpecFields []*APISpecField

type StandaloneWorkload

+ func (s *StandaloneWorkload) GetRootcommandVarName() string

+ func (s *StandaloneWorkload) GetSubcommands() *[]CliCommand

+ func (s *StandaloneWorkload) HasRootCmdDescription() bool

type WorkloadAPIBuilder

+ GetRootcommandVarName func() string

+ GetSubcommands func() *[]CliCommand

type WorkloadCollection

+ func (c *WorkloadCollection) GetRootcommandVarName() string

+ func (c *WorkloadCollection) GetSubcommands() *[]CliCommand

+ func (c *WorkloadCollection) HasRootCmdDescription() bool

+ func (c *WorkloadCollection) HasSubCmdDescription() bool

type WorkloadCollectionSpec

+ CompanionCliSubcmd CliCommand

+ OwnershipRules []OwnershipRule

+ RBACRules []RBACRule

+ Resources []string

+ SourceFiles []SourceFile

v0.2.1

Oct 7, 2021

v0.2.0

Sep 13, 2021

Changes in this version

+ const PluginConfigKey

+ var ErrCollectionRequired = errors.New("a WorkloadCollection is required when using WorkloadComponents")

+ var ErrConfigMustExist = errors.New("no workload config provided - workload config required")

+ var ErrInvalidKind = errors.New("unrecognized workload kind in workload config")

+ var ErrMissingDependencies = errors.New("missing dependencies - no workload config provided")

+ var ErrMissingWorkload = errors.New("could not find either standalone or collection workload, please provide one")

+ var ErrMultipleConfigs = errors.New(...)

+ var ErrNamesMustBeUnique = errors.New("each workload name must be unique")

+ func CloseFile(file io.ReadCloser)

+ func InitializeMarkerInspector() (*inspect.Inspector, error)

+ func ReadStream(fileName string) (io.ReadCloser, error)

+ func SupportedMarkerDataTypes() []string

+ func TransformYAML(results ...*inspect.YAMLResult) error

+ type APISpec struct

+ ClusterScoped bool

+ Domain string

+ Group string

+ Kind string

+ Version string

+ type APISpecField struct

+ APISpecContent string

+ DataType string

+ DefaultVal string

+ DocumentationLines []string

+ FieldName string

+ ManifestFieldName string

+ SampleField string

+ ZeroVal string

+ type ChildResource struct

+ Group string

+ Kind string

+ Name string

+ SourceCode string

+ StaticContent string

+ UniqueName string

+ Version string

+ type CliCommand struct

+ Description string

+ FileName string

+ Name string

+ VarName string

+ type CollectionFieldMarker FieldMarker

+ type ComponentWorkload struct

+ Spec ComponentWorkloadSpec

+ func (*ComponentWorkload) GetComponents() []*ComponentWorkload

+ func (*ComponentWorkload) GetRootcommandName() string

+ func (*ComponentWorkload) IsCollection() bool

+ func (*ComponentWorkload) IsComponent() bool

+ func (*ComponentWorkload) IsStandalone() bool

+ func (*ComponentWorkload) SetComponents(components []*ComponentWorkload) error

+ func (c *ComponentWorkload) GetAPIGroup() string

+ func (c *ComponentWorkload) GetAPIKind() string

+ func (c *ComponentWorkload) GetAPISpecFields() []*APISpecField

+ func (c *ComponentWorkload) GetAPIVersion() string

+ func (c *ComponentWorkload) GetComponentResource(domain, repo string, clusterScoped bool) *resource.Resource

+ func (c *ComponentWorkload) GetDependencies() []*ComponentWorkload

+ func (c *ComponentWorkload) GetFuncNames() (createFuncNames, initFuncNames []string)

+ func (c *ComponentWorkload) GetName() string

+ func (c *ComponentWorkload) GetOwnershipRules() *[]OwnershipRule

+ func (c *ComponentWorkload) GetPackageName() string

+ func (c *ComponentWorkload) GetRBACRules() *[]RBACRule

+ func (c *ComponentWorkload) GetSourceFiles() *[]SourceFile

+ func (c *ComponentWorkload) GetSubcommandDescr() string

+ func (c *ComponentWorkload) GetSubcommandFileName() string

+ func (c *ComponentWorkload) GetSubcommandName() string

+ func (c *ComponentWorkload) GetSubcommandVarName() string

+ func (c *ComponentWorkload) GetWorkloadKind() WorkloadKind

+ func (c *ComponentWorkload) HasChildResources() bool

+ func (c *ComponentWorkload) HasSubCmdName() bool

+ func (c *ComponentWorkload) IsClusterScoped() bool

+ func (c *ComponentWorkload) SetNames()

+ func (c *ComponentWorkload) SetResources(workloadPath string) error

+ func (c *ComponentWorkload) Validate() error

+ type ComponentWorkloadSpec struct

+ API APISpec

+ APISpecFields []*APISpecField

+ CompanionCliSubcmd CliCommand

+ ComponentDependencies []*ComponentWorkload

+ ConfigPath string

+ Dependencies []string

+ OwnershipRules []OwnershipRule

+ RBACRules []RBACRule

+ Resources []string

+ SourceFiles []SourceFile

+ type FieldMarker struct

+ Default interface{}

+ Description *string

+ Name string

+ Type FieldType

+ func (fm FieldMarker) String() string

+ type FieldType int

+ const FieldBool

+ const FieldInt

+ const FieldString

+ const FieldUnknownType

+ func (f *FieldType) UnmarshalMarkerArg(in string) error

+ func (f FieldType) String() string

+ type OwnershipRule struct

+ CoreAPI bool

+ Kind string

+ Version string

+ type PluginConfig struct

+ CliRootCommandName string

+ WorkloadConfigPath string

+ type RBACRule struct

+ Group string

+ Resource string

+ VerbString string

+ Verbs []string

+ func (rule *RBACRule) AddVerb(verb string)

+ type SourceCodeTemplateData struct

+ OwnershipRule *[]OwnershipRule

+ RBACRule *[]RBACRule

+ SourceFile *[]SourceFile

+ SpecField []*APISpecField

+ type SourceFile struct

+ Children []ChildResource

+ Filename string

+ HasStatic bool

+ type StandaloneWorkload struct

+ Spec StandaloneWorkloadSpec

+ func (*StandaloneWorkload) GetComponentResource(domain, repo string, clusterScoped bool) *resource.Resource

+ func (*StandaloneWorkload) GetDependencies() []*ComponentWorkload

+ func (*StandaloneWorkload) GetSubcommandDescr() string

+ func (*StandaloneWorkload) GetSubcommandFileName() string

+ func (*StandaloneWorkload) GetSubcommandName() string

+ func (*StandaloneWorkload) GetSubcommandVarName() string

+ func (*StandaloneWorkload) HasSubCmdName() bool

+ func (*StandaloneWorkload) IsCollection() bool

+ func (*StandaloneWorkload) IsComponent() bool

+ func (*StandaloneWorkload) IsStandalone() bool

+ func (*StandaloneWorkload) SetComponents(components []*ComponentWorkload) error

+ func (s *StandaloneWorkload) GetAPIGroup() string

+ func (s *StandaloneWorkload) GetAPIKind() string

+ func (s *StandaloneWorkload) GetAPISpecFields() []*APISpecField

+ func (s *StandaloneWorkload) GetAPIVersion() string

+ func (s *StandaloneWorkload) GetComponents() []*ComponentWorkload

+ func (s *StandaloneWorkload) GetDomain() string

+ func (s *StandaloneWorkload) GetFuncNames() (createFuncNames, initFuncNames []string)

+ func (s *StandaloneWorkload) GetName() string

+ func (s *StandaloneWorkload) GetOwnershipRules() *[]OwnershipRule

+ func (s *StandaloneWorkload) GetPackageName() string

+ func (s *StandaloneWorkload) GetRBACRules() *[]RBACRule

+ func (s *StandaloneWorkload) GetRootCmdDescr() string

+ func (s *StandaloneWorkload) GetRootCmdName() string

+ func (s *StandaloneWorkload) GetRootcommandName() string

+ func (s *StandaloneWorkload) GetSourceFiles() *[]SourceFile

+ func (s *StandaloneWorkload) GetWorkloadKind() WorkloadKind

+ func (s *StandaloneWorkload) HasChildResources() bool

+ func (s *StandaloneWorkload) HasRootCmdName() bool

+ func (s *StandaloneWorkload) IsClusterScoped() bool

+ func (s *StandaloneWorkload) SetNames()

+ func (s *StandaloneWorkload) SetResources(workloadPath string) error

+ func (s *StandaloneWorkload) Validate() error

+ type StandaloneWorkloadSpec struct

+ API APISpec

+ APISpecFields []*APISpecField

+ CompanionCliRootcmd CliCommand

+ OwnershipRules []OwnershipRule

+ RBACRules []RBACRule

+ Resources []string

+ SourceFiles []SourceFile

+ type WorkloadAPIBuilder interface

+ GetAPIGroup func() string

+ GetAPIKind func() string

+ GetAPISpecFields func() []*APISpecField

+ GetAPIVersion func() string

+ GetComponentResource func(domain, repo string, clusterScoped bool) *resource.Resource

+ GetComponents func() []*ComponentWorkload

+ GetDependencies func() []*ComponentWorkload

+ GetDomain func() string

+ GetFuncNames func() (createFuncNames, initFuncNames []string)

+ GetName func() string

+ GetOwnershipRules func() *[]OwnershipRule

+ GetPackageName func() string

+ GetRBACRules func() *[]RBACRule

+ GetRootcommandName func() string

+ GetSourceFiles func() *[]SourceFile

+ GetSubcommandDescr func() string

+ GetSubcommandFileName func() string

+ GetSubcommandName func() string

+ GetSubcommandVarName func() string

+ HasChildResources func() bool

+ HasSubCmdName func() bool

+ IsClusterScoped func() bool

+ IsCollection func() bool

+ IsComponent func() bool

+ IsStandalone func() bool

+ SetComponents func(components []*ComponentWorkload) error

+ SetNames func()

+ SetResources func(workloadPath string) error

+ Validate func() error

+ func ProcessAPIConfig(workloadConfig string) (WorkloadAPIBuilder, error)

+ type WorkloadCollection struct

+ Spec WorkloadCollectionSpec

+ func (*WorkloadCollection) GetComponentResource(domain, repo string, clusterScoped bool) *resource.Resource

+ func (*WorkloadCollection) GetOwnershipRules() *[]OwnershipRule

+ func (*WorkloadCollection) GetRBACRules() *[]RBACRule

+ func (*WorkloadCollection) GetSubcommandDescr() string

+ func (*WorkloadCollection) GetSubcommandFileName() string

+ func (*WorkloadCollection) GetSubcommandName() string

+ func (*WorkloadCollection) GetSubcommandVarName() string

+ func (*WorkloadCollection) HasChildResources() bool

+ func (*WorkloadCollection) HasSubCmdName() bool

+ func (c *WorkloadCollection) GetAPIGroup() string

+ func (c *WorkloadCollection) GetAPIKind() string

+ func (c *WorkloadCollection) GetAPISpecFields() []*APISpecField

+ func (c *WorkloadCollection) GetAPIVersion() string

+ func (c *WorkloadCollection) GetComponents() []*ComponentWorkload

+ func (c *WorkloadCollection) GetDependencies() []*ComponentWorkload

+ func (c *WorkloadCollection) GetDomain() string

+ func (c *WorkloadCollection) GetFuncNames() (createFuncNames, initFuncNames []string)

+ func (c *WorkloadCollection) GetName() string

+ func (c *WorkloadCollection) GetPackageName() string

+ func (c *WorkloadCollection) GetRootCmdDescr() string

+ func (c *WorkloadCollection) GetRootCmdName() string

+ func (c *WorkloadCollection) GetRootcommandName() string

+ func (c *WorkloadCollection) GetSourceFiles() *[]SourceFile

+ func (c *WorkloadCollection) GetWorkloadKind() WorkloadKind

+ func (c *WorkloadCollection) HasRootCmdName() bool

+ func (c *WorkloadCollection) IsClusterScoped() bool

+ func (c *WorkloadCollection) IsCollection() bool

+ func (c *WorkloadCollection) IsComponent() bool

+ func (c *WorkloadCollection) IsStandalone() bool

+ func (c *WorkloadCollection) SetComponents(components []*ComponentWorkload) error

+ func (c *WorkloadCollection) SetNames()

+ func (c *WorkloadCollection) SetResources(workloadPath string) error

+ func (c *WorkloadCollection) Validate() error

+ type WorkloadCollectionSpec struct

+ API APISpec

+ APISpecFields []*APISpecField

+ CompanionCliRootcmd CliCommand

+ ComponentFiles []string

+ Components []*ComponentWorkload

+ type WorkloadIdentifier interface

+ GetName func() string

+ GetWorkloadKind func() WorkloadKind

+ type WorkloadInitializer interface

+ GetDomain func() string

+ GetRootCmdDescr func() string

+ GetRootCmdName func() string

+ HasRootCmdName func() bool

+ SetNames func()

+ Validate func() error

+ func ProcessInitConfig(workloadConfig string) (WorkloadInitializer, error)

+ type WorkloadKind string

+ const WorkloadKindCollection

+ const WorkloadKindComponent

+ const WorkloadKindStandalone

+ type WorkloadShared struct

+ Kind WorkloadKind

+ Name string

+ PackageName string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL