ibmcloud

Documentation

Overview

Package ibmcloud contains IBM Cloud-specific structures for installer configuration and management.

Index

• Constants
• type BootVolume
• type DedicatedHost
• type MachinePool
  • func (a *MachinePool) Set(required *MachinePool)
• type Metadata
• type Platform
  • func (p *Platform) ClusterResourceGroupName(infraID string) string
  • func (p *Platform) GetVPCName() string

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.

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.

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

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

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

type Metadata

type Metadata struct {
	AccountID         string   `json:"accountID"`
	BaseDomain        string   `json:"baseDomain"`
	CISInstanceCRN    string   `json:"cisInstanceCRN,omitempty"`
	DNSInstanceID     string   `json:"dnsInstanceID,omitempty"`
	Region            string   `json:"region,omitempty"`
	ResourceGroupName string   `json:"resourceGroupName,omitempty"`
	VPC               string   `json:"vpc,omitempty"`
	Subnets           []string `json:"subnets,omitempty"`
}

Metadata contains IBM Cloud metadata (e.g. for uninstalling the cluster).

type Platform

type Platform struct {
	// Region specifies the IBM Cloud region where the cluster will be
	// created.
	Region string `json:"region"`

	// ResourceGroupName is the name of an already existing resource group where the
	// cluster should be installed. If empty, a new resource group will be created
	// for the cluster.
	// +optional
	ResourceGroupName string `json:"resourceGroupName,omitempty"`

	// NetworkResourceGroupName is the name of an already existing resource group
	// where an existing VPC and set of Subnets exist, to be used during cluster
	// creation.
	// +optional
	NetworkResourceGroupName string `json:"networkResourceGroupName,omitempty"`

	// VPCName is the name of an already existing VPC to be used during cluster
	// creation.
	// +optional
	VPCName string `json:"vpcName,omitempty"`

	// ControlPlaneSubnets are the names of already existing subnets where the
	// cluster control plane nodes should be created.
	// +optional
	ControlPlaneSubnets []string `json:"controlPlaneSubnets,omitempty"`

	// ComputeSubnets are the names of already existing subnets where the cluster
	// compute nodes should be created.
	// +optional
	ComputeSubnets []string `json:"computeSubnets,omitempty"`

	// DefaultMachinePlatform is the default configuration used when installing
	// on IBM Cloud for machine pools which do not define their own platform
	// configuration.
	// +optional
	DefaultMachinePlatform *MachinePool `json:"defaultMachinePlatform,omitempty"`
}

Platform stores all the global configuration that all machinesets use.

func (*Platform) ClusterResourceGroupName

func (p *Platform) ClusterResourceGroupName(infraID string) string

ClusterResourceGroupName returns the name of the resource group for the cluster.

func (*Platform) GetVPCName

func (p *Platform) GetVPCName() string

GetVPCName returns the user provided name of the VPC for the cluster.