Merge remote-tracking branch 'origin/main' into september-compose-update

Author: raphaeltm

docs/concepts/configuration.md

@@ -44,6 +44,24 @@ services:
 
 Use the `defang config` command of the Defang CLI to manage the values.
 
+## Interpolation
+
+Environment variables are set within the *environment* section of a service in a `compose.yaml` file. Any variables declared here will become available within the service container.
+
+Variables can be set by assigning a literal value, a reference to a configuration value, or a mix of literal and variable references. Variable references are declared using either **\$\{variable_name\}** or **$variable_name** forms. It is recommended to use the bracketed form. By interpolating over variable references within a string we can construct complex strings. Interpolation may be particularly useful when constructing connection strings to other services.
+
+```
+service:
+    environment:
+        - USER_PASSWORD // configuration variable
+        - USER_NAME     // configuration variable
+        - CONNECT=dbservice:${USER_NAME}:${USER_PASSWORD}@example.com:9876
+```
+In the example above, if we assume the value of the configuration variable ***USER_PASSWORD*** is *password* then the value assigned to ***CONNECT*** will resolve to *dbservice:alice:[email protected]:9876*
+
+
+During `defang compose up` all variable references will be replaced with the actual value and made available in the container. If any referenced variable is not found the `defang compose up` command will be canceled.
+
 ## Connecting Services
 
 If you have created a service before a secret you can connect it by running the `defang compose start` command if using the [`defang compose` workflow](./compose.md). If you are using the [Pulumi-based workflow](./pulumi.md) you will need to redeploy using Pulumi.
@@ -57,3 +75,5 @@ You can find a sample of how to set sensitive config values [here](https://githu
 Here are the different ways sensitive config values are stored depending on the provider you are using:
 
     * [AWS](../providers/aws/aws.md#secrets)
+
+

docs/concepts/generate.md

@@ -38,6 +38,10 @@ A simple next.js app that serves a static page
 A simple api with a single route built on express
 ```
 
+```
+An HTTP GET endpoint that returns an HTML with a random meme from the imgflip API
+```
+
 **An example of a more complex prompt**
 
 ```

docs/concepts/managed-storage/managed-object-storage.md

@@ -18,4 +18,4 @@ Managed Object Storage, like AWS S3, is a service that allows you to store and r
 | --- | --- |
 | [Playground](/docs/providers/playground.md) | ❌ |
 | [AWS](/docs/providers/aws/aws.md) | ❌ |
-
+| [DigitalOcean](/docs/providers/digital-ocean/digital-ocean.md) | ❌ |

docs/concepts/managed-storage/managed-postgres.md

@@ -14,6 +14,7 @@ Postgres, or PostgreSQL, is an advanced open-source relational database system k
 | --- | --- |
 | [Playground](/docs/providers/playground) | ❌ |
 | [AWS](/docs/providers/aws/aws.md#managed-postgres) | ✅ |
+| [DigitalOcean](/docs/providers/digital-ocean/digital-ocean.md) | ❌ |
 
 ## How to use Managed Postgres
 
@@ -44,10 +45,13 @@ You can connect to the managed Postgres instance using the name of your service
       POSTGRES_USER: postgres
       POSTGRES_DB: postgres
       // highlight-start
-      # Note: by leaving the value empty, Defang will use the 
+      # Note: by leaving the value empty, Defang will use the
       # value set using `defang config set POSTGRES_PASSWORD`
       POSTGRES_PASSWORD:
       // highlight-end
+      # Note: you can create a connection string by using interpolation,
+      # reference config variables by using ${<config name>}
+      CONNECTURL: postgresql://${POSTGRES_PASSWORD}@database:5432/postgres
   database:
     image: postgres:15
     x-defang-postgres: true
@@ -57,7 +61,7 @@ You can connect to the managed Postgres instance using the name of your service
         target: 5432
     environment:
       // highlight-start
-      # Note: by leaving the value empty, Defang will use the 
+      # Note: by leaving the value empty, Defang will use the
       # value set using `defang config set POSTGRES_PASSWORD`
       POSTGRES_PASSWORD:
       // highlight-end

docs/concepts/managed-storage/managed-redis.md

@@ -6,14 +6,15 @@ sidebar_position: 2000
 
 # Managed Redis
 
-Redis is an in-memory data structure store widely used for caching, real-time analytics, and session management due to its high performance, low latency, and support for various data types. Defang can help you provision a managed Redis instance. 
+Redis is an in-memory data structure store widely used for caching, real-time analytics, and session management due to its high performance, low latency, and support for various data types. Defang can help you provision a managed Redis instance.
 
 ## Current Support
 
 | Provider | Managed Redis |
 | --- | --- |
 | [Playground](/docs/providers/playground.md#managed-redis) | ❌ |
 | [AWS](/docs/providers/aws/aws.md#managed-redis) | ✅ |
+| [DigitalOcean](/docs/providers/digital-ocean/digital-ocean.md) | ❌ |
 
 ## How to use Managed Redis
 

docs/providers/digital-ocean/digital-ocean.md

@@ -1,11 +1,61 @@
 ---
-title: Digital Ocean
-description: Defang allows you to easily create and manage full, scalable applications with Digital Ocean.
-sidebar_position: 000
+title: DigitalOcean
+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 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/).  
+
+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 DigitalOcean 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 DigitalOcean, 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 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/). 
+
+### 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](/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!