v1

Documentation

Overview

Package v1 contains API Schema definitions for the driver v1 API group +kubebuilder:object:generate=true +groupName=target.yndd.io

Index

• Constants
• Variables
• type Allocation
  • func (in *Allocation) DeepCopy() *Allocation
  • func (in *Allocation) DeepCopyInto(out *Allocation)
• type DiscoveryInfo
  • func (in *DiscoveryInfo) DeepCopy() *DiscoveryInfo
  • func (in *DiscoveryInfo) DeepCopyInto(out *DiscoveryInfo)
• type Encoding
• type Protocol
• type Target
  • func (in *Target) DeepCopy() *Target
  • func (in *Target) DeepCopyInto(out *Target)
  • func (in *Target) DeepCopyObject() runtime.Object
• type TargetConfig
  • func (in *TargetConfig) DeepCopy() *TargetConfig
  • func (in *TargetConfig) DeepCopyInto(out *TargetConfig)
• type TargetList
  • func (in *TargetList) DeepCopy() *TargetList
  • func (in *TargetList) DeepCopyInto(out *TargetList)
  • func (in *TargetList) DeepCopyObject() runtime.Object
• type TargetProperties
  • func (in *TargetProperties) DeepCopy() *TargetProperties
  • func (in *TargetProperties) DeepCopyInto(out *TargetProperties)
• type TargetSpec
  • func (in *TargetSpec) DeepCopy() *TargetSpec
  • func (in *TargetSpec) DeepCopyInto(out *TargetSpec)
• type TargetStatus
  • func (in *TargetStatus) DeepCopy() *TargetStatus
  • func (in *TargetStatus) DeepCopyInto(out *TargetStatus)
• type VendorType

Constants

const (
	Group   = "target.yndd.io"
	Version = "v1"
)

Package type metadata.

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: Group, Version: Version}

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var (
	TargetKind             = reflect.TypeOf(Target{}).Name()
	TargetGroupKind        = schema.GroupKind{Group: Group, Kind: TargetKind}.String()
	TargetKindAPIVersion   = TargetKind + "." + GroupVersion.String()
	TargetGroupVersionKind = GroupVersion.WithKind(TargetKind)
)

Target type metadata.

Types

type Allocation

type Allocation struct {
	ServiceIdentity string `json:"serviceIdentity,omitempty"`
	ServiceName     string `json:"serviceName,omitempty"`
}

func (*Allocation) DeepCopy

func (in *Allocation) DeepCopy() *Allocation

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

func (*Allocation) DeepCopyInto

func (in *Allocation) DeepCopyInto(out *Allocation)

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

type DiscoveryInfo

type DiscoveryInfo struct {
	// the VendorType of the target
	VendorType VendorType `json:"vendorType,omitempty"`

	// Host name of the target
	HostName string `json:"hostname,omitempty"`

	// the Kind of the target
	Platform string `json:"platform,omitempty"`

	// SW version of the target
	SwVersion string `json:"swVersion,omitempty"`

	// the Mac address of the target
	MacAddress string `json:"macAddress,omitempty"`

	// the Serial Number of the target
	SerialNumber string `json:"serialNumber,omitempty"`

	// Supported Encodings of the target
	SupportedEncodings []string `json:"supportedEncodings,omitempty"`

	// Last discovery time
	LastSeen metav1.Time `json:"lastSeen,omitempty"`
}

DiscoveryInfo collects information about the target

func (*DiscoveryInfo) DeepCopy

func (in *DiscoveryInfo) DeepCopy() *DiscoveryInfo

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

func (*DiscoveryInfo) DeepCopyInto

func (in *DiscoveryInfo) DeepCopyInto(out *DiscoveryInfo)

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

type Encoding

type Encoding string

const (
	Encoding_Unknown   Encoding = "unknown"
	Encoding_JSON      Encoding = "JSON"
	Encoding_JSON_IETF Encoding = "JSON_IETF"
	Encoding_Bytes     Encoding = "bytes"
	Encoding_Protobuf  Encoding = "protobuf"
	Encoding_Ascii     Encoding = "ASCII"
)

const (
	Protocol_Unknown Encoding = "unknown"
	Protocol_GNMI    Encoding = "gnmi"
	Protocol_NETCONF Encoding = "netconf"
)

type Protocol

type Protocol string

type Target

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

	Spec   TargetSpec   `json:"spec,omitempty"`
	Status TargetStatus `json:"status,omitempty"`
}

Target is the Schema for the targets API +kubebuilder:subresource:status +kubebuilder:printcolumn:name="SYNC",type="string",JSONPath=".status.conditions[?(@.kind=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.kind=='Ready')].status" +kubebuilder:printcolumn:name="ADDRESS",type="string",JSONPath=".spec.properties.config.address",description="address to connect to the target'" +kubebuilder:printcolumn:name="HOSTNAME",type="string",JSONPath=".spec.discoveryInfo.hostname",description="target hostname'" +kubebuilder:printcolumn:name="PROTOCOL",type="string",JSONPath=".spec.properties.config.protocol",description="Protocol used to communicate to the target" +kubebuilder:printcolumn:name="VENDORTYPE",type="string",JSONPath=".spec.discoveryInfo.vendorType",description="VendorType of target" +kubebuilder:printcolumn:name="PLATFORM",type="string",JSONPath=".spec.discoveryInfo.platform",description="Platform of target" +kubebuilder:printcolumn:name="SWVERSION",type="string",JSONPath=".spec.discoveryInfo.swVersion",description="SW version of the target" +kubebuilder:printcolumn:name="MACADDRESS",type="string",JSONPath=".spec.discoveryInfo.macAddress",description="macAddress of the target" +kubebuilder:printcolumn:name="SERIALNBR",type="string",JSONPath=".spec.discoveryInfo.serialNumber",description="serialNumber of the target" +kubebuilder:printcolumn:name="LASTSEEN",type="date",JSONPath=".spec.discoveryInfo.lastSeen",description="last time the target was updated" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:categories={yndd,topo}

func (*Target) DeepCopy

func (in *Target) DeepCopy() *Target

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

func (*Target) DeepCopyInto

func (in *Target) DeepCopyInto(out *Target)

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

func (*Target) DeepCopyObject

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

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

type TargetConfig

type TargetConfig struct {
	Address        string `json:"address,omitempty"`
	CredentialName string `json:"credentialName,omitempty"`
	//+kubebuilder:validation:Enum=unknown;JSON;JSON_IETF;bytes;protobuf;ASCII;
	Encoding Encoding `json:"encoding,omitempty"`
	Insecure bool     `json:"insecure,omitempty"`
	//+kubebuilder:validation:Enum=unknown;gnmi;netconf;
	Protocol          Protocol `json:"protocol,omitempty"`
	Proxy             string   `json:"proxy,omitempty"`
	SkipVerify        bool     `json:"skipVerify,omitempty"`
	TlsCredentialName string   `json:"tlsCredentialName,omitempty"`
}

func (*TargetConfig) DeepCopy

func (in *TargetConfig) DeepCopy() *TargetConfig

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

func (*TargetConfig) DeepCopyInto

func (in *TargetConfig) DeepCopyInto(out *TargetConfig)

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

type TargetList

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

TargetList contains a list of targets

func (*TargetList) DeepCopy

func (in *TargetList) DeepCopy() *TargetList

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

func (*TargetList) DeepCopyInto

func (in *TargetList) DeepCopyInto(out *TargetList)

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

func (*TargetList) DeepCopyObject

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

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

type TargetProperties

type TargetProperties struct {
	//+kubebuilder:validation:Enum=unknown;nokiaSRL;nokiaSROS;
	VendorType VendorType             `json:"vendorType,omitempty"`
	Config     *TargetConfig          `json:"config,omitempty"`
	Allocation map[string]*Allocation `json:"allocation,omitempty"`
}

TargetProperties define the properties of the Target

func (*TargetProperties) DeepCopy

func (in *TargetProperties) DeepCopy() *TargetProperties

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

func (*TargetProperties) DeepCopyInto

func (in *TargetProperties) DeepCopyInto(out *TargetProperties)

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

type TargetSpec

type TargetSpec struct {
	// Properties define the properties of the Target
	Properties *TargetProperties `json:"properties,omitempty"`
	// DiscoveryInfo
	DiscoveryInfo *DiscoveryInfo `json:"discoveryInfo,omitempty"`
}

TargetSpec struct

func (*TargetSpec) DeepCopy

func (in *TargetSpec) DeepCopy() *TargetSpec

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

func (*TargetSpec) DeepCopyInto

func (in *TargetSpec) DeepCopyInto(out *TargetSpec)

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

type TargetStatus

type TargetStatus struct {
}

TargetStatus defines the observed state of TargetNode

func (*TargetStatus) DeepCopy

func (in *TargetStatus) DeepCopy() *TargetStatus

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

func (*TargetStatus) DeepCopyInto

func (in *TargetStatus) DeepCopyInto(out *TargetStatus)

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

type VendorType

type VendorType string

const (
	VendorTypeUnknown   VendorType = "unknown"
	VendorTypeNokiaSRL  VendorType = "nokiaSRL"
	VendorTypeNokiaSROS VendorType = "nokiaSROS"
)

VendorType enum.