Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddToScheme ¶
type AddToScheme struct {
input.Input
// Resource is a resource in the API group
Resource *Resource
}
AddToScheme scaffolds the code to add the resource to a SchemeBuilder.
func (*AddToScheme) GetInput ¶
func (a *AddToScheme) GetInput() (input.Input, error)
GetInput implements input.File
func (*AddToScheme) Validate ¶ added in v1.0.8
func (a *AddToScheme) Validate() error
Validate validates the values
type CRD ¶
type CRD struct {
input.Input
// Scope is Namespaced or Cluster
Scope string
// Plural is the plural lowercase of kind
Plural string
// Resource is a resource in the API group
Resource *Resource
}
CRD scaffolds a CRD yaml file.
type CRDSample ¶
CRDSample scaffolds a manifest for CRD sample.
type Doc ¶
type Doc struct {
input.Input
// Resource is a resource for the API version
Resource *Resource
// Comments are additional lines to write to the doc.go file
Comments []string
}
Doc scaffolds the pkg/apis/group/version/doc.go directory
type Group ¶
Group scaffolds the pkg/apis/group/group.go
type Register ¶
type Register struct {
input.Input
// Resource is the resource to scaffold the types_test.go file for
Resource *Resource
}
Register scaffolds the pkg/apis/group/version/register.go file
type Resource ¶
type Resource struct {
// Namespaced is true if the resource is namespaced
Namespaced bool
// Group is the API Group. Does not contain the domain.
Group string
// Version is the API version - e.g. v1beta1
Version string
// Kind is the API Kind.
Kind string
// Resource is the API Resource.
Resource string
// ShortNames is the list of resource shortnames.
ShortNames []string
// CreateExampleReconcileBody will create a Deployment in the Reconcile example
CreateExampleReconcileBody bool
}
Resource contains the information required to scaffold files for a resource.
type Role ¶
Role scaffolds the config/manager/group_role_rbac.yaml file
type RoleBinding ¶
type RoleBinding struct {
input.Input
// Resource is a resource in the API group
Resource *Resource
}
RoleBinding scaffolds the config/manager/group_rolebinding_rbac.yaml file
func (*RoleBinding) GetInput ¶
func (r *RoleBinding) GetInput() (input.Input, error)
GetInput implements input.File
func (*RoleBinding) Validate ¶ added in v1.0.8
func (r *RoleBinding) Validate() error
Validate validates the values
type Types ¶
type Types struct {
input.Input
// Resource is the resource to scaffold the types_test.go file for
Resource *Resource
}
Types scaffolds the pkg/apis/group/version/kind_types.go file to define the schema for an API
type TypesTest ¶
type TypesTest struct {
input.Input
// Resource is the resource to scaffold the types_test.go file for
Resource *Resource
}
TypesTest scaffolds the pkg/apis/group/version/kind_types_test.go file to test the API schema
type VersionSuiteTest ¶
type VersionSuiteTest struct {
input.Input
// Resource is the resource to scaffold the types_test.go file for
Resource *Resource
}
VersionSuiteTest scaffolds the version_suite_test.go file to setup the versions test
func (*VersionSuiteTest) GetInput ¶
func (v *VersionSuiteTest) GetInput() (input.Input, error)
GetInput implements input.File
func (*VersionSuiteTest) Validate ¶ added in v1.0.8
func (v *VersionSuiteTest) Validate() error
Validate validates the values