From 66f40ea813440052a28599480271a1fea84f09fa Mon Sep 17 00:00:00 2001 From: Kevin T Date: Sun, 22 Sep 2024 15:38:09 -0700 Subject: [PATCH 1/5] Add DO docs --- docs/providers/do.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/providers/do.md diff --git a/docs/providers/do.md b/docs/providers/do.md new file mode 100644 index 000000000..dc1fe2b78 --- /dev/null +++ b/docs/providers/do.md @@ -0,0 +1,39 @@ +--- +title: Digital Ocean +description: Defang allows you to easily create and manage full, scalable applications with Digital Ocean. +sidebar_position: 010 +--- + +# Digital Ocean + +:::info +This feature is still in preview as of August 2024. This page will be updated when it is GA. +::: + +Why should you use Defang with AWS? Defang allows you to easily create and manage full, scalable applications with Digital Ocean. Defang aims to make it easier to deploy your services to the cloud. Digital Ocean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the Digital Ocean ecosystem. Let Defang do it for you and spend more time working on whats important to you! + +## Getting Started +To get started with the Defang BYOC Digital Ocean rpvodier, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a Digital Ocean account. After signing up for your account, be sure to setup your [personal access token] (https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=do` to your command to tell the Defang CLI to use the AWS provider. + +## Region + +The Defang BYOC Digital Ocean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DO, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability). + +## Architecture + +Defang uses resources that are native to the cloud provider you are using. The following describes the current state of Defang's support for Digital Ocean, the specific resources that Defang uses, and the roadmap for future support. + +### Deployment + +To deploy your services, the Defang CLI packages your code and uploads it to a Spaces Object Store in your account. The CLI then deploys an App Platform Appp that uses Pulumi to build your container image and run your service. + +### Runtime + +The provider runs your workloads using the [Digital Ocean App Platform](https://docs.digitalocean.com/products/app-platform/). + +### Future Improvements + +The following features are still in development for Digital Ocean: +- [Custom Domains](../concepts/domains.mdx) +- [Managed Redis](../concepts/managed-storage.md#managed-redis) +Stayed tuned for future updates! From e749bb2592622246b195bceb713ec25da5cca14b Mon Sep 17 00:00:00 2001 From: Kevin T Date: Sun, 22 Sep 2024 15:40:06 -0700 Subject: [PATCH 2/5] update docs --- docs/providers/do.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/providers/do.md b/docs/providers/do.md index dc1fe2b78..afcf39527 100644 --- a/docs/providers/do.md +++ b/docs/providers/do.md @@ -13,7 +13,7 @@ This feature is still in preview as of August 2024. This page will be updated wh Why should you use Defang with AWS? Defang allows you to easily create and manage full, scalable applications with Digital Ocean. Defang aims to make it easier to deploy your services to the cloud. Digital Ocean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the Digital Ocean ecosystem. Let Defang do it for you and spend more time working on whats important to you! ## Getting Started -To get started with the Defang BYOC Digital Ocean rpvodier, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a Digital Ocean account. After signing up for your account, be sure to setup your [personal access token] (https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=do` to your command to tell the Defang CLI to use the AWS provider. +To get started with the Defang BYOC Digital Ocean rpvodier, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a Digital Ocean account. After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=do` to your command to tell the Defang CLI to use the AWS provider. ## Region From 2ce62f74fa33468248b4530a6db04af340c3c645 Mon Sep 17 00:00:00 2001 From: Kevin T Date: Sun, 22 Sep 2024 15:41:11 -0700 Subject: [PATCH 3/5] update docs --- docs/providers/do.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/providers/do.md b/docs/providers/do.md index afcf39527..d8f4de24f 100644 --- a/docs/providers/do.md +++ b/docs/providers/do.md @@ -13,7 +13,7 @@ This feature is still in preview as of August 2024. This page will be updated wh Why should you use Defang with AWS? Defang allows you to easily create and manage full, scalable applications with Digital Ocean. Defang aims to make it easier to deploy your services to the cloud. Digital Ocean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the Digital Ocean ecosystem. Let Defang do it for you and spend more time working on whats important to you! ## Getting Started -To get started with the Defang BYOC Digital Ocean rpvodier, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a Digital Ocean account. After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=do` to your command to tell the Defang CLI to use the AWS provider. +To get started with the Defang BYOC Digital Ocean provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a Digital Ocean account. After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=do` to your command to tell the Defang CLI to use the AWS provider. ## Region From d3f1ab8e90aba9dd4d57c03fd468b9badbee7515 Mon Sep 17 00:00:00 2001 From: Kevin T Date: Fri, 4 Oct 2024 18:59:20 -0700 Subject: [PATCH 4/5] update existing digitalocean docs --- docs/providers/digital-ocean/digital-ocean.md | 55 ++++++++++++++++++- docs/providers/do.md | 39 ------------- 2 files changed, 52 insertions(+), 42 deletions(-) delete mode 100644 docs/providers/do.md diff --git a/docs/providers/digital-ocean/digital-ocean.md b/docs/providers/digital-ocean/digital-ocean.md index 69d47e744..aae6adef6 100644 --- a/docs/providers/digital-ocean/digital-ocean.md +++ b/docs/providers/digital-ocean/digital-ocean.md @@ -1,11 +1,60 @@ --- title: Digital Ocean -description: Defang allows you to easily create and manage full, scalable applications with Digital Ocean. -sidebar_position: 000 +description: Defang allows you to easily create and manage full, scalable applications with DigitalOcean. +sidebar_position: 010 --- # Digital Ocean :::info -V1 Defang BYOC Digital Ocean Provider is in private beta as of September 2024. +This feature is available for public preview as of October 2024. This page will be updated when it is GA. ::: + +Why should you use Defang with AWS? Defang allows you to easily create and manage full, scalable applications with DigitalOcean. Defang aims to make it easier to deploy your services to the cloud. DigitalOcean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the DigitalOcean ecosystem. Let Defang do it for you and spend more time working on whats important to you! + +## Getting Started +To get started with the Defang BYOC DigitalOcean provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a [DigitalOcean account](https://try.digitalocean.com/freetrialoffer/). + +After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. + +```bash +export DIGITALOCEAN_TOKEN= +export SPACES_ACCESS_KEY_ID= +export SPACES_SECRET_ACCESS_KEY= +``` + +The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=digitalocean` to your command to tell the Defang CLI to use the AWS provider. + +```bash +$ defang up --provider=digitalocean +# or +$ export DEFANG_PROVIDER=digitalocean +``` + +## Region + +The Defang BYOC DigitalOcean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DO, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability). + +## Architecture + +Defang uses resources that are native to the cloud provider you are using. The following describes the current state of Defang's support for DigitalOcean, the specific resources that Defang uses, and the roadmap for future support. + +### Deployment + +To deploy your services, the Defang CLI packages your code and uploads it to a [Spaces Object Storage](https://www.digitalocean.com/products/spaces) bucket in your account. The CLI then deploys an App Platform Appp that uses Pulumi to build your container image and run your service. + +### Runtime + +The provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/). + +### Secrets + +Defang allows you to configure your services with sensitive config values. Sensitive values are added and stored with [encryption](https://docs.digitalocean.com/products/app-platform/how-to/use-environment-variables/) in your app once it has been deployed. + +### Future Improvements + +The following features are still in development for DigitalOcean: +- [Custom Domains](../concepts/domains.mdx) +- [Managed Redis](../concepts/managed-storage.md#managed-redis) + +Stayed tuned for future updates! diff --git a/docs/providers/do.md b/docs/providers/do.md deleted file mode 100644 index d8f4de24f..000000000 --- a/docs/providers/do.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Digital Ocean -description: Defang allows you to easily create and manage full, scalable applications with Digital Ocean. -sidebar_position: 010 ---- - -# Digital Ocean - -:::info -This feature is still in preview as of August 2024. This page will be updated when it is GA. -::: - -Why should you use Defang with AWS? Defang allows you to easily create and manage full, scalable applications with Digital Ocean. Defang aims to make it easier to deploy your services to the cloud. Digital Ocean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the Digital Ocean ecosystem. Let Defang do it for you and spend more time working on whats important to you! - -## Getting Started -To get started with the Defang BYOC Digital Ocean provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a Digital Ocean account. After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=do` to your command to tell the Defang CLI to use the AWS provider. - -## Region - -The Defang BYOC Digital Ocean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DO, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability). - -## Architecture - -Defang uses resources that are native to the cloud provider you are using. The following describes the current state of Defang's support for Digital Ocean, the specific resources that Defang uses, and the roadmap for future support. - -### Deployment - -To deploy your services, the Defang CLI packages your code and uploads it to a Spaces Object Store in your account. The CLI then deploys an App Platform Appp that uses Pulumi to build your container image and run your service. - -### Runtime - -The provider runs your workloads using the [Digital Ocean App Platform](https://docs.digitalocean.com/products/app-platform/). - -### Future Improvements - -The following features are still in development for Digital Ocean: -- [Custom Domains](../concepts/domains.mdx) -- [Managed Redis](../concepts/managed-storage.md#managed-redis) -Stayed tuned for future updates! From 3be442d932e753f84485da1d47e52a491ef83245 Mon Sep 17 00:00:00 2001 From: Kevin T Date: Fri, 4 Oct 2024 21:43:15 -0700 Subject: [PATCH 5/5] address PR comments --- docs/providers/digital-ocean/digital-ocean.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/providers/digital-ocean/digital-ocean.md b/docs/providers/digital-ocean/digital-ocean.md index aae6adef6..1170d5736 100644 --- a/docs/providers/digital-ocean/digital-ocean.md +++ b/docs/providers/digital-ocean/digital-ocean.md @@ -1,5 +1,5 @@ --- -title: Digital Ocean +title: DigitalOcean description: Defang allows you to easily create and manage full, scalable applications with DigitalOcean. sidebar_position: 010 --- @@ -7,13 +7,13 @@ sidebar_position: 010 # Digital Ocean :::info -This feature is available for public preview as of October 2024. This page will be updated when it is GA. +This feature is available for Public Preview as of October 2024. This page will be updated when it is GA. ::: -Why should you use Defang with AWS? Defang allows you to easily create and manage full, scalable applications with DigitalOcean. Defang aims to make it easier to deploy your services to the cloud. DigitalOcean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the DigitalOcean ecosystem. Let Defang do it for you and spend more time working on whats important to you! +Why should you use Defang with DigitalOcean? Defang allows you to easily create and manage full, scalable applications with DigitalOcean. Defang aims to make it easier to deploy your services to the cloud. DigitalOcean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the DigitalOcean platform. Let Defang do it for you and spend more time working on whats important to you! ## Getting Started -To get started with the Defang BYOC DigitalOcean provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a [DigitalOcean account](https://try.digitalocean.com/freetrialoffer/). +To get started with the Defang BYOC DigitalOcean Provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a [DigitalOcean account](https://try.digitalocean.com/freetrialoffer/). After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. @@ -23,7 +23,7 @@ export SPACES_ACCESS_KEY_ID= export SPACES_SECRET_ACCESS_KEY= ``` -The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=digitalocean` to your command to tell the Defang CLI to use the AWS provider. +The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=digitalocean` to your command to tell the Defang CLI to use the DigitalOcean provider. ```bash $ defang up --provider=digitalocean @@ -33,7 +33,7 @@ $ export DEFANG_PROVIDER=digitalocean ## Region -The Defang BYOC DigitalOcean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DO, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability). +The Defang BYOC DigitalOcean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DigitalOcean, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability). ## Architecture @@ -41,11 +41,11 @@ Defang uses resources that are native to the cloud provider you are using. The f ### Deployment -To deploy your services, the Defang CLI packages your code and uploads it to a [Spaces Object Storage](https://www.digitalocean.com/products/spaces) bucket in your account. The CLI then deploys an App Platform Appp that uses Pulumi to build your container image and run your service. +To deploy your services, the Defang CLI packages your code and uploads it to a [Spaces Object Storage](https://www.digitalocean.com/products/spaces) bucket in your account. The CLI then deploys an App Platform App that uses Pulumi to build your container image and run your service. ### Runtime -The provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/). +The Provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/). ### Secrets @@ -54,7 +54,8 @@ Defang allows you to configure your services with sensitive config values. Sensi ### Future Improvements The following features are still in development for DigitalOcean: -- [Custom Domains](../concepts/domains.mdx) -- [Managed Redis](../concepts/managed-storage.md#managed-redis) +- [Custom Domains](/docs/concepts//domains.mdx) +- [Managed Redis](/docs/concepts//managed-storage/managed-redis.md) +- [Managed Postgres](/docs/concepts/managed-storage/managed-postgres.md) Stayed tuned for future updates!