Labels and annotations

This page describes the custom Kubernetes Labels & Annotations that Apollo adds to Products when running them in a Spoke Environment.

Label specification

apollo.palantir.com/status.liveness_and_readiness

For a service to have its liveness and readiness reported to the Apollo Platform, the label apollo.palantir.com/status.liveness_and_readiness must be on the Pod spec template for the service. The label is automatically added to any Entity deployed using the provided Apollo Agent.

Example:

Copied!
1
apollo.palantir.com/status.liveness_and_readiness: ""

Annotation specification

apollo.palantir.com/metadata.environment.id

Value: The value of the annotation is the Apollo Environment ID the Entity belongs to. The Apollo Environment ID annotation is automatically added when deploying Entities using the provided Apollo Agent.

Example:

apollo.palantir.com/metadata.environment.id: example-apollo-environment-id

apollo.palantir.com/metadata.entity.id

Value: The value of the annotation is the ID of the Apollo Entity the K8s Object is related to. The Apollo Entity format is aeid:<apollo-environment-id>:<entity-type>:<entity-name>. Apollo Entity IDs must be less than 255 characters. The Apollo Entity ID annotation is automatically added when deploying Entities using the provided Apollo Agent.

Example:

apollo.palantir.com/metadata.entity.id: "aeid:example-apollo-environment-id:helm-chart:prometheus-helm"

apollo.palantir.com/metadata.product.name

Value: The value of the annotation is the product name of the Apollo Entity the K8s Object is related to. The product name is automatically added when deploying Entities using the provided Apollo Agent.

Example:

apollo.palantir.com/metadata.product.name: prometheus

apollo.palantir.com/metadata.product.group

Value: The value of the annotation is the product group of the Apollo Entity the K8s Object is related to. The product group is automatically added when deploying Entities using the provided Apollo Agent.

Example:

apollo.palantir.com/metadata.product.group: com.palantir

apollo.palantir.com/metadata.product.version

Value: The value of the annotation is the product version of the Apollo Entity the K8s Object is related to. The product version is automatically added when deploying Entities using the provided Apollo Agent.

Example:

apollo.palantir.com/metadata.product.version: 2.0.0

com.palantir.rubix.pod/pod-key-pair-v2

The value of the pod key pair v2 annotation. This annotation will generate a new private key and certificate signed by the Apollo pod CA along with the CA certificate for the pod CA. Using this annotation will cause the following files to be rendered in a pod:

• /mnt/secrets/certs/key.pem
• /mnt/secrets/certs/cert.pem
• /mnt/secrets/certs/keystore.jks
• /mnt/secrets/certs/truststore.jks

Fields:

• service - The Kubernetes service for which to sign the certificate.
• authnId - The transparent ID to use for client TLS authentication for outbound connections using the certificate. If this field is set, the user must not be a token user.

Example:

Copied!
1
2
3
4
5
6
7
8
9
com.palantir.rubix.pod/pod-key-pair-v2: >
{
    "service":
        {
            "name": "test-service",
            "namespace":"services-yellow"
        },
    "authnId":"TEST USER ID"
}