Documentation
¶
Overview ¶
+kubebuilder:object:generate=true
Index ¶
- type CustomResource
- func (in *CustomResource) DeepCopy() *CustomResource
- func (in *CustomResource) DeepCopyInto(out *CustomResource)
- func (*CustomResource) Descriptor() ([]byte, []int)
- func (m *CustomResource) GetGVK() *GroupVersionKind
- func (m *CustomResource) GetManifest() string
- func (*CustomResource) ProtoMessage()
- func (m *CustomResource) Reset()
- func (m *CustomResource) String() string
- func (m *CustomResource) XXX_DiscardUnknown()
- func (m *CustomResource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CustomResource) XXX_Merge(src proto.Message)
- func (m *CustomResource) XXX_Size() int
- func (m *CustomResource) XXX_Unmarshal(b []byte) error
- type GroupVersionKind
- func (in *GroupVersionKind) DeepCopy() *GroupVersionKind
- func (in *GroupVersionKind) DeepCopyInto(out *GroupVersionKind)
- func (*GroupVersionKind) Descriptor() ([]byte, []int)
- func (m *GroupVersionKind) GetGroup() string
- func (m *GroupVersionKind) GetKind() string
- func (m *GroupVersionKind) GetVersion() string
- func (*GroupVersionKind) ProtoMessage()
- func (m *GroupVersionKind) Reset()
- func (m *GroupVersionKind) String() string
- func (m *GroupVersionKind) XXX_DiscardUnknown()
- func (m *GroupVersionKind) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GroupVersionKind) XXX_Merge(src proto.Message)
- func (m *GroupVersionKind) XXX_Size() int
- func (m *GroupVersionKind) XXX_Unmarshal(b []byte) error
- type Namespace
- func (in *Namespace) DeepCopy() *Namespace
- func (in *Namespace) DeepCopyInto(out *Namespace)
- func (*Namespace) Descriptor() ([]byte, []int)
- func (m *Namespace) GetClusterName() string
- func (m *Namespace) GetNsResources() *NamespaceResources
- func (m *Namespace) GetParams() map[string]string
- func (m *Namespace) GetTemplateName() string
- func (*Namespace) ProtoMessage()
- func (m *Namespace) Reset()
- func (m *Namespace) String() string
- func (m *Namespace) XXX_DiscardUnknown()
- func (m *Namespace) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Namespace) XXX_Merge(src proto.Message)
- func (m *Namespace) XXX_Size() int
- func (m *Namespace) XXX_Unmarshal(b []byte) error
- type NamespaceResources
- func (in *NamespaceResources) DeepCopy() *NamespaceResources
- func (in *NamespaceResources) DeepCopyInto(out *NamespaceResources)
- func (*NamespaceResources) Descriptor() ([]byte, []int)
- func (m *NamespaceResources) GetNamespace() *v1.Namespace
- func (m *NamespaceResources) GetResources() []*Resource
- func (*NamespaceResources) ProtoMessage()
- func (m *NamespaceResources) Reset()
- func (m *NamespaceResources) String() string
- func (m *NamespaceResources) XXX_DiscardUnknown()
- func (m *NamespaceResources) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *NamespaceResources) XXX_Merge(src proto.Message)
- func (m *NamespaceResources) XXX_Size() int
- func (m *NamespaceResources) XXX_Unmarshal(b []byte) error
- type NamespaceTemplate
- func (in *NamespaceTemplate) DeepCopy() *NamespaceTemplate
- func (in *NamespaceTemplate) DeepCopyInto(out *NamespaceTemplate)
- func (*NamespaceTemplate) Descriptor() ([]byte, []int)
- func (m *NamespaceTemplate) GetExportedParamName() []string
- func (m *NamespaceTemplate) GetNsResources() *NamespaceResources
- func (*NamespaceTemplate) ProtoMessage()
- func (m *NamespaceTemplate) Reset()
- func (m *NamespaceTemplate) String() string
- func (m *NamespaceTemplate) XXX_DiscardUnknown()
- func (m *NamespaceTemplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *NamespaceTemplate) XXX_Merge(src proto.Message)
- func (m *NamespaceTemplate) XXX_Size() int
- func (m *NamespaceTemplate) XXX_Unmarshal(b []byte) error
- type Resource
- func (in *Resource) DeepCopy() *Resource
- func (in *Resource) DeepCopyInto(out *Resource)
- func (*Resource) Descriptor() ([]byte, []int)
- func (m *Resource) GetCreateOnly() string
- func (m *Resource) GetCustomResource() *CustomResource
- func (m *Resource) GetDependsOn() string
- func (m *Resource) GetName() string
- func (m *Resource) GetResourceQuota() *v1.ResourceQuota
- func (m *Resource) GetRole() *v11.Role
- func (m *Resource) GetRoleBinding() *v11.RoleBinding
- func (m *Resource) GetServiceAccount() *v1.ServiceAccount
- func (m *Resource) GetType() string
- func (*Resource) ProtoMessage()
- func (m *Resource) Reset()
- func (m *Resource) String() string
- func (m *Resource) XXX_DiscardUnknown()
- func (m *Resource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Resource) XXX_Merge(src proto.Message)
- func (m *Resource) XXX_Size() int
- func (m *Resource) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CustomResource ¶
type CustomResource struct { //GroupVersionKind should be used to provide the specific GVK for this custom resource GVK *GroupVersionKind `protobuf:"bytes,1,opt,name=GVK,proto3" json:"GVK,omitempty"` //manifest should be used to provide the custom resource manifest and must be in JSON Manifest string `protobuf:"bytes,2,opt,name=manifest,proto3" json:"manifest,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*CustomResource) DeepCopy ¶
func (in *CustomResource) DeepCopy() *CustomResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResource.
func (*CustomResource) DeepCopyInto ¶
func (in *CustomResource) DeepCopyInto(out *CustomResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomResource) Descriptor ¶
func (*CustomResource) Descriptor() ([]byte, []int)
func (*CustomResource) GetGVK ¶
func (m *CustomResource) GetGVK() *GroupVersionKind
func (*CustomResource) GetManifest ¶
func (m *CustomResource) GetManifest() string
func (*CustomResource) ProtoMessage ¶
func (*CustomResource) ProtoMessage()
func (*CustomResource) Reset ¶
func (m *CustomResource) Reset()
func (*CustomResource) String ¶
func (m *CustomResource) String() string
func (*CustomResource) XXX_DiscardUnknown ¶
func (m *CustomResource) XXX_DiscardUnknown()
func (*CustomResource) XXX_Marshal ¶
func (m *CustomResource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CustomResource) XXX_Merge ¶
func (m *CustomResource) XXX_Merge(src proto.Message)
func (*CustomResource) XXX_Size ¶
func (m *CustomResource) XXX_Size() int
func (*CustomResource) XXX_Unmarshal ¶
func (m *CustomResource) XXX_Unmarshal(b []byte) error
type GroupVersionKind ¶
type GroupVersionKind struct { //group -custom resource group // +required Group string `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"` //version - custom resource version // +required Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` //kind - custom resource kind // +required Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
GroupVersionKind can be used to provide GVK of a custom resource
func (*GroupVersionKind) DeepCopy ¶
func (in *GroupVersionKind) DeepCopy() *GroupVersionKind
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVersionKind.
func (*GroupVersionKind) DeepCopyInto ¶
func (in *GroupVersionKind) DeepCopyInto(out *GroupVersionKind)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GroupVersionKind) Descriptor ¶
func (*GroupVersionKind) Descriptor() ([]byte, []int)
func (*GroupVersionKind) GetGroup ¶
func (m *GroupVersionKind) GetGroup() string
func (*GroupVersionKind) GetKind ¶
func (m *GroupVersionKind) GetKind() string
func (*GroupVersionKind) GetVersion ¶
func (m *GroupVersionKind) GetVersion() string
func (*GroupVersionKind) ProtoMessage ¶
func (*GroupVersionKind) ProtoMessage()
func (*GroupVersionKind) Reset ¶
func (m *GroupVersionKind) Reset()
func (*GroupVersionKind) String ¶
func (m *GroupVersionKind) String() string
func (*GroupVersionKind) XXX_DiscardUnknown ¶
func (m *GroupVersionKind) XXX_DiscardUnknown()
func (*GroupVersionKind) XXX_Marshal ¶
func (m *GroupVersionKind) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GroupVersionKind) XXX_Merge ¶
func (m *GroupVersionKind) XXX_Merge(src proto.Message)
func (*GroupVersionKind) XXX_Size ¶
func (m *GroupVersionKind) XXX_Size() int
func (*GroupVersionKind) XXX_Unmarshal ¶
func (m *GroupVersionKind) XXX_Unmarshal(b []byte) error
type Namespace ¶
type Namespace struct { //Name of the cluster in which this namespace to be created // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:Pattern=^[a-z0-9-]+$ // +kubebuilder:validation:Required ClusterName string `protobuf:"bytes,1,opt,name=clusterName,proto3" json:"clusterName,omitempty"` //Name of the template to be used to create this namespace //This template must be already exists in the manager // +optional TemplateName string `protobuf:"bytes,2,opt,name=templateName,proto3" json:"templateName,omitempty"` //params can be used to pass the values to the underlying template being used //If included, it tries to replace it in the template mentioned with exported fields // +optional Params map[string]string `` /* 153-byte string literal not displayed */ // NamespaceResources to be created. If templateName also included in the request, //make sure to use this to add "additional resources" only apart from the template // DO NOT Provide namespace in the resources section if you already provided the templateName // +optional NsResources *NamespaceResources `protobuf:"bytes,4,opt,name=nsResources,proto3" json:"nsResources,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Namespace) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Namespace.
func (*Namespace) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Namespace) Descriptor ¶
func (*Namespace) GetClusterName ¶
func (*Namespace) GetNsResources ¶
func (m *Namespace) GetNsResources() *NamespaceResources
func (*Namespace) GetTemplateName ¶
func (*Namespace) ProtoMessage ¶
func (*Namespace) ProtoMessage()
func (*Namespace) XXX_DiscardUnknown ¶
func (m *Namespace) XXX_DiscardUnknown()
func (*Namespace) XXX_Marshal ¶
func (*Namespace) XXX_Unmarshal ¶
type NamespaceResources ¶
type NamespaceResources struct { //Namespace is mandatory // +required Namespace *v1.Namespace `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` //Resources to be created and must include at least namespace // +optional Resources []*Resource `protobuf:"bytes,2,rep,name=resources,proto3" json:"resources,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*NamespaceResources) DeepCopy ¶
func (in *NamespaceResources) DeepCopy() *NamespaceResources
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespaceResources.
func (*NamespaceResources) DeepCopyInto ¶
func (in *NamespaceResources) DeepCopyInto(out *NamespaceResources)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NamespaceResources) Descriptor ¶
func (*NamespaceResources) Descriptor() ([]byte, []int)
func (*NamespaceResources) GetNamespace ¶
func (m *NamespaceResources) GetNamespace() *v1.Namespace
func (*NamespaceResources) GetResources ¶
func (m *NamespaceResources) GetResources() []*Resource
func (*NamespaceResources) ProtoMessage ¶
func (*NamespaceResources) ProtoMessage()
func (*NamespaceResources) Reset ¶
func (m *NamespaceResources) Reset()
func (*NamespaceResources) String ¶
func (m *NamespaceResources) String() string
func (*NamespaceResources) XXX_DiscardUnknown ¶
func (m *NamespaceResources) XXX_DiscardUnknown()
func (*NamespaceResources) XXX_Marshal ¶
func (m *NamespaceResources) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*NamespaceResources) XXX_Merge ¶
func (m *NamespaceResources) XXX_Merge(src proto.Message)
func (*NamespaceResources) XXX_Size ¶
func (m *NamespaceResources) XXX_Size() int
func (*NamespaceResources) XXX_Unmarshal ¶
func (m *NamespaceResources) XXX_Unmarshal(b []byte) error
type NamespaceTemplate ¶
type NamespaceTemplate struct { //exportedParamName to be exported from this template //These params will be passed in namespace creation and values will be replaced //If you are using params in the template, make sure to to include in the resources with ${exportedParamName} //+optional ExportedParamName []string `protobuf:"bytes,1,rep,name=exportedParamName,proto3" json:"exportedParamName,omitempty"` //NamespaceResources consists of all the resources to be created in namespace including custom resources //+required NsResources *NamespaceResources `protobuf:"bytes,2,opt,name=nsResources,proto3" json:"nsResources,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*NamespaceTemplate) DeepCopy ¶
func (in *NamespaceTemplate) DeepCopy() *NamespaceTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespaceTemplate.
func (*NamespaceTemplate) DeepCopyInto ¶
func (in *NamespaceTemplate) DeepCopyInto(out *NamespaceTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NamespaceTemplate) Descriptor ¶
func (*NamespaceTemplate) Descriptor() ([]byte, []int)
func (*NamespaceTemplate) GetExportedParamName ¶
func (m *NamespaceTemplate) GetExportedParamName() []string
func (*NamespaceTemplate) GetNsResources ¶
func (m *NamespaceTemplate) GetNsResources() *NamespaceResources
func (*NamespaceTemplate) ProtoMessage ¶
func (*NamespaceTemplate) ProtoMessage()
func (*NamespaceTemplate) Reset ¶
func (m *NamespaceTemplate) Reset()
func (*NamespaceTemplate) String ¶
func (m *NamespaceTemplate) String() string
func (*NamespaceTemplate) XXX_DiscardUnknown ¶
func (m *NamespaceTemplate) XXX_DiscardUnknown()
func (*NamespaceTemplate) XXX_Marshal ¶
func (m *NamespaceTemplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*NamespaceTemplate) XXX_Merge ¶
func (m *NamespaceTemplate) XXX_Merge(src proto.Message)
func (*NamespaceTemplate) XXX_Size ¶
func (m *NamespaceTemplate) XXX_Size() int
func (*NamespaceTemplate) XXX_Unmarshal ¶
func (m *NamespaceTemplate) XXX_Unmarshal(b []byte) error
type Resource ¶
type Resource struct { //ServiceAccount to be created for this namespace. // Must include type=ServiceAccount and only service account will be read at // the server side and everything else will be ignored // +optional ServiceAccount *v1.ServiceAccount `protobuf:"bytes,1,opt,name=serviceAccount,proto3" json:"serviceAccount,omitempty"` //Role to be created for this namespace. // Must include type=Role and only Role will be read at // the server side and everything else will be ignored // +optional Role *v11.Role `protobuf:"bytes,2,opt,name=role,proto3" json:"role,omitempty"` //RoleBinding to bind the role and service account for this namespace. // Must include type=RoleBinding and only RoleBinding will be read at // the server side and everything else will be ignored // +optional RoleBinding *v11.RoleBinding `protobuf:"bytes,3,opt,name=roleBinding,proto3" json:"roleBinding,omitempty"` //ResourceQuota to be created for this namespace. // Must include type=ResourceQuota and only ResourceQuota will be read at // the server side and everything else will be ignored. // +optional ResourceQuota *v1.ResourceQuota `protobuf:"bytes,4,opt,name=resourceQuota,proto3" json:"resourceQuota,omitempty"` //CustomResource to be created for this namespace //Must include type=CustomResource and only CustomResource will be read at // the server side and everything else will be ignored // +optional CustomResource *CustomResource `protobuf:"bytes,5,opt,name=customResource,proto3" json:"customResource,omitempty"` // +required Name string `protobuf:"bytes,15,opt,name=name,proto3" json:"name,omitempty"` //Type represents which k8s resource is being included in the resource entry //Allowed values are // - ServiceAccount // - Role // - RoleBinding // - ResourceQuota // - CustomResource // +kubebuilder:validation:Enum=ServiceAccount;Role;RoleBinding;ResourceQuota;CustomResource Type string `protobuf:"bytes,16,opt,name=type,proto3" json:"type,omitempty"` //dependsOn is an optional field and can be used to delay the creation until the referenced resource got created //dependsOn should provide the name of the resource it dependent on // +optional DependsOn string `protobuf:"bytes,17,opt,name=dependsOn,proto3" json:"dependsOn,omitempty"` //createOnly param can be used to control whether resource to be created only once and do not overwrite in subsequent reconcile process // +optional // +kubebuilder:validation:Enum="true";"false" CreateOnly string `protobuf:"bytes,18,opt,name=createOnly,proto3" json:"createOnly,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Resource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.
func (*Resource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Resource) Descriptor ¶
func (*Resource) GetCreateOnly ¶
func (*Resource) GetCustomResource ¶
func (m *Resource) GetCustomResource() *CustomResource
func (*Resource) GetDependsOn ¶
func (*Resource) GetResourceQuota ¶
func (m *Resource) GetResourceQuota() *v1.ResourceQuota
func (*Resource) GetRoleBinding ¶
func (m *Resource) GetRoleBinding() *v11.RoleBinding
func (*Resource) GetServiceAccount ¶
func (m *Resource) GetServiceAccount() *v1.ServiceAccount
func (*Resource) ProtoMessage ¶
func (*Resource) ProtoMessage()
func (*Resource) XXX_DiscardUnknown ¶
func (m *Resource) XXX_DiscardUnknown()