v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the tenancy v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubernetes-sigs/multi-tenancy/tenant/pkg/apis/tenancy +k8s:defaulter-gen=TypeMeta +groupName=tenancy.x-k8s.io

Package v1alpha1 contains API Schema definitions for the tenancy v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubernetes-sigs/multi-tenancy/tenant/pkg/apis/tenancy +k8s:defaulter-gen=TypeMeta +groupName=tenancy.x-k8s.io

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Tenant
  • func (in *Tenant) DeepCopy() *Tenant
  • func (in *Tenant) DeepCopyInto(out *Tenant)
  • func (in *Tenant) DeepCopyObject() runtime.Object
• type TenantList
  • func (in *TenantList) DeepCopy() *TenantList
  • func (in *TenantList) DeepCopyInto(out *TenantList)
  • func (in *TenantList) DeepCopyObject() runtime.Object
• type TenantNamespace
  • func (in *TenantNamespace) DeepCopy() *TenantNamespace
  • func (in *TenantNamespace) DeepCopyInto(out *TenantNamespace)
  • func (in *TenantNamespace) DeepCopyObject() runtime.Object
• type TenantNamespaceList
  • func (in *TenantNamespaceList) DeepCopy() *TenantNamespaceList
  • func (in *TenantNamespaceList) DeepCopyInto(out *TenantNamespaceList)
  • func (in *TenantNamespaceList) DeepCopyObject() runtime.Object
• type TenantNamespaceSpec
  • func (in *TenantNamespaceSpec) DeepCopy() *TenantNamespaceSpec
  • func (in *TenantNamespaceSpec) DeepCopyInto(out *TenantNamespaceSpec)
• type TenantNamespaceStatus
  • func (in *TenantNamespaceStatus) DeepCopy() *TenantNamespaceStatus
  • func (in *TenantNamespaceStatus) DeepCopyInto(out *TenantNamespaceStatus)
• type TenantSpec
  • func (in *TenantSpec) DeepCopy() *TenantSpec
  • func (in *TenantSpec) DeepCopyInto(out *TenantSpec)
• type TenantStatus
  • func (in *TenantStatus) DeepCopy() *TenantStatus
  • func (in *TenantStatus) DeepCopyInto(out *TenantStatus)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "tenancy.x-k8s.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type Tenant

type Tenant struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TenantSpec   `json:"spec,omitempty"`
	Status TenantStatus `json:"status,omitempty"`
}

Tenant is the Schema for the tenants API +k8s:openapi-gen=true

func (*Tenant) DeepCopy

func (in *Tenant) DeepCopy() *Tenant

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tenant.

func (*Tenant) DeepCopyInto

func (in *Tenant) DeepCopyInto(out *Tenant)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Tenant) DeepCopyObject

func (in *Tenant) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TenantList

type TenantList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Tenant `json:"items"`
}

TenantList contains a list of Tenant

func (*TenantList) DeepCopy

func (in *TenantList) DeepCopy() *TenantList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantList.

func (*TenantList) DeepCopyInto

func (in *TenantList) DeepCopyInto(out *TenantList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TenantList) DeepCopyObject

func (in *TenantList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TenantNamespace

type TenantNamespace struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TenantNamespaceSpec   `json:"spec,omitempty"`
	Status TenantNamespaceStatus `json:"status,omitempty"`
}

TenantNamespace is the Schema for the tenantnamespaces API +k8s:openapi-gen=true

func (*TenantNamespace) DeepCopy

func (in *TenantNamespace) DeepCopy() *TenantNamespace

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantNamespace.

func (*TenantNamespace) DeepCopyInto

func (in *TenantNamespace) DeepCopyInto(out *TenantNamespace)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TenantNamespace) DeepCopyObject

func (in *TenantNamespace) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TenantNamespaceList

type TenantNamespaceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []TenantNamespace `json:"items"`
}

TenantNamespaceList contains a list of TenantNamespace

func (*TenantNamespaceList) DeepCopy

func (in *TenantNamespaceList) DeepCopy() *TenantNamespaceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantNamespaceList.

func (*TenantNamespaceList) DeepCopyInto

func (in *TenantNamespaceList) DeepCopyInto(out *TenantNamespaceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TenantNamespaceList) DeepCopyObject

func (in *TenantNamespaceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TenantNamespaceSpec

type TenantNamespaceSpec struct {
	// Name of the tenant namespace. If not specified, TenantNamespace CR
	// name will be used.
	// +optional
	Name string `json:"name,omitempty"`
}

TenantNamespaceSpec defines the desired state of TenantNamespace

func (*TenantNamespaceSpec) DeepCopy

func (in *TenantNamespaceSpec) DeepCopy() *TenantNamespaceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantNamespaceSpec.

func (*TenantNamespaceSpec) DeepCopyInto

func (in *TenantNamespaceSpec) DeepCopyInto(out *TenantNamespaceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TenantNamespaceStatus

type TenantNamespaceStatus struct {
	// The namespace that the tenantnamespace CR owns.
	// +optional
	OwnedNamespace string `json:"ownedNamespace,omitempty"`
}

TenantNamespaceStatus defines the observed state of TenantNamespace

func (*TenantNamespaceStatus) DeepCopy

func (in *TenantNamespaceStatus) DeepCopy() *TenantNamespaceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantNamespaceStatus.

func (*TenantNamespaceStatus) DeepCopyInto

func (in *TenantNamespaceStatus) DeepCopyInto(out *TenantNamespaceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TenantSpec

type TenantSpec struct {
	// The name of tenant administration namespace, which is used to create
	// all tenant related policy objects and custom resources.
	// +optional
	TenantAdminNamespaceName string `json:"tenantAdminNamespaceName,omitempty"`
	// If set to True, all the namespaces belong to the tenant are required to
	// have TenantAdminNamespaceName as name prefix. By default, namespace prefix
	// is not required.
	// +optional
	RequireNamespacePrefix bool `json:"requireNamespacePrefix,omitempty"`
	// TenantAdmins are the identities with admin privilege for tenant resources.
	// +optional
	TenantAdmins []rbacv1.Subject `json:"tenantAdmins,omitempty"`
}

TenantSpec defines the desired state of Tenant

func (*TenantSpec) DeepCopy

func (in *TenantSpec) DeepCopy() *TenantSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantSpec.

func (*TenantSpec) DeepCopyInto

func (in *TenantSpec) DeepCopyInto(out *TenantSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TenantStatus

type TenantStatus struct {
}

TenantStatus defines the observed state of Tenant

func (*TenantStatus) DeepCopy

func (in *TenantStatus) DeepCopy() *TenantStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TenantStatus.

func (*TenantStatus) DeepCopyInto

func (in *TenantStatus) DeepCopyInto(out *TenantStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.