-
Notifications
You must be signed in to change notification settings - Fork 6
Add DO docs #96
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Add DO docs #96
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
66f40ea
Add DO docs
kt5356 e749bb2
update docs
kt5356 2ce62f7
update docs
kt5356 4fe36af
Merge branch 'main' of https://github.com/DefangLabs/defang-docs into…
kt5356 d3f1ab8
update existing digitalocean docs
kt5356 3be442d
address PR comments
kt5356 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
::: | ||
|
||
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! | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 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/). | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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=<your-token> | ||
export SPACES_ACCESS_KEY_ID=<your-key-id> | ||
export SPACES_SECRET_ACCESS_KEY=<your-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. | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```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). | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 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. | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
### Runtime | ||
|
||
The provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/). | ||
kt5356 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
### 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) | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need to add Managed Postgres the list |
||
Stayed tuned for future updates! |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be DigitalOcean