hcloud

Documentation

Overview

Package hcloud provides types and functions used for HCloud interaction

Package hcloud provides types and functions used for HCloud interaction

Package hcloud provides types and functions used for HCloud interaction

Index

• Constants
• Variables
• type Credentials
  • func ExtractCredentials(secret *corev1.Secret) (*Credentials, error)
  • func GetCredentials(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (*Credentials, error)
  • func (c *Credentials) CCM() Token
  • func (c *Credentials) CSI() Token
  • func (c *Credentials) MCM() Token
• type Token

Constants

const (
	// Name is the name of the Hcloud provider controller.
	Name = "provider-hcloud"

	// MachineControllerManagerImageName is the name of the MachineControllerManager image.
	MachineControllerManagerImageName = "machine-controller-manager"
	// MCMProviderHcloudImageName is the namne of the HCloud provider plugin image.
	MCMProviderHcloudImageName = "machine-controller-manager-provider-hcloud"
	// CloudControllerImageName is the name of the external HCloud CloudProvider image.
	CloudControllerImageName = "hcloud-cloud-controller-manager"

	// CSIAttacherImageName is the name of the CSI attacher image.
	CSIAttacherImageName = "csi-attacher"
	// CSINodeDriverRegistrarImageName is the name of the CSI driver registrar image.
	CSINodeDriverRegistrarImageName = "csi-node-driver-registrar"
	// CSIProvisionerImageName is the name of the CSI provisioner image.
	CSIProvisionerImageName = "csi-provisioner"
	// CSIDriverControllerImageName is the name of the CSI driver controller plugin image.
	CSIDriverControllerImageName = "csi-driver-controller"
	// CSIDriverNodeImageName is the name of the CSI driver node plugin image.
	CSIDriverNodeImageName = "csi-driver-node"
	// CSIResizerImageName is the name of the csi-resizer image.
	CSIResizerImageName = "csi-resizer"
	// LivenessProbeImageName is the name of the liveness-probe image.
	LivenessProbeImageName = "liveness-probe"

	// Common HCloud credentials token
	HcloudToken = "hcloudToken"
	// Cloud Controller Manager HCloud credentials token
	HcloudTokenCCM = "hcloudTokenCCM"
	// Container Storage Interface driver HCloud credentials token
	HcloudTokenCSI = "hcloudTokenCSI"
	// Machine Controller Manager HCloud credentials token
	HcloudTokenMCM = "hcloudTokenMCM"

	// CloudProviderConfig is the name of the configmap containing the cloud provider config.
	CloudProviderConfig = "cloud-provider-config"
	// CloudProviderConfigMapKey is the key storing the cloud provider config as value in the cloud provider configmap.
	CloudProviderConfigMapKey = "cloudprovider.conf"
	// MachineControllerManagerName is a constant for the name of the machine-controller-manager.
	MachineControllerManagerName = "machine-controller-manager"
	// MachineControllerManagerVpaName is the name of the VerticalPodAutoscaler of the machine-controller-manager deployment.
	MachineControllerManagerVpaName = "machine-controller-manager-vpa"
	// MachineControllerManagerMonitoringConfigName is the name of the ConfigMap containing monitoring stack configurations for machine-controller-manager.
	MachineControllerManagerMonitoringConfigName = "machine-controller-manager-monitoring-config"

	// CloudControllerManagerName is the constant for the name of the CloudController deployed by the control plane controller.
	CloudControllerManagerName = "cloud-controller-manager"

	// CloudControllerManagerServerName is the constant for the name of the CloudController deployed by the control plane controller.
	CloudControllerManagerServerName = "cloud-controller-manager-server"
	// CSIProvisionerName is a constant for the name of the csi-provisioner component.
	CSIProvisionerName = "csi-provisioner"
	// CSIAttacherName is a constant for the name of the csi-attacher component.
	CSIAttacherName = "csi-attacher"
	// CSIResizerName is a constant for the name of the csi-resizer component.
	CSIResizerName = "csi-resizer"
	// CSIControllerName is a constant for the name of the hcloud-csi-controller component.
	CSIControllerName = "hcloud-csi-controller"
	// CSINodeName is a constant for the chart name for a CSI node deployment in the shoot.
	CSINodeName = "hcloud-csi-node"
	// CSIDriverName is a constant for the name of the csi-driver component.
	CSIDriverName = "csi-driver"
)

const Type = "hcloud"

Type is the type of resources managed by the HCloud actuator.

Variables

var (
	// ChartsPath is the path to the charts
	ChartsPath = filepath.Join("charts")
	// InternalChartsPath is the path to the internal charts
	InternalChartsPath = filepath.Join(ChartsPath, "internal")

	// UsernamePrefix is a constant for the username prefix of components deployed by OpenStack.
	UsernamePrefix = extensionsv1alpha1.SchemeGroupVersion.Group + ":" + Name + ":"
)

Types

type Credentials

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

Credentials contains the necessary HCloud credential information.

func ExtractCredentials

func ExtractCredentials(secret *corev1.Secret) (*Credentials, error)

ExtractCredentials generates a credentials object for a given provider secret.

PARAMETERS secret *corev1.Secret Secret to extract tokens from

func GetCredentials

func GetCredentials(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (*Credentials, error)

GetCredentials computes for a given context and infrastructure the corresponding credentials object.

PARAMETERS ctx context.Context Execution context c client.Client Controller client secretRef corev1.SecretReference Secret reference to read credentials from

func (*Credentials) CCM

func (c *Credentials) CCM() Token

CCM returns the token used for the Cloud Controller Manager.

func (*Credentials) CSI

func (c *Credentials) CSI() Token

CSI returns the token used for the Container Storage Interface driver.

func (*Credentials) MCM

func (c *Credentials) MCM() Token

MCM returns the token used for the Machine Controller Manager.

type Token

type Token struct {
	Token string
}