ibmcloud

Documentation

Overview

Package ibmcloud contains API Schema definitions for IBM Cloud clusters. +k8s:deepcopy-gen=package

Index

• Constants
• type BootVolume
  • func (in *BootVolume) DeepCopy() *BootVolume
  • func (in *BootVolume) DeepCopyInto(out *BootVolume)
• type DedicatedHost
  • func (in *DedicatedHost) DeepCopy() *DedicatedHost
  • func (in *DedicatedHost) DeepCopyInto(out *DedicatedHost)
• type MachinePool
  • func (in *MachinePool) DeepCopy() *MachinePool
  • func (in *MachinePool) DeepCopyInto(out *MachinePool)
  • func (a *MachinePool) Set(required *MachinePool)
• type Platform
  • func (in *Platform) DeepCopy() *Platform
  • func (in *Platform) DeepCopyInto(out *Platform)

Constants

const Name string = "ibmcloud"

Name is name for the ibmcloud platform.

Types

type BootVolume

type BootVolume struct {
	// EncryptionKey is the CRN referencing a Key Protect or Hyper Protect
	// Crypto Services key to use for volume encryption. If not specified, a
	// provider managed encryption key will be used.
	// +optional
	EncryptionKey string `json:"encryptionKey,omitempty"`
}

BootVolume stores the configuration for an individual machine's boot volume.

func (*BootVolume) DeepCopy

func (in *BootVolume) DeepCopy() *BootVolume

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

func (*BootVolume) DeepCopyInto

func (in *BootVolume) DeepCopyInto(out *BootVolume)

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

type DedicatedHost

type DedicatedHost struct {
	// Name is the name of the dedicated host to provision the machine on. If
	// specified, machines will be created on pre-existing dedicated host.
	// +optional
	Name string `json:"name,omitempty"`

	// Profile is the profile ID for the dedicated host. If specified, new
	// dedicated host will be created for machines.
	// +optional
	Profile string `json:"profile,omitempty"`
}

DedicatedHost stores the configuration for the machine's dedicated host platform.

func (*DedicatedHost) DeepCopy

func (in *DedicatedHost) DeepCopy() *DedicatedHost

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

func (*DedicatedHost) DeepCopyInto

func (in *DedicatedHost) DeepCopyInto(out *DedicatedHost)

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

type MachinePool

type MachinePool struct {
	// InstanceType is the VSI machine profile.
	InstanceType string `json:"type,omitempty"`

	// Zones is the list of availability zones used for machines in the pool.
	// +optional
	Zones []string `json:"zones,omitempty"`

	// BootVolume is the configuration for the machine's boot volume.
	// +optional
	BootVolume *BootVolume `json:"bootVolume,omitempty"`

	// DedicatedHosts is the configuration for the machine's dedicated host and profile.
	// +optional
	DedicatedHosts []DedicatedHost `json:"dedicatedHosts,omitempty"`
}

MachinePool stores the configuration for a machine pool installed on IBM Cloud.

func (*MachinePool) DeepCopy

func (in *MachinePool) DeepCopy() *MachinePool

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

func (*MachinePool) DeepCopyInto

func (in *MachinePool) DeepCopyInto(out *MachinePool)

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

func (*MachinePool) Set

func (a *MachinePool) Set(required *MachinePool)

Set sets the values from `required` to `a`.

type Platform

type Platform struct {
	// CredentialsSecretRef refers to a secret that contains IBM Cloud account access
	// credentials.
	CredentialsSecretRef corev1.LocalObjectReference `json:"credentialsSecretRef"`
	// AccountID is the IBM Cloud Account ID.
	// AccountID is DEPRECATED and is gathered via the IBM Cloud API for the provided
	// credentials. This field will be ignored.
	// +optional
	AccountID string `json:"accountID,omitempty"`
	// CISInstanceCRN is the IBM Cloud Internet Services Instance CRN
	// CISInstanceCRN is DEPRECATED and gathered via the IBM Cloud API for the provided
	// credentials and cluster deployment base domain. This field will be ignored.
	// +optional
	CISInstanceCRN string `json:"cisInstanceCRN,omitempty"`
	// Region specifies the IBM Cloud region where the cluster will be
	// created.
	Region string `json:"region"`
}

Platform stores all the global configuration that all machinesets use.

func (*Platform) DeepCopy

func (in *Platform) DeepCopy() *Platform

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

func (*Platform) DeepCopyInto

func (in *Platform) DeepCopyInto(out *Platform)

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