diff --git a/dev-docs/workflows/marketplace-images.md b/dev-docs/workflows/marketplace-images.md deleted file mode 100644 index 5fa2b530f..000000000 --- a/dev-docs/workflows/marketplace-images.md +++ /dev/null @@ -1,36 +0,0 @@ -# Using Marketplace Images in Constellation - -This document explains the steps a user needs to take to run Constellation with dynamic billing via the cloud marketplaces. - -## AWS - -Marketplace Images on AWS are not available yet. - -## Azure - -On Azure, to use a marketplace image, ensure that the subscription has accepted the agreement to use marketplace images: - -```bash -az vm image terms accept --publisher edgelesssystems --offer constellation --plan constellation -``` - -Then, set the VMs to use the marketplace image in the `constellation-conf.yaml` file: - -```bash -yq eval -i ".provider.azure.useMarketplaceImage = true" constellation-conf.yaml -``` - -And ensure that the cluster uses a release image (i.e. `.image=vX.Y.Z` in the `constellation-conf.yaml` file). Afterwards, proceed with the cluster creation as usual. - -## GCP - -On GCP, to use a marketplace image, ensure that the account is entitled to use marketplace images by Edgeless Systems -by accepting the terms through the [web portal](https://console.cloud.google.com/marketplace/vm/config/edgeless-systems-public/constellation). - -Then, set the VMs to use the marketplace image in the `constellation-conf.yaml` file: - -```bash -yq eval -i ".provider.gcp.useMarketplaceImage = true" constellation-conf.yaml -``` - -And ensure that the cluster uses a release image (i.e. `.image=vX.Y.Z` in the `constellation-conf.yaml` file). Afterwards, proceed with the cluster creation as usual. diff --git a/docs/docs/getting-started/marketplaces.md b/docs/docs/getting-started/marketplaces.md new file mode 100644 index 000000000..8e730ce1f --- /dev/null +++ b/docs/docs/getting-started/marketplaces.md @@ -0,0 +1,38 @@ +# Using Constellation via Cloud Marketplaces + +Constellation is available through the Marketplaces of Azure and GCP. This allows you to create self-managed Constellation clusters that are billed on a pay-per-use basis (hourly, per vCPU) with your CSP account. You can still get direct support by Edgeless Systems. For more information, please [contact us](https://www.edgeless.systems/enterprise-support/). + +This document explains how to run Constellation with the dynamically billed cloud marketplace images. + +## Azure + +On Azure, Constellation has a private marketplace plan. Please [contact us](https://www.edgeless.systems/enterprise-support/) directly to gain access. +To use a marketplace image, you need to accept the marketplace image's terms once for your subscription with the [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/vm/image/terms?view=azure-cli-latest): + +```bash +az vm image terms accept --publisher edgelesssystems --offer constellation --plan constellation +``` + +Then, enable the use of marketplace images in your Constellation `constellation-conf.yaml` [config file](../workflows/config.md): + +```bash +yq eval -i ".provider.azure.useMarketplaceImage = true" constellation-conf.yaml +``` + +Ensure that the cluster uses an official release image version (i.e., `.image=vX.Y.Z` in the `constellation-conf.yaml` file). + +From there, you can proceed with the [cluster creation](../workflows/create.md) as usual. + +## GCP + +On GCP, to use a marketplace image, ensure that the account is entitled to use marketplace images by Edgeless Systems by accepting the terms through the [web portal](https://console.cloud.google.com/marketplace/vm/config/edgeless-systems-public/constellation). + +Then, enable the use of marketplace images in your Constellation `constellation-conf.yaml` [config file](../workflows/config.md): + +```bash +yq eval -i ".provider.gcp.useMarketplaceImage = true" constellation-conf.yaml +``` + +Ensure that the cluster uses an official release image version (i.e., `.image=vX.Y.Z` in the `constellation-conf.yaml` file). + +From there, you can proceed with the [cluster creation](../workflows/create.md) as usual. diff --git a/docs/sidebars.js b/docs/sidebars.js index 0fa18bd97..67f3de87b 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -96,6 +96,11 @@ const sidebars = { label: 'First steps (local)', id: 'getting-started/first-steps-local', }, + { + type: 'doc', + label: 'Cloud Marketplaces', + id: 'getting-started/marketplaces', + }, { type: 'category', label: 'Examples',