v1

Documentation

Index

• Constants
• Variables
• func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc
• func Resource(resource string) schema.GroupResource
• type Network
  • func (x *Network) DeepCopy() *Network
  • func (in *Network) DeepCopyInto(out *Network)
  • func (x *Network) DeepCopyObject() runtime.Object
• type NetworkList
  • func (x *NetworkList) DeepCopy() *NetworkList
  • func (in *NetworkList) DeepCopyInto(out *NetworkList)
  • func (x *NetworkList) DeepCopyObject() runtime.Object
• type NetworkSpec
• type NetworkStatus
• type Tenant
  • func (x *Tenant) DeepCopy() *Tenant
  • func (in *Tenant) DeepCopyInto(out *Tenant)
  • func (x *Tenant) DeepCopyObject() runtime.Object
• type TenantList
  • func (x *TenantList) DeepCopy() *TenantList
  • func (in *TenantList) DeepCopyInto(out *TenantList)
  • func (x *TenantList) DeepCopyObject() runtime.Object
• type TenantSpec
• type TenantStatus

Constants

const (
	// NetworkResourcePlural is the plural of network resource.
	NetworkResourcePlural = "networks"
	// TenantResourcePlural is the plural of tenant resource.
	TenantResourcePlural = "tenants"
)

const (
	// NetworkInitializing means the network is just accepted by system
	NetworkInitializing = "Initializing"
	// NetworkActive means the network is available for use in the system
	NetworkActive = "Active"
	// NetworkPending means the network is accepted by system, but it is still
	// processing by network provider
	NetworkPending = "Pending"
	// NetworkFailed means the network is not available
	NetworkFailed = "Failed"
	// NetworkTerminating means the network is undergoing graceful termination
	NetworkTerminating = "Terminating"
)

These are the valid phases of a network state.

const (
	// TenantInitializing means the tenant is just accepted by system
	TenantInitializing = "Initializing"
	// TenantActive means the tenant is available for use in the system
	TenantActive = "Active"
	// TenantPending means the tenant is accepted by system, but it is still
	// processing by tenant provider
	TenantPending = "Pending"
	// TenantFailed means the tenant is not available
	TenantFailed = "Failed"
	// TenantTerminating means the tenant is undergoing graceful termination
	TenantTerminating = "Terminating"
)

These are the valid phases of a tenant state.

const GroupName = "stackube.kubernetes.io"

GroupName is the group name use in this package

Variables

var (
	// SchemeBuilder collects functions that add things to a scheme.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme applies all the stored functions to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func GetGeneratedDeepCopyFuncs

func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc

Deprecated: GetGeneratedDeepCopyFuncs returns the generated funcs, since we aren't registering them.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Network

type Network struct {
	// TypeMeta defines type of the object and its API schema version.
	metav1.TypeMeta `json:",inline"`
	// ObjectMeta is metadata that all persisted resources must have.
	metav1.ObjectMeta `json:"metadata"`

	// Spec describes the behavior of a network.
	Spec NetworkSpec `json:"spec"`
	// Status describes the network status.
	Status NetworkStatus `json:"status,omitempty"`
}

Network describes a Neutron network. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Network) DeepCopy

func (x *Network) DeepCopy() *Network

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, creating a new Network.

func (*Network) DeepCopyInto

func (in *Network) DeepCopyInto(out *Network)

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

func (*Network) DeepCopyObject

func (x *Network) DeepCopyObject() runtime.Object

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

type NetworkList

type NetworkList struct {
	// TypeMeta defines type of the object and its API schema version.
	metav1.TypeMeta `json:",inline"`
	// ObjectMeta is metadata that all persisted resources must have.
	metav1.ListMeta `json:"metadata"`
	// Items contains a list of networks.
	Items []Network `json:"items"`
}

NetworkList is a list of networks. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*NetworkList) DeepCopy

func (x *NetworkList) DeepCopy() *NetworkList

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, creating a new NetworkList.

func (*NetworkList) DeepCopyInto

func (in *NetworkList) DeepCopyInto(out *NetworkList)

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

func (*NetworkList) DeepCopyObject

func (x *NetworkList) DeepCopyObject() runtime.Object

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

type NetworkSpec

type NetworkSpec struct {
	// The CIDR of the network.
	CIDR string `json:"cidr"`
	// The gateway IP.
	Gateway string `json:"gateway"`
	// The network ID in Neutron.
	// If provided, wouldn't create a network in Neutron.
	NetworkID string `json:"networkID"`
}

NetworkSpec is the spec of a network.

type NetworkStatus

type NetworkStatus struct {
	// State describes the network state.
	State string `json:"state,omitempty"`
	// Message describes why network is in current state.
	Message string `json:"message,omitempty"`
}

NetworkStatus is the status of a network.

type Tenant

type Tenant struct {
	// TypeMeta defines type of the object and its API schema version.
	metav1.TypeMeta `json:",inline"`
	// ObjectMeta is metadata that all persisted resources must have.
	metav1.ObjectMeta `json:"metadata"`

	// Spec defines the behavior of a tenant.
	Spec TenantSpec `json:"spec"`
	// Status describes the tenant status.
	Status TenantStatus `json:"status,omitempty"`
}

Tenant describes a Keystone tenant. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Tenant) DeepCopy

func (x *Tenant) DeepCopy() *Tenant

DeepCopyInto 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 (x *Tenant) DeepCopyObject() runtime.Object

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

type TenantList

type TenantList struct {
	// TypeMeta defines type of the object and its API schema version.
	metav1.TypeMeta `json:",inline"`
	// ObjectMeta is metadata that all persisted resources must have.
	metav1.ListMeta `json:"metadata"`
	// Items contains a list of tenants.
	Items []Tenant `json:"items"`
}

TenantList is a list of tenants. +k8s:deepcopy-gen=true +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*TenantList) DeepCopy

func (x *TenantList) DeepCopy() *TenantList

DeepCopyInto 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 (x *TenantList) DeepCopyObject() runtime.Object

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

type TenantSpec

type TenantSpec struct {
	// The username of this user.
	UserName string `json:"username"`
	// The password of this user.
	Password string `json:"password"`
	// The tenant ID in Keystone.
	// If provided, wouldn't create a new tenant in Keystone.
	TenantID string `json:"tenantID"`
}

TenantSpec is the spec of a tenant.

type TenantStatus

type TenantStatus struct {
	// State describes the tenant state.
	State string `json:"state,omitempty"`
	// Message describes why tenant is in current state.
	Message string `json:"message,omitempty"`
}

TenantStatus is the status of a tenant.