v1

Documentation

Overview

Package v1 contains API Schema definitions for the plumber v1 API group +kubebuilder:object:generate=true +groupName=plumber.k8s.pf9.io

Index

• Variables
• type BGPConfig
  • func (in *BGPConfig) DeepCopy() *BGPConfig
  • func (in *BGPConfig) DeepCopyInto(out *BGPConfig)
• type BGPPeer
  • func (in *BGPPeer) DeepCopy() *BGPPeer
  • func (in *BGPPeer) DeepCopyInto(out *BGPPeer)
• type NetworkWizard
  • func (in *NetworkWizard) DeepCopy() *NetworkWizard
  • func (in *NetworkWizard) DeepCopyInto(out *NetworkWizard)
  • func (in *NetworkWizard) DeepCopyObject() runtime.Object
  • func (n NetworkWizard) ParseCIDR() (net.IP, *net.IPNet, error)
• type NetworkWizardList
  • func (in *NetworkWizardList) DeepCopy() *NetworkWizardList
  • func (in *NetworkWizardList) DeepCopyInto(out *NetworkWizardList)
  • func (in *NetworkWizardList) DeepCopyObject() runtime.Object
• type NetworkWizardSpec
  • func (in *NetworkWizardSpec) DeepCopy() *NetworkWizardSpec
  • func (in *NetworkWizardSpec) DeepCopyInto(out *NetworkWizardSpec)
• type NetworkWizardStatus
  • func (in *NetworkWizardStatus) DeepCopy() *NetworkWizardStatus
  • func (in *NetworkWizardStatus) DeepCopyInto(out *NetworkWizardStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "plumber.k8s.pf9.io", Version: "v1"}

	// 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
)

Types

type BGPConfig

type BGPConfig struct {
	// Physical routers to peer with
	RemotePeers []BGPPeer `json:"peers,omitempty"`

	// ASN of peer router
	RemoteASN *uint32 `json:"remoteASN,omitempty"`

	// ASN to use for the cluster's BGP advertisements
	MyASN *uint32 `json:"myASN,omitempty"`
}

func (*BGPConfig) DeepCopy

func (in *BGPConfig) DeepCopy() *BGPConfig

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

func (*BGPConfig) DeepCopyInto

func (in *BGPConfig) DeepCopyInto(out *BGPConfig)

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

type BGPPeer

type BGPPeer struct {
	PeerIP *string `json:"peerIP"`

	// Adds a static route that may be needed to connect to a peer.
	ReachableBy *string `json:"reachableBy,omitempty"`
}

func (*BGPPeer) DeepCopy

func (in *BGPPeer) DeepCopy() *BGPPeer

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

func (*BGPPeer) DeepCopyInto

func (in *BGPPeer) DeepCopyInto(out *BGPPeer)

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

type NetworkWizard

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

	Spec   NetworkWizardSpec   `json:"spec,omitempty"`
	Status NetworkWizardStatus `json:"status,omitempty"`
}

NetworkWizard is the Schema for the networkwizards API

func (*NetworkWizard) DeepCopy

func (in *NetworkWizard) DeepCopy() *NetworkWizard

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

func (*NetworkWizard) DeepCopyInto

func (in *NetworkWizard) DeepCopyInto(out *NetworkWizard)

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

func (*NetworkWizard) DeepCopyObject

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

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

func (NetworkWizard) ParseCIDR

func (n NetworkWizard) ParseCIDR() (net.IP, *net.IPNet, error)

type NetworkWizardList

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

NetworkWizardList contains a list of NetworkWizard

func (*NetworkWizardList) DeepCopy

func (in *NetworkWizardList) DeepCopy() *NetworkWizardList

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

func (*NetworkWizardList) DeepCopyInto

func (in *NetworkWizardList) DeepCopyInto(out *NetworkWizardList)

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

func (*NetworkWizardList) DeepCopyObject

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

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

type NetworkWizardSpec

type NetworkWizardSpec struct {
	// Plugin specifies the type of network/CNI to create in the backend
	// Valid values for now: "calico" and "public", more as we add Multus networks
	Plugin string `json:"plugin,omitempty"`

	// CIDR notation for the network plugin to provision
	CIDR       *string `json:"cidr,omitempty"`
	RangeStart net.IP  `json:"range_start,omitempty"`
	RangeEnd   net.IP  `json:"range_end,omitempty"`

	// BGPConfiguration - valid only for "public" type networks
	BGPConfig *BGPConfig `json:"bgpConfig,omitempty"`
}

NetworkWizardSpec defines the desired state of NetworkWizard

func (*NetworkWizardSpec) DeepCopy

func (in *NetworkWizardSpec) DeepCopy() *NetworkWizardSpec

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

func (*NetworkWizardSpec) DeepCopyInto

func (in *NetworkWizardSpec) DeepCopyInto(out *NetworkWizardSpec)

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

type NetworkWizardStatus

type NetworkWizardStatus struct {
	// Bool indicating if the network was created by CNI plugin
	Created bool `json:"created,omitempty"`

	// Error message indicating CNI errors
	Reason string `json:"reason,omitempty"`

	// Stores Fixed IP Allocations for a given VM: <fixed IP> :< VM Name>
	IPAllocations map[string]string `json:"allocations,omitempty"`
}

NetworkWizardStatus defines the observed state of NetworkWizard

func (*NetworkWizardStatus) DeepCopy

func (in *NetworkWizardStatus) DeepCopy() *NetworkWizardStatus

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

func (*NetworkWizardStatus) DeepCopyInto

func (in *NetworkWizardStatus) DeepCopyInto(out *NetworkWizardStatus)

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