v1alpha1

Documentation

Overview

v1alpha1 is the v1alpha1 version of the API.

+kubebuilder:object:generate=true +groupName=topo.app.kuid.dev

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Topology
  • func BuildTopology(meta metav1.ObjectMeta, spec *TopologySpec, status *TopologyStatus) *Topology
  • func (in *Topology) DeepCopy() *Topology
  • func (in *Topology) DeepCopyInto(out *Topology)
  • func (in *Topology) DeepCopyObject() runtime.Object
  • func (r *Topology) GetCondition(t conditionv1alpha1.ConditionType) conditionv1alpha1.Condition
  • func (r *Topology) GetGENIDIndex() *genidbev1alpha1.GENIDIndex
  • func (r *Topology) GetRegion() string
  • func (r *Topology) GetSite() string
  • func (r *Topology) GetSiteID() *infrabev1alpha1.SiteID
  • func (r *Topology) SetConditions(c ...conditionv1alpha1.Condition)
  • func (r *Topology) Validate() error
• type TopologyList
  • func (in *TopologyList) DeepCopy() *TopologyList
  • func (in *TopologyList) DeepCopyInto(out *TopologyList)
  • func (in *TopologyList) DeepCopyObject() runtime.Object
• type TopologySpec
  • func (in *TopologySpec) DeepCopy() *TopologySpec
  • func (in *TopologySpec) DeepCopyInto(out *TopologySpec)
• type TopologyStatus
  • func (in *TopologyStatus) DeepCopy() *TopologyStatus
  • func (in *TopologyStatus) DeepCopyInto(out *TopologyStatus)

Variables

var (
	// SchemeGroupVersion contains the API group and version information for the types in this package.
	SchemeGroupVersion = schema.GroupVersion{Group: "topo.app.kuid.dev", Version: "v1alpha1"}
	// AddToScheme applies all the stored functions to the scheme. A non-nil error
	// indicates that one function failed and the attempt was abandoned.
	//AddToScheme = (&runtime.SchemeBuilder{}).AddToScheme
	AddToScheme = localSchemeBuilder.AddToScheme
)

var (
	TopologyKind = reflect.TypeOf(Topology{}).Name()
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Topology

type Topology struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec   TopologySpec   `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	Status TopologyStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

+kubebuilder:object:root=true +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:subresource:status +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:resource:categories={kuid, topo} Topology is the Topology for the Topology API +k8s:openapi-gen=true

func BuildTopology

func BuildTopology(meta metav1.ObjectMeta, spec *TopologySpec, status *TopologyStatus) *Topology

BuildTopology returns an Topology from a client Object a Spec/Status

func (*Topology) DeepCopy

func (in *Topology) DeepCopy() *Topology

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

func (*Topology) DeepCopyInto

func (in *Topology) DeepCopyInto(out *Topology)

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

func (*Topology) DeepCopyObject

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

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

func (*Topology) GetCondition

func (r *Topology) GetCondition(t conditionv1alpha1.ConditionType) conditionv1alpha1.Condition

GetCondition returns the condition based on the condition kind

func (*Topology) GetGENIDIndex

func (r *Topology) GetGENIDIndex() *genidbev1alpha1.GENIDIndex

func (*Topology) GetRegion

func (r *Topology) GetRegion() string

func (*Topology) GetSite

func (r *Topology) GetSite() string

func (*Topology) GetSiteID

func (r *Topology) GetSiteID() *infrabev1alpha1.SiteID

func (*Topology) SetConditions

func (r *Topology) SetConditions(c ...conditionv1alpha1.Condition)

SetConditions sets the conditions on the resource. it allows for 0, 1 or more conditions to be set at once

func (*Topology) Validate

func (r *Topology) Validate() error

type TopologyList

type TopologyList struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" yaml:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Items           []Topology `json:"items" yaml:"items" protobuf:"bytes,2,rep,name=items"`
}

+kubebuilder:object:root=true TopologyClabList contains a list of TopologyClabs +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*TopologyList) DeepCopy

func (in *TopologyList) DeepCopy() *TopologyList

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

func (*TopologyList) DeepCopyInto

func (in *TopologyList) DeepCopyInto(out *TopologyList)

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

func (*TopologyList) DeepCopyObject

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

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

type TopologySpec

type TopologySpec struct {
	// Region identifies the default region this topology is located in
	// +optional
	Region *string `json:"region,omitempty" yaml:"region,omitempty" protobuf:"bytes,1,opt,name=region"`
	// Site identifies the default site this topology is located in
	// +optional
	Site *string `json:"site,omitempty" yaml:"site,omitempty" protobuf:"bytes,1,opt,name=site"`
	// Location identifies the default location this topology is located in
	// +optional
	Location *infravbe1alpha1.Location `json:"location,omitempty" yaml:"location,omitempty"`
	// ContainerLab holds the containerlab topology
	ContainerLab *string `json:"containerLab,omitempty" yaml:"containerLab,omitempty" protobuf:"bytes,1,opt,name=containerLab"`
}

TopologySpec defines the desired state of Topology

func (*TopologySpec) DeepCopy

func (in *TopologySpec) DeepCopy() *TopologySpec

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

func (*TopologySpec) DeepCopyInto

func (in *TopologySpec) DeepCopyInto(out *TopologySpec)

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

type TopologyStatus

type TopologyStatus struct {
	// ConditionedStatus provides the status of the TopologyClab using conditions
	// - a ready condition indicates the overall status of the resource
	conditionv1alpha1.ConditionedStatus `json:",inline" yaml:",inline" protobuf:"bytes,1,opt,name=conditionedStatus"`
}

TopologyStatus defines the observed state of Topology

func (*TopologyStatus) DeepCopy

func (in *TopologyStatus) DeepCopy() *TopologyStatus

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

func (*TopologyStatus) DeepCopyInto

func (in *TopologyStatus) DeepCopyInto(out *TopologyStatus)

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