resource

Documentation

Index

• type AddToScheme
  • func (a *AddToScheme) GetInput() (input.Input, error)
• type CRD
  • func (c *CRD) GetInput() (input.Input, error)
• type CRDSample
  • func (c *CRDSample) GetInput() (input.Input, error)
• type Doc
  • func (a *Doc) GetInput() (input.Input, error)
• type Group
  • func (g *Group) GetInput() (input.Input, error)
• type Register
  • func (r *Register) GetInput() (input.Input, error)
• type Resource
  • func (r *Resource) Validate() error
• type Role
  • func (r *Role) GetInput() (input.Input, error)
• type RoleBinding
  • func (r *RoleBinding) GetInput() (input.Input, error)
• type Types
  • func (t *Types) GetInput() (input.Input, error)
  • func (t *Types) Validate() error
• type TypesTest
  • func (t *TypesTest) GetInput() (input.Input, error)
  • func (t *TypesTest) Validate() error
• type VersionSuiteTest
  • func (v *VersionSuiteTest) GetInput() (input.Input, error)

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

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.

func (*CRD) GetInput

func (c *CRD) GetInput() (input.Input, error)

GetInput implements input.File

type CRDSample

type CRDSample struct {
	input.Input

	// Resource is a resource in the API group
	Resource *Resource
}

CRDSample scaffolds a manifest for CRD sample.

func (*CRDSample) GetInput

func (c *CRDSample) GetInput() (input.Input, error)

GetInput implements input.File

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

func (*Doc) GetInput

func (a *Doc) GetInput() (input.Input, error)

GetInput implements input.File

type Group

type Group struct {
	input.Input

	// Resource is a resource in the API group
	Resource *Resource
}

Group scaffolds the pkg/apis/group/group.go

func (*Group) GetInput

func (g *Group) GetInput() (input.Input, error)

GetInput implements input.File

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

func (*Register) GetInput

func (r *Register) GetInput() (input.Input, error)

GetInput implements input.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.

func (*Resource) Validate

func (r *Resource) Validate() error

Validate checks the Resource values to make sure they are valid.

type Role

type Role struct {
	input.Input

	// Resource is a resource in the API group
	Resource *Resource
}

Role scaffolds the config/manager/group_role_rbac.yaml file

func (*Role) GetInput

func (r *Role) GetInput() (input.Input, error)

GetInput implements input.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

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

func (*Types) GetInput

func (t *Types) GetInput() (input.Input, error)

GetInput implements input.File

func (*Types) Validate

func (t *Types) Validate() error

Validate validates the values

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

func (*TypesTest) GetInput

func (t *TypesTest) GetInput() (input.Input, error)

GetInput implements input.File

func (*TypesTest) Validate

func (t *TypesTest) Validate() error

Validate validates the values

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