Documentation

Overview

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

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

    Index

    Constants

    This section is empty.

    Variables

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

    Functions

    func RawExtensionFromProviderSpec

    func RawExtensionFromProviderSpec(spec *GCPMachineProviderSpec) (*runtime.RawExtension, error)

      RawExtensionFromProviderSpec marshals the machine provider spec.

      func RawExtensionFromProviderStatus

      func RawExtensionFromProviderStatus(status *GCPMachineProviderStatus) (*runtime.RawExtension, error)

        RawExtensionFromProviderStatus marshals the provider status

        Types

        type GCPDisk

        type GCPDisk struct {
        	AutoDelete bool              `json:"autoDelete"`
        	Boot       bool              `json:"boot"`
        	SizeGb     int64             `json:"sizeGb"`
        	Type       string            `json:"type"`
        	Image      string            `json:"image"`
        	Labels     map[string]string `json:"labels"`
        }

          GCPDisk describes disks for GCP.

          func (*GCPDisk) DeepCopy

          func (in *GCPDisk) DeepCopy() *GCPDisk

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

            func (*GCPDisk) DeepCopyInto

            func (in *GCPDisk) DeepCopyInto(out *GCPDisk)

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

              type GCPMachineProviderCondition

              type GCPMachineProviderCondition struct {
              	// Type is the type of the condition.
              	Type GCPMachineProviderConditionType `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,omitempty"`
              	// LastTransitionTime is the last time the condition transitioned from one status to another.
              	// +optional
              	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
              	// Reason is a unique, one-word, CamelCase reason for the condition's last transition.
              	// +optional
              	Reason string `json:"reason,omitempty"`
              	// Message is a human-readable message indicating details about last transition.
              	// +optional
              	Message string `json:"message,omitempty"`
              }

                GCPMachineProviderCondition is a condition in a GCPMachineProviderStatus

                func (*GCPMachineProviderCondition) DeepCopy

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

                  func (*GCPMachineProviderCondition) DeepCopyInto

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

                    type GCPMachineProviderConditionType

                    type GCPMachineProviderConditionType string

                      GCPMachineProviderConditionType is a valid value for GCPMachineProviderCondition.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 GCPMachineProviderConditionType = "MachineCreated"
                      )

                        Valid conditions for an GCP machine instance

                        type GCPMachineProviderSpec

                        type GCPMachineProviderSpec struct {
                        	metav1.TypeMeta   `json:",inline"`
                        	metav1.ObjectMeta `json:"metadata,omitempty"`
                        
                        	// UserDataSecret contains a local reference to a secret that contains the
                        	// UserData to apply to the instance
                        	UserDataSecret *corev1.LocalObjectReference `json:"userDataSecret,omitempty"`
                        
                        	// CredentialsSecret is a reference to the secret with GCP credentials.
                        	CredentialsSecret *corev1.LocalObjectReference `json:"credentialsSecret,omitempty"`
                        
                        	CanIPForward       bool                   `json:"canIPForward"`
                        	DeletionProtection bool                   `json:"deletionProtection"`
                        	Disks              []*GCPDisk             `json:"disks,omitempty"`
                        	Labels             map[string]string      `json:"labels,omitempty"`
                        	Metadata           []*GCPMetadata         `json:"gcpMetadata,omitempty"`
                        	NetworkInterfaces  []*GCPNetworkInterface `json:"networkInterfaces,omitempty"`
                        	ServiceAccounts    []GCPServiceAccount    `json:"serviceAccounts"`
                        	Tags               []string               `json:"tags,omitempty"`
                        	TargetPools        []string               `json:"targetPools,omitempty"`
                        	MachineType        string                 `json:"machineType"`
                        	Region             string                 `json:"region"`
                        	Zone               string                 `json:"zone"`
                        	ProjectID          string                 `json:"projectID,omitempty"`
                        }

                          GCPMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an GCP virtual machine. It is used by the GCP machine actuator to create a single Machine. +k8s:openapi-gen=true

                          func ProviderSpecFromRawExtension

                          func ProviderSpecFromRawExtension(rawExtension *runtime.RawExtension) (*GCPMachineProviderSpec, error)

                            ProviderSpecFromRawExtension unmarshals the JSON-encoded spec

                            func (*GCPMachineProviderSpec) DeepCopy

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

                              func (*GCPMachineProviderSpec) DeepCopyInto

                              func (in *GCPMachineProviderSpec) DeepCopyInto(out *GCPMachineProviderSpec)

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

                                func (*GCPMachineProviderSpec) DeepCopyObject

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

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

                                  type GCPMachineProviderStatus

                                  type GCPMachineProviderStatus struct {
                                  	metav1.TypeMeta   `json:",inline"`
                                  	metav1.ObjectMeta `json:"metadata,omitempty"`
                                  
                                  	// InstanceID is the ID of the instance in GCP
                                  	// +optional
                                  	InstanceID *string `json:"instanceId,omitempty"`
                                  
                                  	// InstanceState is the provisioning state of the GCP Instance.
                                  	// +optional
                                  	InstanceState *string `json:"instanceState,omitempty"`
                                  
                                  	// Conditions is a set of conditions associated with the Machine to indicate
                                  	// errors or other status
                                  	Conditions []GCPMachineProviderCondition `json:"conditions,omitempty"`
                                  }

                                    GCPMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains GCP-specific status information. +k8s:openapi-gen=true

                                    func ProviderStatusFromRawExtension

                                    func ProviderStatusFromRawExtension(rawExtension *runtime.RawExtension) (*GCPMachineProviderStatus, error)

                                      ProviderStatusFromRawExtension unmarshals a raw extension into a GCPMachineProviderStatus type

                                      func (*GCPMachineProviderStatus) DeepCopy

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

                                        func (*GCPMachineProviderStatus) DeepCopyInto

                                        func (in *GCPMachineProviderStatus) DeepCopyInto(out *GCPMachineProviderStatus)

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

                                          func (*GCPMachineProviderStatus) DeepCopyObject

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

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

                                            type GCPMetadata

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

                                              GCPMetadata describes metadata for GCP.

                                              func (*GCPMetadata) DeepCopy

                                              func (in *GCPMetadata) DeepCopy() *GCPMetadata

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

                                                func (*GCPMetadata) DeepCopyInto

                                                func (in *GCPMetadata) DeepCopyInto(out *GCPMetadata)

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

                                                  type GCPNetworkInterface

                                                  type GCPNetworkInterface struct {
                                                  	PublicIP   bool   `json:"publicIP,omitempty"`
                                                  	Network    string `json:"network,omitempty"`
                                                  	Subnetwork string `json:"subnetwork,omitempty"`
                                                  }

                                                    GCPNetworkInterface describes network interfaces for GCP

                                                    func (*GCPNetworkInterface) DeepCopy

                                                    func (in *GCPNetworkInterface) DeepCopy() *GCPNetworkInterface

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

                                                      func (*GCPNetworkInterface) DeepCopyInto

                                                      func (in *GCPNetworkInterface) DeepCopyInto(out *GCPNetworkInterface)

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

                                                        type GCPServiceAccount

                                                        type GCPServiceAccount struct {
                                                        	Email  string   `json:"email"`
                                                        	Scopes []string `json:"scopes"`
                                                        }

                                                          GCPServiceAccount describes service accounts for GCP.

                                                          func (*GCPServiceAccount) DeepCopy

                                                          func (in *GCPServiceAccount) DeepCopy() *GCPServiceAccount

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

                                                            func (*GCPServiceAccount) DeepCopyInto

                                                            func (in *GCPServiceAccount) DeepCopyInto(out *GCPServiceAccount)

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