Skip to content

Commit 96083f4

Browse files
rough provider tutorials
1 parent c7abd51 commit 96083f4

File tree

6 files changed

+156
-10
lines changed

6 files changed

+156
-10
lines changed

docs/getting-started/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ Congratulations! You've successfully deployed your first service with Defang. No
102102

103103
Defang supports various ways of creating and deploying services to the cloud. The following tutorials dive into each one in more detail:
104104

105+
1. [Deploy to your own cloud](/docs/tutorials/deploy-to-your-cloud)
105106
1. [Update the code and redeploy](/docs/getting-started/build-and-deploy)
106-
2. [Monitor your services](/docs/getting-started/monitor)
107-
3. [Deploy an outline using AI](/docs/tutorials/generate-new-code-using-ai)
108-
4. [Build and deploy your code](/docs/tutorials/deploy-code-compose)
109-
5. [Deploy existing containers](/docs/tutorials/deploy-container-using-the-cli)
110-
6. [Deploy using Pulumi](/docs/tutorials/deploy-using-pulumi)
107+
1. [Monitor your services](/docs/getting-started/monitor)
108+
1. [Deploy an outline using AI](/docs/tutorials/generate-new-code-using-ai)
109+
1. [Deploy existing containers](/docs/tutorials/deploy-container-using-the-cli)
110+
1. [Deploy using Pulumi](/docs/tutorials/deploy-using-pulumi)
111111

112112
Choose the direction that seems the most interesting. If you have any questions, join the [Defang Discord](https://discord.gg/defang) and we'll be happy to help you out.

docs/providers/digitalocean/digitalocean.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,33 @@ This feature is available for Public Preview as of October 2024. This page will
1313
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!
1414

1515
## Getting Started
16-
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/).
1716

18-
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`.
17+
### Install Defang
18+
19+
To get started with the Defang BYOC DigitalOcean Provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang).
20+
21+
### Sign up for DigitalOcean
22+
Next make sure you have signed up for a [DigitalOcean account](https://try.digitalocean.com/freetrialoffer/).
23+
24+
### Authenticate with DigitalOcean
25+
After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/). Defang will need to find this value in your shell as the `DIGITALOCEAN_TOKEN` environment variable.
26+
27+
### Authenticate with DigitalOcean Spaces
28+
You will also need a [Digital Ocean Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Defang will need to find this value in your shell as the `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY` environment variables.
29+
30+
### Configure your shell environment
1931

2032
```bash
2133
export DIGITALOCEAN_TOKEN=<your-token>
2234
export SPACES_ACCESS_KEY_ID=<your-key-id>
2335
export SPACES_SECRET_ACCESS_KEY=<your-key>
2436
```
2537

26-
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.
38+
The Defang CLI will automatically check if these envinonment variables are set before running.
39+
40+
### Deploy your project to DigitalOcean
41+
42+
Once you are ready to go, add the `--provider=digitalocean` to your command to tell the Defang CLI to use the DigitalOcean provider.
2743

2844
```bash
2945
$ defang up --provider=digitalocean
@@ -33,7 +49,7 @@ $ export DEFANG_PROVIDER=digitalocean
3349

3450
## Region
3551

36-
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).
52+
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).
3753

3854
## Architecture
3955

@@ -45,7 +61,7 @@ To deploy your services, the Defang CLI packages your code and uploads it to a [
4561

4662
### Runtime
4763

48-
The Provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/).
64+
The Provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/).
4965

5066
### Secrets
5167

docs/tutorials/deploy-to-aws.mdx

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Deploy to Amazon Web Services (AWS) with Defang
3+
description: Defang allows you deploy to your own Amazon Web Services (AWS) account.
4+
sidebar_position: 10
5+
---
6+
7+
# Deploying to Amazon Web Services (AWS) with Defang
8+
9+
This tutorial will show you how to deploy your services to your own AWS account using Defang.
10+
11+
## Pre-requisites
12+
* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
13+
* [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
14+
* [A Defang Account](/getting-started/authenticating)
15+
* [The Defang CLI](/getting-started/installing)
16+
* [AWS Account Credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html)
17+
18+
## Deploy your project to AWS
19+
20+
1. Navigate to the directory where your project is located:
21+
```bash
22+
$ cd path/to/your/project
23+
```
24+
25+
2. Authenticate Defang to use your AWS Account
26+
27+
Defang will look for your AWS credentials in your shell environment.
28+
29+
Defang will expect to find one of the following credential sets:
30+
* the `AWS_PROFILE` environment variable
31+
* or, the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
32+
33+
3. Deploy
34+
35+
Invoke the `defang up` CLI command with the `--provider=aws` flag or set the `DEFANG_PROVIDER=aws` environment variable.
36+
37+
For example:
38+
39+
```bash
40+
$ defang up --provider=aws
41+
```
42+
43+
4. Inspect your deployment
44+
45+
Defang will provision resources in your AWS account and deploy your services. You can inspect the resources created in your AWS dashboard.
46+
47+
***
48+
49+
For a deeper discussion of the Defang AWS Architecture, including a list of the resources we provision in your account, see our [AWS Provider docs](./providers/aws/aws).
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Deploy to Digital Ocean with Defang
3+
description: Defang allows you deploy to your own Digital Ocean account.
4+
sidebar_position: 10
5+
---
6+
7+
# Deploying to Digital Ocean with Defang
8+
9+
This tutorial will show you how to deploy your services to your own Digital Ocean account using Defang.
10+
11+
## Pre-requisites
12+
* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
13+
* [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
14+
* [A Defang Account](/getting-started/authenticating)
15+
* [The Defang CLI](/getting-started/installing)
16+
* [Digital Ocean Account Credentials](/providers/digitalocean#getting-started)
17+
* [Digital Ocean Spaces Access Keys](/providers/digitalocean#getting-started)
18+
19+
## Deploy your project to Digital Ocean
20+
21+
1. Navigate to the directory where your project is located:
22+
```bash
23+
$ cd path/to/your/project
24+
```
25+
26+
2. Authenticate Defang to use your Digital Ocean Account
27+
28+
Defang will look for your Digital Ocean credentials in your shell environment.
29+
30+
Defang will expect to find the following credentials:
31+
* the `DIGITALOCEAN_TOKEN` environment variable
32+
* and, the `SPACES_ACCESS_KEY_ID` and `SPACES_SECRET_ACCESS_KEY` environment variables
33+
34+
3. Deploy
35+
36+
Invoke the `defang up` CLI command with the `--provider=do` flag or set the `DEFANG_PROVIDER=do` environment variable.
37+
38+
For example:
39+
40+
```bash
41+
$ defang up --provider=do
42+
```
43+
44+
4. Inspect your deployment
45+
46+
Defang will provision resources in your Digital Ocean account and deploy your services. You can inspect the resources created in your Digital Ocean dashboard.
47+
48+
***
49+
50+
For a deeper discussion of the Defang Digital Ocean Architecture, see our [Digital Ocean Provider docs](./providers/digitalocean/digitalocean).

docs/tutorials/deploy-to-gcp.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Deploy to Google Cloud Platform (GCP) with Defang
3+
description: Defang allows you deploy to your own Google Cloud Platform (GCP) account.
4+
sidebar_position: 10
5+
---
6+
7+
# Deploying to Google Cloud Platform (GCP) with Defang
8+
9+
Coming soon!
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Deploy to your cloud with Defang
3+
description: Defang allows you deploy to your own cloud account.
4+
sidebar_position: 10
5+
---
6+
7+
# Deploying to your cloud with Defang
8+
9+
This tutorial will show you how to deploy your services to your own cloud account using Defang.
10+
11+
::: tip
12+
::: Defang makes it easier to deploy to any cloud—in your *own* cloud accounts. We refer to this as bring-your-own-cloud (BYOC).
13+
:::
14+
::: If you aren't ready to deploy to your own cloud account, you can use the Defang Playground to get a feel for how Defang works for free.
15+
16+
## Choose your cloud
17+
18+
The first step is to choose which cloud provider you want to deploy to. Defang supports the following cloud providers:
19+
20+
* [AWS](./tutorials/deploy-to-aws)
21+
* [DigitalOcean](./tutorials/deploy-to-digitalocean)
22+
* [GCP](./tutorials/deploy-to-gcp)

0 commit comments

Comments
 (0)