Skip to main content
Version: Next

Overview of Contrast elements in Kubernetes YAML

This document provides an overview of the Contrast elements that can be used in Kubernetes YAML files, particularly the Contrast specific annotations that can be applied to workloads.

Overview of Contrast annotations

Before running the contrast generate command, you can customize its behavior by using various annotations, like skipping the Initializer injection or settings up the Service Mesh. These annotations can be added to the workload's Pod (Pod Template) metadata. The following table gives an overview of the available annotations and their purpose.

AnnotationDescription
contrast.edgeless.systems/skip-initializerSkip the Initializer injection for this workload.
contrast.edgeless.systems/servicemesh-ingressSetup the Service Mesh ingress for this workload.
contrast.edgeless.systems/servicemesh-egressSetup the Service Mesh egress for this workload.
contrast.edgeless.systems/servicemesh-admin-interface-portEnable the Envoy admin interface for the Service Mesh on the specified port.
contrast.edgeless.systems/secure-pvEnable secure storage for the workload by setting up a LUKS-encrypted volume.
contrast.edgeless.systems/workload-secret-idSpecify the workloadSecretID to use for this workload.