label

Documentation

Index

• Constants

Constants

const AWSOperatorVersion = "aws-operator.giantswarm.io/version"

AWSOperatorVersion is the version label put into AWS specific CRs to define which aws-operator version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 8.7.0, which means that there is an aws-operator release v8.7.0.

const App = "app"

App label is used to identify Kubernetes resources. It is considered deprecated by upstream and is replaced by `app.kubernetes.io/name`.

const AppKubernetesInstance = "app.kubernetes.io/instance"

AppKubernetesInstance is a unique name identifying an instance of an app.

const AppKubernetesName = "app.kubernetes.io/name"

AppKubernetesName label is used to identify Kubernetes resources.

const AppKubernetesVersion = "app.kubernetes.io/version"

AppKubernetesVersion label is used to identify the version of Kubernetes resources.

const AppOperatorVersion = "app-operator.giantswarm.io/version"

AppOperatorVersion is the version label put into app CRs to define which app-operator version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 2.1.0, which means that there is an app-operator release v2.1.0.

const AzureOperatorVersion = "azure-operator.giantswarm.io/version"

AzureOperatorVersion is the version label put into Azure specific CRs to define which azure-operator version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 4.1.0, which means that there is an azure-operator release v4.1.0.

const CatalogName = "application.giantswarm.io/catalog"

CatalogName label is used to identify resources belonging to a Giant Swarm app catalog.

const CatalogType = "application.giantswarm.io/catalog-type"

CatalogType label is used to identify the type of Giant Swarm app catalog e.g. stable or test.

const CatalogVisibility = "application.giantswarm.io/catalog-visibility"

CatalogVisibility label is used to determine how Giant Swarm app catalogs are displayed in the UX. e.g. public or internal.

const ChartOperatorVersion = "chart-operator.giantswarm.io/version"

ChartOperatorVersion is the version label put into app CRs to define which app-operator version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 1.0.0, which means that there is a chart-operator release v1.0.0.

const Cluster = "giantswarm.io/cluster"

Cluster is the ID label put into all CRs to identify which workload cluster the given CR is related to.

const ClusterOperatorVersion = "cluster-operator.giantswarm.io/version"

ClusterOperatorVersion is the version label put into provider independent CRs to define which cluster-operator version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 2.3.0, which means that there is a cluster-operator release v2.3.0.

const ConfigControllerVersion = "config-controller.giantswarm.io/version"

ConfigControllerVersion is the version label put into app CRs to define which config-controller version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 1.0.0, which means that there is a config-controller release v1.0.0.

const ControlPlane = "giantswarm.io/control-plane"

ControlPlane is the ID label put into all Control Plane CRs to identify which Master Nodes the given CR groups together.

const DisplayInUserInterface = "ui.giantswarm.io/display"

Affects whether or not a resource is intended for display in a user interface. For example, it can be used to hide irrelevant system roles from users by default. The value can either be "true" or "false".

const KVMOperatorVersion = "kvm-operator.giantswarm.io/version"

KVMOperatorVersion is the version label put into KVM specific CRs to define which kvm-operator version should reconcile the given CR. Versions are defined as semver version without the "v" prefix, e.g. 8.7.0, which means that there is a kvm-operator release v8.7.0.

const MachineDeployment = "giantswarm.io/machine-deployment"

MachineDeployment is the ID label put into all Machine Deployment CRs to identify which Worker Nodes the given CR groups together.

const MachinePool = "giantswarm.io/machine-pool"

MachinePool is the ID label put into all MachinePool and AzureMachinePool CRs and it contains workload cluster node pool ID (i.e. the machine pool ID). E.g. giantswarm.io/machine-pool=de19f-h94vd.

const ManagedBy = "giantswarm.io/managed-by"

ManagedBy is the name of the operator managing the object. E.g. giantswarm.io/managed-by=app-operator.

const Monitoring = "giantswarm.io/monitoring"

Monitoring is a label that can be used on `Service` resources to mark them for scraping by Giant Swarm Prometheus instances that monitor the cluster they're found in. The service will be scraped only if the value is `true`.

Spec: https://intranet.giantswarm.io/docs/architecture-specs-adrs/specs/configuration-of-targets-in-tc-prometheus/

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

MonitoringPath is an annotation that tells Prometheus the URL path a service exposes metrics on. It can be used on `Service` resources and will be picked up by `simple-service` `ServiceMonitor` to configure Prometheus.

The default is to use the path `/metrics`.

Spec: https://intranet.giantswarm.io/docs/architecture-specs-adrs/specs/configuration-of-targets-in-tc-prometheus/

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

MonitoringPort is an annotation that tells Prometheus which port a service exposes metrics on. It can be used on `Service` resources and will be picked up by `simple-service` `ServiceMonitor` to configure Prometheus.

The default is to use the main port exposed in the `Service` resource if this annotation isn't used.

Spec: https://intranet.giantswarm.io/docs/architecture-specs-adrs/specs/configuration-of-targets-in-tc-prometheus/

const Organization = "giantswarm.io/organization"

Organization is the ID label put into all CRs to identify which Organization the given CR is related to.

const ReleaseVersion = "release.giantswarm.io/version"

ReleaseVersion is the version label put into all CRs to define which Giant Swarm release the given CR is related to. Versions are defined as semver version without the "v" prefix, e.g. 11.4.0, which means that there is a Giant Swarm release v11.4.0.