v1alpha1

Documentation

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type CRDStatus
• type CSINodeTopology
  • func (in *CSINodeTopology) DeepCopy() *CSINodeTopology
  • func (in *CSINodeTopology) DeepCopyInto(out *CSINodeTopology)
  • func (in *CSINodeTopology) DeepCopyObject() runtime.Object
• type CSINodeTopologyList
  • func (in *CSINodeTopologyList) DeepCopy() *CSINodeTopologyList
  • func (in *CSINodeTopologyList) DeepCopyInto(out *CSINodeTopologyList)
  • func (in *CSINodeTopologyList) DeepCopyObject() runtime.Object
• type CSINodeTopologySpec
  • func (in *CSINodeTopologySpec) DeepCopy() *CSINodeTopologySpec
  • func (in *CSINodeTopologySpec) DeepCopyInto(out *CSINodeTopologySpec)
• type CSINodeTopologyStatus
  • func (in *CSINodeTopologyStatus) DeepCopy() *CSINodeTopologyStatus
  • func (in *CSINodeTopologyStatus) DeepCopyInto(out *CSINodeTopologyStatus)
• type TopologyLabel
  • func (in *TopologyLabel) DeepCopy() *TopologyLabel
  • func (in *TopologyLabel) DeepCopyInto(out *TopologyLabel)

Constants

const GroupName = "cns.vmware.com"

GroupName represents the group for CSINodeTopology API.

const Version = "v1alpha1"

Version represents the version for CSINodeTopology API.

Variables

var (
	// SchemeGroupVersion define schema Group and version.
	SchemeGroupVersion = schema.GroupVersion{
		Group:   GroupName,
		Version: Version,
	}

	// AddToScheme helps add all the stored functions to the scheme.
	AddToScheme = localSchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource.

Types

type CRDStatus

type CRDStatus string

const (
	// CSINodeTopologySuccess is used to imply that node topology retrieval is successful.
	CSINodeTopologySuccess CRDStatus = "Success"
	// CSINodeTopologyError is used to imply that node topology retrieval resulted in an error.
	CSINodeTopologyError CRDStatus = "Error"
)

type CSINodeTopology

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

	Spec   CSINodeTopologySpec   `json:"spec"`
	Status CSINodeTopologyStatus `json:"status,omitempty"`
}

CSINodeTopology is the Schema for the csinodetopologies API.

func (*CSINodeTopology) DeepCopy

func (in *CSINodeTopology) DeepCopy() *CSINodeTopology

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

func (*CSINodeTopology) DeepCopyInto

func (in *CSINodeTopology) DeepCopyInto(out *CSINodeTopology)

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

func (*CSINodeTopology) DeepCopyObject

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

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

type CSINodeTopologyList

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

CSINodeTopologyList contains a list of CSINodeTopology.

func (*CSINodeTopologyList) DeepCopy

func (in *CSINodeTopologyList) DeepCopy() *CSINodeTopologyList

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

func (*CSINodeTopologyList) DeepCopyInto

func (in *CSINodeTopologyList) DeepCopyInto(out *CSINodeTopologyList)

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

func (*CSINodeTopologyList) DeepCopyObject

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

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

type CSINodeTopologySpec

type CSINodeTopologySpec struct {

	// NodeID refers to the node name by which a Node is recognised.
	NodeID string `json:"nodeID"`

	// NodeUUID refers to the unique VM UUID by which a Node is recognised.
	NodeUUID string `json:"nodeuuid,omitempty"`
}

CSINodeTopologySpec defines the desired state of CSINodeTopology.

func (*CSINodeTopologySpec) DeepCopy

func (in *CSINodeTopologySpec) DeepCopy() *CSINodeTopologySpec

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

func (*CSINodeTopologySpec) DeepCopyInto

func (in *CSINodeTopologySpec) DeepCopyInto(out *CSINodeTopologySpec)

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

type CSINodeTopologyStatus

type CSINodeTopologyStatus struct {
	// Status can have the following values: "Success", "Error".
	Status CRDStatus `json:"status,omitempty"`

	// TopologyLabels consists of all the topology-related labels
	// applied to the NodeVM or its ancestors in the VC.
	// Read this parameter only after `Status` is set to "Success".
	// TopologyLabels will be empty when `Status` is set to "Error".
	//+optional
	TopologyLabels []TopologyLabel `json:"topologyLabels,omitempty"`

	// ErrorMessage will contain the error string when `Status` field is set to "Error".
	// It will be empty when the `Status` field is set to "Success".
	ErrorMessage string `json:"errorMessage,omitempty"`
}

CSINodeTopologyStatus defines the observed state of CSINodeTopology.

func (*CSINodeTopologyStatus) DeepCopy

func (in *CSINodeTopologyStatus) DeepCopy() *CSINodeTopologyStatus

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

func (*CSINodeTopologyStatus) DeepCopyInto

func (in *CSINodeTopologyStatus) DeepCopyInto(out *CSINodeTopologyStatus)

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

type TopologyLabel

type TopologyLabel struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

TopologyLabel will consist of a key-value pair. The entries in `key` field must be a part of the `Labels` struct in the vSphere config secret. For example: User might choose to assign a tag of `us-east` under the `k8s-zone` to a NodeVM on the VC. In such cases this struct will hold `k8s-zone` as the key and `us-east` as a value for that NodeVM.

func (*TopologyLabel) DeepCopy

func (in *TopologyLabel) DeepCopy() *TopologyLabel

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

func (*TopologyLabel) DeepCopyInto

func (in *TopologyLabel) DeepCopyInto(out *TopologyLabel)

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