diff --git a/docs/docs/basics/confidential-containers.md b/docs/docs/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/docs/basics/confidential-containers.md +++ b/docs/docs/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/docs/deployment.md b/docs/docs/deployment.md index f6b7da0a47..28f8faa94f 100644 --- a/docs/docs/deployment.md +++ b/docs/docs/deployment.md @@ -7,11 +7,11 @@ 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 up a cluster on AKS. - -A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare metal cluster. + +A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare-metal cluster. - -A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare metal cluster. + +A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare-metal cluster. @@ -29,12 +29,12 @@ It can be shared between Contrast deployments. kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/runtime-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/runtime-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/runtime-k3s-qemu-tdx.yml ``` @@ -52,12 +52,12 @@ LoadBalancer service, into your cluster. kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/coordinator-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/coordinator-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/coordinator-k3s-qemu-tdx.yml ``` @@ -207,22 +207,22 @@ A `manifest.json` with the reference values of your deployment will be created. contrast generate --reference-values aks-clh-snp resources/ ``` - + ```sh contrast generate --reference-values k3s-qemu-snp resources/ ``` :::note[Missing TCB values] -On bare metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. +On bare-metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `{"BootloaderVersion":255,"TEEVersion":255,"SNPVersion":255,"MicrocodeVersion":255}` and observe the real values in the error messages in the following steps. This should only be done in a secure environment. Note that the values will differ between CPU models. ::: - + ```sh contrast generate --reference-values k3s-qemu-tdx resources/ ``` :::note[Missing TCB values] -On bare metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. +On bare-metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `ffffffffffffffffffffffffffffffff` and `000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000` respectively and observe the real values in the error messages in the following steps. This should only be done in a secure environment. ::: @@ -249,12 +249,12 @@ You can disable the Initializer injection completely by specifying the contrast generate --reference-values aks-clh-snp --skip-initializer resources/ ``` - + ```sh contrast generate --reference-values k3s-qemu-snp --skip-initializer resources/ ``` - + ```sh contrast generate --reference-values k3s-qemu-tdx --skip-initializer resources/ ``` diff --git a/docs/docs/examples/emojivoto.md b/docs/docs/examples/emojivoto.md index 6ad06943b2..d7e1784f85 100644 --- a/docs/docs/examples/emojivoto.md +++ b/docs/docs/examples/emojivoto.md @@ -50,12 +50,12 @@ It can be shared between Contrast deployments. kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/runtime-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/runtime-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/runtime-k3s-qemu-tdx.yml ``` @@ -73,12 +73,12 @@ LoadBalancer service, into your cluster: kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/coordinator-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/coordinator-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/latest/download/coordinator-k3s-qemu-tdx.yml ``` @@ -97,22 +97,22 @@ of your deployment will be created: contrast generate --reference-values aks-clh-snp deployment/ ``` - + ```sh contrast generate --reference-values k3s-qemu-snp deployment/ ``` :::note[Missing TCB values] -On bare metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. +On bare-metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `{"BootloaderVersion":255,"TEEVersion":255,"SNPVersion":255,"MicrocodeVersion":255}` and observe the real values in the error messages in the following steps. This should only be done in a secure environment. Note that the values will differ between CPU models. ::: - + ```sh contrast generate --reference-values k3s-qemu-tdx deployment/ ``` :::note[Missing TCB values] -On bare metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. +On bare-metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `ffffffffffffffffffffffffffffffff` and `000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000` respectively and observe the real values in the error messages in the following steps. This should only be done in a secure environment. ::: diff --git a/docs/docs/getting-started/bare-metal.md b/docs/docs/getting-started/bare-metal.md index bd48bc8571..e5908fe336 100644 --- a/docs/docs/getting-started/bare-metal.md +++ b/docs/docs/getting-started/bare-metal.md @@ -1,4 +1,4 @@ -# Prepare a bare metal instance +# Prepare a bare-metal instance ## Hardware and firmware setup diff --git a/docs/versioned_docs/version-0.5/basics/confidential-containers.md b/docs/versioned_docs/version-0.5/basics/confidential-containers.md index 0fe550d5b3..21ab3f01cd 100644 --- a/docs/versioned_docs/version-0.5/basics/confidential-containers.md +++ b/docs/versioned_docs/version-0.5/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [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. +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. diff --git a/docs/versioned_docs/version-0.6/basics/confidential-containers.md b/docs/versioned_docs/version-0.6/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/versioned_docs/version-0.6/basics/confidential-containers.md +++ b/docs/versioned_docs/version-0.6/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/versioned_docs/version-0.7/basics/confidential-containers.md b/docs/versioned_docs/version-0.7/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/versioned_docs/version-0.7/basics/confidential-containers.md +++ b/docs/versioned_docs/version-0.7/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/versioned_docs/version-0.8/basics/confidential-containers.md b/docs/versioned_docs/version-0.8/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/versioned_docs/version-0.8/basics/confidential-containers.md +++ b/docs/versioned_docs/version-0.8/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/versioned_docs/version-0.9/basics/confidential-containers.md b/docs/versioned_docs/version-0.9/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/versioned_docs/version-0.9/basics/confidential-containers.md +++ b/docs/versioned_docs/version-0.9/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/versioned_docs/version-1.0/basics/confidential-containers.md b/docs/versioned_docs/version-1.0/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/versioned_docs/version-1.0/basics/confidential-containers.md +++ b/docs/versioned_docs/version-1.0/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/versioned_docs/version-1.1/basics/confidential-containers.md b/docs/versioned_docs/version-1.1/basics/confidential-containers.md index ecea0e35d3..6f3f48f5bb 100644 --- a/docs/versioned_docs/version-1.1/basics/confidential-containers.md +++ b/docs/versioned_docs/version-1.1/basics/confidential-containers.md @@ -16,7 +16,7 @@ In CoCo's case, the runtime is Kata Containers with added confidential computing [Kata Containers](https://katacontainers.io/) is an OCI runtime that runs pods in VMs. The pod 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. +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. diff --git a/docs/versioned_docs/version-1.1/deployment.md b/docs/versioned_docs/version-1.1/deployment.md index 4d278b0b78..aac2b57c25 100644 --- a/docs/versioned_docs/version-1.1/deployment.md +++ b/docs/versioned_docs/version-1.1/deployment.md @@ -7,11 +7,11 @@ 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 up a cluster on AKS. - -A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare metal cluster. + +A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare-metal cluster. - -A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare metal cluster. + +A running CoCo-enabled cluster is required for these steps, see the [setup guide](./getting-started/bare-metal.md) on how to set up a bare-metal cluster. @@ -29,12 +29,12 @@ It can be shared between Contrast deployments. kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/runtime-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/runtime-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/runtime-k3s-qemu-tdx.yml ``` @@ -52,12 +52,12 @@ LoadBalancer service, into your cluster. kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/coordinator-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/coordinator-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/coordinator-k3s-qemu-tdx.yml ``` @@ -207,22 +207,22 @@ A `manifest.json` with the reference values of your deployment will be created. contrast generate --reference-values aks-clh-snp resources/ ``` - + ```sh contrast generate --reference-values k3s-qemu-snp resources/ ``` :::note[Missing TCB values] -On bare metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. +On bare-metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `{"BootloaderVersion":255,"TEEVersion":255,"SNPVersion":255,"MicrocodeVersion":255}` and observe the real values in the error messages in the following steps. This should only be done in a secure environment. Note that the values will differ between CPU models. ::: - + ```sh contrast generate --reference-values k3s-qemu-tdx resources/ ``` :::note[Missing TCB values] -On bare metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. +On bare-metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `ffffffffffffffffffffffffffffffff` and `000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000` respectively and observe the real values in the error messages in the following steps. This should only be done in a secure environment. ::: @@ -249,12 +249,12 @@ You can disable the Initializer injection completely by specifying the contrast generate --reference-values aks-clh-snp --skip-initializer resources/ ``` - + ```sh contrast generate --reference-values k3s-qemu-snp --skip-initializer resources/ ``` - + ```sh contrast generate --reference-values k3s-qemu-tdx --skip-initializer resources/ ``` diff --git a/docs/versioned_docs/version-1.1/examples/emojivoto.md b/docs/versioned_docs/version-1.1/examples/emojivoto.md index 8b73169f02..2f8ec22f88 100644 --- a/docs/versioned_docs/version-1.1/examples/emojivoto.md +++ b/docs/versioned_docs/version-1.1/examples/emojivoto.md @@ -50,12 +50,12 @@ It can be shared between Contrast deployments. kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/runtime-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/runtime-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/runtime-k3s-qemu-tdx.yml ``` @@ -73,12 +73,12 @@ LoadBalancer service, into your cluster: kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/coordinator-aks-clh-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/coordinator-k3s-qemu-snp.yml ``` - + ```sh kubectl apply -f https://github.com/edgelesssys/contrast/releases/download/v1.1.0/coordinator-k3s-qemu-tdx.yml ``` @@ -97,22 +97,22 @@ of your deployment will be created: contrast generate --reference-values aks-clh-snp deployment/ ``` - + ```sh contrast generate --reference-values k3s-qemu-snp deployment/ ``` :::note[Missing TCB values] -On bare metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. +On bare-metal SEV-SNP, `contrast generate` is unable to fill in the `MinimumTCB` values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `{"BootloaderVersion":255,"TEEVersion":255,"SNPVersion":255,"MicrocodeVersion":255}` and observe the real values in the error messages in the following steps. This should only be done in a secure environment. Note that the values will differ between CPU models. ::: - + ```sh contrast generate --reference-values k3s-qemu-tdx deployment/ ``` :::note[Missing TCB values] -On bare metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. +On bare-metal TDX, `contrast generate` is unable to fill in the `MinimumTeeTcbSvn` and `MrSeam` TCB values as they can vary between platforms. They will have to be filled in manually. If you don't know the correct values use `ffffffffffffffffffffffffffffffff` and `000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000` respectively and observe the real values in the error messages in the following steps. This should only be done in a secure environment. ::: diff --git a/docs/versioned_docs/version-1.1/getting-started/bare-metal.md b/docs/versioned_docs/version-1.1/getting-started/bare-metal.md index bd48bc8571..e5908fe336 100644 --- a/docs/versioned_docs/version-1.1/getting-started/bare-metal.md +++ b/docs/versioned_docs/version-1.1/getting-started/bare-metal.md @@ -1,4 +1,4 @@ -# Prepare a bare metal instance +# Prepare a bare-metal instance ## Hardware and firmware setup