docs: release 0.5.0

docs/versioned_docs/version-0.5.0/architecture/index.md

@@ -0,0 +1,5 @@
+# Architecture
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />

docs/versioned_docs/version-0.5.0/basics/confidential-containers.md

@@ -0,0 +1,32 @@
+# Confidential Containers
+
+Contrast uses some building blocks from [Confidential Containers](https://confidentialcontainers.org) (CoCo), a [CNCF Sandbox project](https://www.cncf.io/projects/confidential-containers/) that aims to standardize confidential computing at the pod level.
+The project is under active development and many of the high-level features are still in flux.
+Contrast uses the more stable, core primitive provided by CoCo: its Kubernetes runtime.
+
+## Kubernetes RuntimeClass
+
+Kubernetes can be extended to use more than one container runtime with [`RuntimeClass`](https://kubernetes.io/docs/concepts/containers/runtime-class/) objects.
+The [Container Runtime Interface](https://kubernetes.io/docs/concepts/architecture/cri/) (CRI) implementation, for example containerd, dispatches pod management API calls to the appropriate `RuntimeClass`.
+`RuntimeClass` implementations are usually based on an [OCI runtime](https://github.com/opencontainers/runtime-spec), such as `runc`, `runsc` or `crun`.
+In CoCo's case, the runtime is Kata Containers with added confidential computing capabilities.
+
+## Kata Containers
+
+[Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs.
+The guest VM spawns an agent process that accepts management commands from the Kata runtime running on the host.
+There are two options for creating pod VMs: local to the Kubernetes node, or remote VMs created with cloud provider APIs.
+Using local VMs requires either bare metal servers or VMs with support for nested virtualization.
+Local VMs communicate with the host over a virtual socket.
+For remote VMs, host-to-agent communication is tunnelled through the cloud provider's network.
+
+Kata Containers was originally designed to isolate the guest from the host, but it can also run pods in confidential VMs (CVMs) to shield pods from their underlying infrastructure.
+In confidential mode, the guest agent is configured with an [Open Policy Agent](https://www.openpolicyagent.org/) (OPA) policy to authorize API calls from the host.
+This policy also contains checksums for the expected container images.
+It's derived from Kubernetes resource definitions and its checksum is included in the attestation report.
+
+## AKS CoCo Preview
+
+[Azure Kubernetes Service](https://learn.microsoft.com/en-us/azure/aks/) (AKS) provides CoCo-enabled node pools as a [preview offering](https://learn.microsoft.com/en-us/azure/aks/confidential-containers-overview).
+These node pools leverage Azure VM types capable of nested virtualization (CVM-in-VM) and the CoCo stack is pre-installed.
+Contrast can be deployed directly into a CoCo-enabled AKS cluster.

docs/versioned_docs/version-0.5.0/basics/features.md

@@ -0,0 +1,15 @@
+# Product Features
+
+Contrast simplifies the deployment and management of Confidential Containers, offering optimal data security for your workloads while integrating seamlessly with your existing Kubernetes environment.
+
+From a security perspective, Contrast employs the [Confidential Containers](confidential-containers.md) concept and provides [security benefits](security-benefits.md) that go beyond individual containers, shielding your entire deployment from the underlying infrastructure.
+
+From an operational perspective, Contrast provides the following key features:
+
+* **Managed Kubernetes Compatibility**: Initially compatible with Azure Kubernetes Service (AKS), Contrast is designed to support additional platforms such as AWS EKS and Google Cloud GKE as they begin to accommodate confidential containers.
+
+* **Lightweight Installation**: Contrast can be integrated as a [day-2 operation](../deployment.md) within existing clusters, adding minimal [components](../architecture) to your setup. This facilitates straightforward deployments using your existing YAML configurations, Helm charts, or Kustomization, enabling native Kubernetes orchestration of your applications.
+
+* **Remote Attestation**: Contrast generates a concise attestation statement that verifies the identity, authenticity, and integrity of your deployment both internally and to external parties. This architecture ensures that updates or scaling of the application don't compromise the attestation’s validity.
+
+* **Service Mesh**: Contrast securely manages a Public Key Infrastructure (PKI) for your deployments, issues workload-specific certificates, and establishes transparent mutual TLS (mTLS) connections across pods. This is done by harnessing the [envoy proxy](https://www.envoyproxy.io/) to ensure secure communications within your Kubernetes cluster.

docs/versioned_docs/version-0.5.0/deployment.md

@@ -0,0 +1,161 @@
+# Workload deployment
+
+The following instructions will guide you through the process of making an existing Kubernetes deployment
+confidential and deploying it together with Contrast.
+
+A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/cluster-setup.md) on how to set it up.
+
+## Deploy the Contrast Coordinator
+
+Install the latest Contrast Coordinator release, comprising a single replica deployment and a
+LoadBalancer service, into your cluster.
+
+```sh
+kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/latest/coordinator.yml
+```
+
+## Prepare your Kubernetes resources
+
+Contrast will add annotations to your Kubernetes YAML files. If you want to keep the original files
+unchanged, you can copy the files into a separate local directory.
+You can also generate files from a Helm chart or from a Kustomization.
+
+<Tabs groupId="yaml-source">
+<TabItem value="kustomize" label="kustomize">
+
+```sh
+mkdir resources
+kustomize build $MY_RESOURCE_DIR > resources/all.yml
+```
+
+</TabItem>
+<TabItem value="helm" label="helm">
+
+```sh
+mkdir resources
+helm template $RELEASE_NAME $CHART_NAME > resources/all.yml
+```
+
+</TabItem>
+<TabItem value="copy" label="copy">
+
+```sh
+cp -R $MY_RESOURCE_DIR resources/
+```
+
+</TabItem>
+</Tabs>
+
+To specify that a workload (pod, deployment, etc.) should be deployed as confidential containers,
+add `runtimeClassName: kata-cc-isolation` to the pod spec (pod definition or template).
+In addition, add the Contrast Initializer as `initContainers` to these workloads and configure the
+workload to use the certificates written to a `volumeMount` named `tls-certs`.
+
+```yaml
+spec: # v1.PodSpec
+  runtimeClassName: kata-cc-isolation
+  initContainers:
+  - name: initializer
+    image: "ghcr.io/edgelesssys/contrast/initializer:latest"
+    env:
+    - name: COORDINATOR_HOST
+      value: coordinator
+    volumeMounts:
+    - name: tls-certs
+      mountPath: /tls-config
+  volumes:
+  - name: tls-certs
+    emptyDir: {}
+```
+
+## Generate policy annotations and manifest
+
+Run the `generate` command to generate the execution policies and add them as annotations to your
+deployment files. A `manifest.json` with the reference values of your deployment will be created.
+
+```sh
+contrast generate resources/
+```
+
+## Apply the resources
+
+Apply the resources to the cluster. Your workloads will block in the initialization phase until a
+manifest is set at the Coordinator.
+
+```sh
+kubectl apply -f resources/
+```
+
+## Connect to the Contrast Coordinator
+
+For the next steps, we will need to connect to the Coordinator. The released Coordinator resource
+includes a LoadBalancer definition we can use.
+
+```sh
+coordinator=$(kubectl get svc coordinator -o=jsonpath='{.status.loadBalancer.ingress[0].ip}')
+```
+
+:::info[Port-forwarding of Confidential Containers]
+
+`kubectl port-forward` uses a Container Runtime Interface (CRI) method that isn't supported by the Kata shim.
+If you can't use a public load balancer, you can deploy a [port-forwarder](https://github.com/edgelesssys/contrast/blob/main/deployments/emojivoto/portforwarder.yml).
+The port-forwarder relays traffic from a CoCo pod and can be accessed via `kubectl port-forward`.
+
+Upstream tracking issue: https://github.com/kata-containers/kata-containers/issues/1693.
+
+:::
+
+## Set the manifest
+
+Attest the Coordinator and set the manifest:
+
+```sh
+contrast set -c "${coordinator}:1313" resources/
+```
+
+After this step, the Coordinator will start issuing TLS certs to the workloads. The init container
+will fetch a certificate for the workload and the workload is started.
+
+## Verify the Coordinator
+
+An end user (data owner) can verify the Contrast deployment using the `verify` command.
+
+```sh
+contrast verify -c "${coordinator}:1313"
+```
+
+The CLI will attest the Coordinator using embedded reference values. The CLI will write the service mesh
+root certificate and the history of manifests into the `verify/` directory. In addition, the policies referenced
+in the manifest are also written to the directory.
+
+## Communicate with workloads
+
+You can securely connect to the workloads using the Coordinator's `mesh-root.pem` as a trusted CA certificate.
+First, expose the service on a public IP address via a LoadBalancer service:
+
+```sh
+kubectl patch svc ${MY_SERVICE} -p '{"spec": {"type": "LoadBalancer"}}'
+timeout 30s bash -c 'until kubectl get service/${MY_SERVICE} --output=jsonpath='{.status.loadBalancer}' | grep "ingress"; do sleep 2 ; done'
+lbip=$(kubectl get svc ${MY_SERVICE} -o=jsonpath='{.status.loadBalancer.ingress[0].ip}')
+echo $lbip
+```
+
+:::info[Subject alternative names and LoadBalancer IP]
+
+By default, mesh certificates are issued with a wildcard DNS entry. The web frontend is accessed
+via load balancer IP in this demo. Tools like curl check the certificate for IP entries in the SAN field.
+Validation fails since the certificate contains no IP entries as a subject alternative name (SAN).
+For example, a connection attempt using the curl and the mesh root certificate with throw the following error:
+
+```sh
+$ curl --cacert ./verify/mesh-root.pem "https://${frontendIP}:443"
+curl: (60) SSL: no alternative certificate subject name matches target host name '203.0.113.34'
+```
+
+:::
+
+Using `openssl`, the certificate of the service can be validated with the `mesh-root.pem`:
+
+```sh
+openssl s_client -CAfile verify/mesh-root.pem -verify_return_error -connect ${frontendIP}:443 < /dev/null
+```