annotation

Documentation

Overview

Package annotation defines annotation keys used by Giant Swarm within Kubernetes resources.

Index

• Constants

Constants

const ClusterDescription = "cluster.giantswarm.io/description"

ClusterDescription is the cluster annotation used for storing a customer's cluster description.

const Docs = "giantswarm.io/docs"

Docs is the docs annotation put into all CRs to link to its CR specific documentation. This aims to help understanding all the moving parts within the system and how they relate to each other.

const MachineDeploymentSubnet = "machine-deployment.giantswarm.io/subnet"

MachineDeploymentSubnet is used to specify the IPv4 CIDR used for a node pool defined by a MachineDeployment or AWSMachineDeployment CR.

const MachinePoolName = "machine-pool.giantswarm.io/name"

MachinePoolName is the node pool annotation where human-friendly node pool name set by the customer is stored.

const Monitoring = "giantswarm.io/monitoring"

Monitoring is used to activate/deactivate monitoring of a Service resource. The value "true" activates it, "false" deactivates it.

const MonitoringPath = "giantswarm.io/monitoring-path"

MonitoringPath is the path component of a metrics endpoint, e. g. "/metrics".

const MonitoringPort = "giantswarm.io/monitoring-port"

MonitoringPort is the TCP port number to use for reaching the monitoring endpoint of a Service. E. g. "8080".

const ReleaseNotesURL = "giantswarm.io/release-notes"

ReleaseNotesURL defines where to find release notes about the CR at hand. The value is expected to be a URI, e. g. "https://github.com/giantswarm/releases/tree/master/aws/v11.5.0".