Annotations

​Velocity Annotations are added to your K8s entity definitions under the metadata.annotations tag. They add essential information about your application, such as an identifier, dependencies, connectivity definitions, and more. 
Examples in GitHub: Helm on AWS, Helm on GCP​
​
On all Kubernetes resources
velocity.tech.v1/id
Specify a Velocity Service identifier
Example: velocity.tech.v1/id: backend
velocity.tech.v1/dependsOn
Specify service dependencies to enable extracting service parameters and service properties.
Example: velocity.tech.v1/dependsOn: mysql, postgres 
velocity.tech.v1/bootDependsOn
Specify service boot dependencies to control provision order.
Example: velocity.tech.v1/bootDependsOn: mysql
velocity.tech.v1/associateTo
Associate additional K8s resources to a Velocity service. For example, ServiceAccount resources.
Example: velocity.tech.v1/associateTo: mysql
velocity.tech.v1/exports-<variable>
Define a variable that other services can import.
Export the value specified in the following path so that other services can import it: 
velocity.tech.v1/exports-db_name: path="spec.template.spec.containers.(name=my-sql).env.[0].value"
velocity.tech.v1/ignored
Specify a resource to be ignored by Velocity. When a resource has this annotation, it won't appear in Velocity.
On Deployments, StatefulSets, Jobs, or others with an /id
velocity.tech.v1/exposures-<port_id>-publicHostname
Specify the public hostname for the related k8 service port.
For ingress objects - this is inferred automatically.
Useful for special CRDs.
Example: velocity.tech.v1/exposures-<port_id>-publicHostname: service-{velocity.v1.domainSuffix}
velocity.tech.v1/exposures-<port_id>-user
Specify the user name for the related k8 service port, which will be used when generating a URI.
Example: velocity.tech.v1/exposures-<port_id>-user: const="username"
velocity.tech.v1/exposures-<port_id>-password
Specify the password for the related k8 service port which will be used when generating a URI.
Example: velocity.tech.v1/exposures-<port_id>-password: const="password"
velocity.tech.v1/exposures-<port_id>-scheme
Specify the schema for the related k8 service port, which will be used when generating a URI.
Example: velocity.tech.v1/exposures-<port_id>-scheme: const="https"
velocity.tech.v1/readyTimeout
Specify a custom timeout of waiting for the resource to become ready or finish executing. 
The timeout must be between 1m (1 minute) and 1h (1 hour).
The default value varies between resource types. It is 15m for Jobs and 10m for other resources.
Example: velocity.tech.v1/readyTimeout: 15m
On Jobs
velocity.tech.v1/runPolicy
Defines the run policy. By default, the job will run once on environment creation.  
Optional values: 
always: Run on environment create and with any environment update. 
destroy: Run on environment destruction.
Example: velocity.tech.v1/runPolicy: always
​
Last modified 2mo ago