Skip to content

Commit 54df27c

Browse files
committed
update compose/config page to not use "secrets"
1 parent 4505327 commit 54df27c

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

docs/concepts/compose.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,21 @@ One thing to keep in mind is that, at the time of this writing, Defang identifie
2020

2121
## Configuration
2222

23-
If you have a service that depends on a secret like an api key, you can set that [secret](./configuration.md) using the CLI:
23+
If you have a service that depends on a [config value](./configuration.md) (such as an API key), you can set it using the CLI:
2424

2525
```
26-
defang config set --name MY_API_KEY
26+
defang config set MY_API_KEY
2727
```
2828

2929
and then connect it to the service by specifying it in the `compose.yaml`:
3030

3131
```yaml
3232
services:
3333
my-service:
34-
secrets:
34+
environment:
3535
- MY_API_KEY
36-
37-
secrets:
38-
MY_API_KEY:
39-
external: true
4036
```
4137
42-
:::info Configuration & Secrets
43-
Read more about configuration in the [configuration page](./configuration.md).
38+
:::info
39+
Read more about configuration in the [Configuration page](./configuration.md).
4440
:::

docs/concepts/configuration.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 225
88

99
Defang allows you to configure your application using environment variables. You can set environment variables in your [`compose.yaml` file](./compose.md), or in your [Pulumi program](#using-config-with-pulumi).
1010

11-
# Sensitive Config (aka Secrets)
11+
# Sensitive Config Values
1212

1313
The Defang CLI allows you to securely store sensitive information such as API keys, passwords, and other credentials. To do so, run:
1414

@@ -47,7 +47,7 @@ You can find a sample of how to set sensitive config values [here](https://githu
4747

4848
## Interpolation
4949

50-
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.
50+
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.
5151

5252
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.
5353

@@ -82,5 +82,6 @@ Here are the different ways sensitive config values are stored depending on the
8282
* [DigitalOcean](../providers/digitalocean#secrets)
8383
* [GCP](../providers/gcp#secrets)
8484
85-
86-
85+
:::info
86+
Please note that while Defang supports setting sensitive config, it does not support the [`secrets`](https://docs.docker.com/reference/compose-file/secrets/) top-level element as seen in the Compose specification. Please see our [Compose Support](/docs/concepts/compose-support) page for more details.
87+
:::

0 commit comments

Comments
 (0)