annotation

Documentation

Overview

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

Index

• Constants

Constants

const AWSCNIMinimumIPTarget = "alpha.cni.aws.giantswarm.io/minimum-ip-target"

support:

• crd: awsclusters.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 14.0.0

documentation:

This annotation allows configuration of the MINIMUM_IP_TARGET parameter for AWS CNI.
See [CNI Configuration Variables](https://github.com/aws/amazon-vpc-cni-k8s#cni-configuration-variables)
and [ENI and IP Target](https://github.com/aws/amazon-vpc-cni-k8s/blob/master/docs/eni-and-ip-target.md)

const AWSCNIWarmIPTarget = "alpha.cni.aws.giantswarm.io/warm-ip-target"

support:

• crd: awsclusters.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 14.0.0

documentation:

This annotation allows configuration of the WARM_IP_TARGET parameter for AWS CNI.
See [CNI Configuration Variables](https://github.com/aws/amazon-vpc-cni-k8s#cni-configuration-variables)
and [ENI and IP Target](https://github.com/aws/amazon-vpc-cni-k8s/blob/master/docs/eni-and-ip-target.md)

const AWSMetadataV2 = "alpha.aws.giantswarm.io/metadata-v2"

Not documented as it's not usable. AWSMetadataV2 configures token usage for your AWS EC2 instance metadata requests. If the value is 'optional', you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned. If the state is 'required', you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available. Default value is 'optional'

[AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens)

const AWSSubnetSize = "alpha.aws.giantswarm.io/aws-subnet-size"

support:

• crd: awsclusters.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 12.7.0
• crd: awsmachinedeployments.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 12.7.0

documentation:

This annotation is used to configure the workload cluster's control plane subnet size when used on an `AWSCluster` resource or to configure the workload cluster's node pool subnet size when used on an `AWSMachineDeployment` resource.
The value is a number that will represent the subnet mask used when creating the subnet. It must be smaller than 28 due to AWS restrictions.

const AWSUpdateMaxBatchSize = "alpha.aws.giantswarm.io/update-max-batch-size"

support:

• crd: awsclusters.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 12.7.0
• crd: awsmachinedeployments.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 12.7.0

documentation:

This annotation is used for configuring maximum batch size for instances termination during ASG update.
The value can be either a whole number specifying the number of instances
or a percentage of total instances as decimal number ie `0.3` for 30%.
See [Fine Tuning Upgrades](https://docs.giantswarm.io/guides/fine-tuning-upgrade-disruption-on-aws/)
and [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate-maxbatchsize) for additional information.

const AWSUpdatePauseTime = "alpha.aws.giantswarm.io/update-pause-time"

support:

• crd: awsclusters.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 12.7.0
• crd: awsmachinedeployments.infrastructure.giantswarm.io apiversion: v1alpha2 release: Since 12.7.0

documentation:

This annotation is used for configuring time pause between rolling a single batch during ASG update.
The value must be in ISO 8601 duration format, e. g. "PT5M" for five minutes or "PT10S" for 10 seconds.
See [Fine Tuning Upgrades](https://docs.giantswarm.io/guides/fine-tuning-upgrade-disruption-on-aws/)
and [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate-maxbatchsize) for additional information.

const AppOperatorPaused = "app-operator.giantswarm.io/paused"

AppOperatorPaused annotation when present prevents app-operator from reconciling the resource.

const AzureWorkersEgressExternalPublicIP = "giantswarm.io/workers-egress-external-public-ip"

support:

• crd: azureclusters.infrastructure.cluster.x-k8s.io apiversion: v1alpha3 release: Since 15.1.0

documentation:

This annotation allows reusing an existing public IP address for egress traffic of worker nodes.
See [Setting an egress IP address on Azure](https://docs.giantswarm.io/advanced/egress-ip-address-azure/)

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

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

const ConfigVersion = "config.giantswarm.io/version"

ConfigVersion is the annotation put on App CRs and consumed by config-controller. This indicates what major version of the configuration should be used for this application. Versions are configured in a <major>.x.x format (e.g. 3.x.x), which means the latest v3.<minor>.<patch> tag should be used to generate ConfigMap and Secret for this App CR. When given version does not match the <major>.x.x format, config-controller assumes given version is a branch reference (e.g. "master") and the matching branch will be used to generate configuration instead.

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 LastDeployedReleaseVersion = "release.giantswarm.io/last-deployed-version"

LastDeployedReleaseVersion is the version annotation put into Cluster CR to define which workload cluster release was last successfully deployed during cluster creation or upgrade. Versions are defined as semver version without the "v" prefix, e.g. 14.1.0, which means that cluster was created with or upgraded to workload cluster release v14.1.0.

const LatestConfigMapVersion = "app-operator.giantswarm.io/giantswarm.io/latest-configmap-version"

LatestConfigMapVersion is the highest resource version among the configmaps app CRs depends on.

const LatestSecretVersion = "app-operator.giantswarm.io/latest-secret-version"

LatestSecretVersion is the highest resource version among the secret app CRs depends on.

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 NodePoolMaxSize = "cluster.k8s.io/cluster-api-autoscaler-node-group-max-size"

support:

• crd: machinepools.exp.cluster.x-k8s.io apiversion: v1alpha3 release: Since Azure 13.1.0

documentation:

This annotation allows setting the max size of a node pool for autoscaling purposes.
See [node pools](https://docs.giantswarm.io/advanced/node-pools/)

const NodePoolMinSize = "cluster.k8s.io/cluster-api-autoscaler-node-group-min-size"

support:

• crd: machinepools.exp.cluster.x-k8s.io apiversion: v1alpha3 release: Since Azure 13.1.0

documentation:

This annotation allows setting the min size of a node pool for autoscaling purposes.
See [node pools](https://docs.giantswarm.io/advanced/node-pools/)

const NodeTerminateUnhealthy = "node.giantswarm.io/terminate-unhealthy"

Annotation used to enable feature to terminate unhealthy nodes on a cluster CR.

const Notes = "giantswarm.io/notes"

Notes is for informational messages for resources managed by operators. Such as whether the resource may or may not be edited.

const OIDCClientID = "oidc.giantswarm.io/client-id"

Annotations used to configure OIDC in workload clusters.

const OIDCGroupClaim = "oidc.giantswarm.io/group-claim"

const OIDCIssuerURL = "oidc.giantswarm.io/issuer-url"

const OIDCUsernameClaim = "oidc.giantswarm.io/username-claim"

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".

const UIOriginalOrganizationName = "ui.giantswarm.io/original-organization-name"

support:

• crd: organization.security.giantswarm.io apiversion: v1alpha1

documentation:

This annotation contains the original name of organizations migrated from
our legacy organization management service.