Skip to content

Commit 68e93b8

Browse files
committed
Update secrets doc
1 parent 104fa85 commit 68e93b8

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

content/docs/Applications/Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ A star, like `PROD*` in the `app list` output indicates that there are staged ch
120120

121121
By default, apps are created with the no authentication type. `system` auth uses `admin` as the username. The password is displayed on the screen during the initial setup of the OpenRun server config.
122122

123-
To change app auth type, add `--auth system` to the `app create` command. After an app is created, the auth type can be changed by running `app update auth system /myapp`. OAuth based authentication is also supported, see [authentication]({{< ref "docs/configuration/authentication" >}}) for details.
123+
To change app auth type, add `--auth system` to the `app create` command. After an app is created, the auth type can be changed by running `app update auth --promote system /myapp`. OAuth based authentication is also supported, see [authentication]({{< ref "docs/configuration/authentication" >}}) for details.
124124

125125
{{<callout type="warning" >}}
126126
Changes done to the app settings using the `app settings` command are **NOT** staged or versioned, they apply immediately to the stage/prod/preview apps.

content/docs/Configuration/Secrets.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ OpenRun supports secret management when working with apps. Secrets can be passed
88

99
## Supported Providers
1010

11-
OpenRun currently supports AWS Secrets Manager (ASM), AWS SSM and HashiCorp Vault as providers for secrets management. Secrets can also be read from the environment of the OpenRun server, which can be used in development and testing. Secrets can also be read from a local properties file.
11+
OpenRun currently supports AWS Secrets Manager (ASM), AWS Systems Manager (SSM) and HashiCorp Vault as providers for secrets management. Secrets can also be read from the environment of the OpenRun server, which can be used in development and testing. Secrets can also be read from a local properties file.
1212

13-
## AWS Secrets Manager
13+
### AWS Secrets Manager
1414

1515
To enable ASM, add one or more entries in the `openrun.toml` config. The config name should be `asm` or should start with `asm_`. For example
1616

@@ -26,7 +26,7 @@ creates two ASM configs. `asm` uses the default profile and `asm_prod` uses the
2626

2727
To access a secret in app parameters from `asm_prod` config, use `--param MYPARAM='{{secret_from "asm_prod" "MY_SECRET_KEY"}}'` as the param value. Use `--param MYPARAM='{{secret "MY_SECRET_KEY"}}'` to read from the default provider.
2828

29-
## AWS Systems Manager (SSM)
29+
### AWS Systems Manager (SSM)
3030

3131
To enable SSM, add one or more entries in the `openrun.toml` config. The config name should be `ssm` or should start with `ssm_`. For example
3232

@@ -42,7 +42,7 @@ creates two SSM configs. `ssm` uses the default profile and `ssm_prod` uses the
4242

4343
To access a secret in app parameters from `ssm_prod` config, use `--param MYPARAM='{{secret_from "ssm_prod" "MY_SECRET_KEY"}}'` as the param value. Use `--param MYPARAM='{{secret "MY_SECRET_KEY"}}'` to read from the default provider.
4444

45-
## HashiCorp Vault
45+
### HashiCorp Vault
4646

4747
To enable Vault secret provider, add one or more entries in the `openrun.toml` config. The config name should be `vault` or should start with `vault_`. For example
4848

@@ -58,7 +58,7 @@ token = "def"
5858

5959
creates two Vault configs. The `address` and `token` properties are required.
6060

61-
## Environment Secrets
61+
### Environment Secrets
6262

6363
Adding a secret provider with the name `env` or starting with `env_`, like
6464

@@ -68,7 +68,7 @@ Adding a secret provider with the name `env` or starting with `env_`, like
6868

6969
enables looking up the OpenRun server environment for secrets. This can be accessed like `--param MYPARAM='{{secret_from "env" "MY_SECRET_KEY"}}'`. No properties are required in the env provider config. The value of MY_SECRET_KEY in the OpenRun server env wil be passed as the param.
7070

71-
## Properties Secrets
71+
### Properties Secrets
7272

7373
Secrets can be read from a properties file. The config name should be `prop` or should start with `prop_`. To use this, add
7474

0 commit comments

Comments
 (0)