Documentation

Overview

    Package v1alpha1 contains API Schema definitions for the libvirtproviderconfig v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api-provider-libvirt/pkg/apis/libvirtproviderconfig +k8s:defaulter-gen=TypeMeta +groupName=libvirtproviderconfig.k8s.io

    Package v1alpha1 contains API Schema definitions for the libvirtproviderconfig v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api-provider-libvirt/pkg/apis/libvirtproviderconfig +k8s:defaulter-gen=TypeMeta +groupName=libvirtproviderconfig.k8s.io

    Index

    Constants

    View Source
    const (
    	// ClusterIDLabel is the label that a machineset must have to identify the
    	// cluster to which it belongs.
    	ClusterIDLabel   = "sigs.k8s.io/cluster-api-cluster"
    	MachineRoleLabel = "sigs.k8s.io/cluster-api-machine-role"
    	MachineTypeLabel = "sigs.k8s.io/cluster-api-machine-type"
    )

      Annotation constants

      Variables

      View Source
      var (
      	// SchemeGroupVersion is group version used to register these objects
      	SchemeGroupVersion = schema.GroupVersion{Group: "libvirtproviderconfig.k8s.io", Version: "v1alpha1"}
      
      	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
      	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
      )

      Functions

      func NewScheme

      func NewScheme() (*runtime.Scheme, error)

        NewScheme creates a new Scheme

        Types

        type CloudInit

        type CloudInit struct {
        	// Bash script to be run during bootstrapping
        	UserDataSecret string `json:"userDataSecret"`
        	// Allow to ssh into instance
        	SSHAccess bool `json:"sshAccess"`
        }

          CloudInit contains location of user data to be run during bootstrapping

          func (*CloudInit) DeepCopy

          func (in *CloudInit) DeepCopy() *CloudInit

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

            func (*CloudInit) DeepCopyInto

            func (in *CloudInit) DeepCopyInto(out *CloudInit)

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

              type Ignition

              type Ignition struct {
              	// Ignition config to be run during bootstrapping
              	UserDataSecret string `json:"userDataSecret"`
              }

                Ignition contains location of ignition to be run during bootstrapping

                type LibvirtClusterProviderConfig

                type LibvirtClusterProviderConfig struct {
                	metav1.TypeMeta `json:",inline"`
                }

                  LibvirtClusterProviderConfig is the type that will be embedded in a Cluster.Spec.ProviderSpec field. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                  func (*LibvirtClusterProviderConfig) DeepCopy

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

                    func (*LibvirtClusterProviderConfig) DeepCopyInto

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

                      func (*LibvirtClusterProviderConfig) DeepCopyObject

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

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

                        type LibvirtClusterProviderStatus

                        type LibvirtClusterProviderStatus struct {
                        	metav1.TypeMeta `json:",inline"`
                        }

                          LibvirtClusterProviderStatus is the type that will be embedded in a Cluster.Status.ProviderStatus field. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                          func (*LibvirtClusterProviderStatus) DeepCopy

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

                            func (*LibvirtClusterProviderStatus) DeepCopyInto

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

                              func (*LibvirtClusterProviderStatus) DeepCopyObject

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

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

                                type LibvirtMachineProviderCondition

                                type LibvirtMachineProviderCondition struct {
                                	// Type is the type of the condition.
                                	Type LibvirtMachineProviderConditionType `json:"type"`
                                	// Status is the status of the condition.
                                	Status corev1.ConditionStatus `json:"status"`
                                	// LastProbeTime is the last time we probed the condition.
                                	// +optional
                                	LastProbeTime metav1.Time `json:"lastProbeTime"`
                                	// LastTransitionTime is the last time the condition transitioned from one status to another.
                                	// +optional
                                	LastTransitionTime metav1.Time `json:"lastTransitionTime"`
                                	// Reason is a unique, one-word, CamelCase reason for the condition's last transition.
                                	// +optional
                                	Reason string `json:"reason"`
                                	// Message is a human-readable message indicating details about last transition.
                                	// +optional
                                	Message string `json:"message"`
                                }

                                  LibvirtMachineProviderCondition is a condition in a LibvirtMachineProviderStatus

                                  func (*LibvirtMachineProviderCondition) DeepCopy

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

                                    func (*LibvirtMachineProviderCondition) DeepCopyInto

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

                                      type LibvirtMachineProviderConditionType

                                      type LibvirtMachineProviderConditionType string

                                        LibvirtMachineProviderConditionType is a valid value for LibvirtMachineProviderCondition.Type

                                        const (
                                        	// MachineCreated indicates whether the machine has been created or not. If not,
                                        	// it should include a reason and message for the failure.
                                        	MachineCreated LibvirtMachineProviderConditionType = "MachineCreated"
                                        )

                                          Valid conditions for an Libvirt machine instance

                                          type LibvirtMachineProviderConfig

                                          type LibvirtMachineProviderConfig struct {
                                          	metav1.TypeMeta `json:",inline"`
                                          
                                          	DomainMemory             int        `json:"domainMemory"`
                                          	DomainVcpu               int        `json:"domainVcpu"`
                                          	IgnKey                   string     `json:"ignKey"`
                                          	Ignition                 *Ignition  `json:"ignition"`
                                          	CloudInit                *CloudInit `json:"cloudInit"`
                                          	Volume                   *Volume    `json:"volume"`
                                          	NetworkInterfaceName     string     `json:"networkInterfaceName"`
                                          	NetworkInterfaceHostname string     `json:"networkInterfaceHostname"`
                                          	NetworkInterfaceAddress  string     `json:"networkInterfaceAddress"`
                                          	NetworkUUID              string     `json:"networkUUID"`
                                          	Autostart                bool       `json:"autostart"`
                                          	URI                      string     `json:"uri"`
                                          }

                                            LibvirtMachineProviderConfig is the type that will be embedded in a Machine.Spec.ProviderSpec field for an Libvirt instance. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                                            func (*LibvirtMachineProviderConfig) DeepCopy

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

                                              func (*LibvirtMachineProviderConfig) DeepCopyInto

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

                                                func (*LibvirtMachineProviderConfig) DeepCopyObject

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

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

                                                  type LibvirtMachineProviderConfigList

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

                                                    LibvirtMachineProviderConfigList contains a list of LibvirtMachineProviderConfig

                                                    func (*LibvirtMachineProviderConfigList) DeepCopy

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

                                                      func (*LibvirtMachineProviderConfigList) DeepCopyInto

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

                                                        func (*LibvirtMachineProviderConfigList) DeepCopyObject

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

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

                                                          type LibvirtMachineProviderStatus

                                                          type LibvirtMachineProviderStatus struct {
                                                          	metav1.TypeMeta `json:",inline"`
                                                          
                                                          	// InstanceID is the instance ID of the machine created in Libvirt
                                                          	InstanceID *string `json:"instanceID"`
                                                          
                                                          	// InstanceState is the state of the Libvirt instance for this machine
                                                          	InstanceState *string `json:"instanceState"`
                                                          
                                                          	// Conditions is a set of conditions associated with the Machine to indicate
                                                          	// errors or other status
                                                          	Conditions []LibvirtMachineProviderCondition `json:"conditions"`
                                                          }

                                                            LibvirtMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains Libvirt-specific status information. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                                                            func (*LibvirtMachineProviderStatus) DeepCopy

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

                                                              func (*LibvirtMachineProviderStatus) DeepCopyInto

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

                                                                func (*LibvirtMachineProviderStatus) DeepCopyObject

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

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

                                                                  type LibvirtProviderConfigCodec

                                                                  type LibvirtProviderConfigCodec struct {
                                                                  	// contains filtered or unexported fields
                                                                  }

                                                                    LibvirtProviderConfigCodec contains encoder/decoder to convert this types from/to serialize data +k8s:deepcopy-gen=false

                                                                    func NewCodec

                                                                    func NewCodec() (*LibvirtProviderConfigCodec, error)

                                                                      NewCodec returns a encode/decoder for this API

                                                                      func (*LibvirtProviderConfigCodec) DecodeFromProviderSpec

                                                                      func (codec *LibvirtProviderConfigCodec) DecodeFromProviderSpec(providerConfig clusterv1alpha1.ProviderSpec, out runtime.Object) error

                                                                        DecodeFromProviderSpec decodes a serialised ProviderConfig into an object

                                                                        func (*LibvirtProviderConfigCodec) DecodeProviderStatus

                                                                        func (codec *LibvirtProviderConfigCodec) DecodeProviderStatus(providerStatus *runtime.RawExtension, out runtime.Object) error

                                                                          DecodeProviderStatus decodes a serialised providerStatus into an object

                                                                          func (*LibvirtProviderConfigCodec) EncodeProviderStatus

                                                                          func (codec *LibvirtProviderConfigCodec) EncodeProviderStatus(in runtime.Object) (*runtime.RawExtension, error)

                                                                            EncodeProviderStatus encodes an object into serialised data

                                                                            func (*LibvirtProviderConfigCodec) EncodeToProviderSpec

                                                                            func (codec *LibvirtProviderConfigCodec) EncodeToProviderSpec(in runtime.Object) (*clusterv1alpha1.ProviderSpec, error)

                                                                              EncodeToProviderSpec encodes an object into a serialised ProviderConfig

                                                                              type Volume

                                                                              type Volume struct {
                                                                              	PoolName     string `json:"poolName"`
                                                                              	BaseVolumeID string `json:"baseVolumeID"`
                                                                              	VolumeName   string `json:"volumeName"`
                                                                              }

                                                                                Volume contains the info for the actuator to create a volume

                                                                                func (*Volume) DeepCopy

                                                                                func (in *Volume) DeepCopy() *Volume

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

                                                                                  func (*Volume) DeepCopyInto

                                                                                  func (in *Volume) DeepCopyInto(out *Volume)

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