Skip to content

Commit d35413e

Browse files
author
Quentin Brosse
authored
doc(config): add project_id (#543)
1 parent c0ce17a commit d35413e

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

‎scw/README.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@
55
Recommended config file:
66

77
```yaml
8-
# get your credentials on https://console.scaleway.com/account/credentials
8+
# Get your credentials on https://console.scaleway.com/account/credentials
99
access_key: SCWXXXXXXXXXXXXXXXXX
1010
secret_key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
1111
default_organization_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
12+
default_project_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
1213
default_region: fr-par
1314
default_zone: fr-par-1
1415
```
@@ -20,7 +21,7 @@ The function [`GetConfigPath`](https://godoc.org/github.com/scaleway/scaleway-sd
2021
1. Custom directory: `$SCW_CONFIG_PATH`
2122
2. [XDG base directory](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html): `$XDG_CONFIG_HOME/scw/config.yaml`
2223
3. Unix home directory: `$HOME/.config/scw/config.yaml`
23-
3. Windows home directory: `%USERPROFILE%/.config/scw/config.yaml`
24+
4. Windows home directory: `%USERPROFILE%/.config/scw/config.yaml`
2425

2526
## V1 config (DEPRECATED)
2627

@@ -43,13 +44,14 @@ scw.NewClient(
4344

4445
## Environment variables
4546

46-
| Variable | Description | Legacy variables |
47-
| :------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ |
48-
| `$SCW_ACCESS_KEY` | Access key of a token ([get yours](https://console.scaleway.com/account/credentials)) | `$SCALEWAY_ACCESS_KEY` (used by terraform) |
49-
| `$SCW_SECRET_KEY` | Secret key of a token ([get yours](https://console.scaleway.com/account/credentials)) | `$SCW_TOKEN` (used by cli), `$SCALEWAY_TOKEN` (used by terraform), `$SCALEWAY_ACCESS_KEY` (used by terraform) |
50-
| `$SCW_DEFAULT_ORGANIZATION_ID` | Your default organization ID, if you don't have one use your organization ID ([get yours](https://console.scaleway.com/account/credentials)) | `$SCW_ORGANIZATION` (used by cli),`$SCALEWAY_ORGANIZATION` (used by terraform) |
51-
| `$SCW_DEFAULT_REGION` | Your default [region](https://developers.scaleway.com/en/quickstart/#region-and-zone) | `$SCW_REGION` (used by cli),`$SCALEWAY_REGION` (used by terraform) |
52-
| `$SCW_DEFAULT_ZONE` | Your default [availability zone](https://developers.scaleway.com/en/quickstart/#region-and-zone) | `$SCW_ZONE` (used by cli),`$SCALEWAY_ZONE` (used by terraform) |
53-
| `$SCW_API_URL` | Url of the API | - |
54-
| `$SCW_INSECURE` | Set this to `true` to enable the insecure mode | `$SCW_TLSVERIFY` (inverse flag used by the cli) |
55-
| `$SCW_PROFILE` | Set the config profile to use | - |
47+
| Variable | Description | Legacy variables |
48+
| :----------------------------- | :----------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ |
49+
| `$SCW_ACCESS_KEY` | Access key of a token ([get yours](https://console.scaleway.com/account/credentials)) | `$SCALEWAY_ACCESS_KEY` (used by terraform) |
50+
| `$SCW_SECRET_KEY` | Secret key of a token ([get yours](https://console.scaleway.com/account/credentials)) | `$SCW_TOKEN` (used by cli), `$SCALEWAY_TOKEN` (used by terraform), `$SCALEWAY_ACCESS_KEY` (used by terraform) |
51+
| `$SCW_DEFAULT_ORGANIZATION_ID` | Your default organization ID ([get yours](https://console.scaleway.com/account/credentials)) | `$SCW_ORGANIZATION` (used by cli),`$SCALEWAY_ORGANIZATION` (used by terraform) |
52+
| `$SCW_DEFAULT_PROJECT_ID` | Your default project ID ([get yours](https://console.scaleway.com/account/credentials)) | |
53+
| `$SCW_DEFAULT_REGION` | Your default [region](https://developers.scaleway.com/en/quickstart/#region-and-zone) | `$SCW_REGION` (used by cli),`$SCALEWAY_REGION` (used by terraform) |
54+
| `$SCW_DEFAULT_ZONE` | Your default [availability zone](https://developers.scaleway.com/en/quickstart/#region-and-zone) | `$SCW_ZONE` (used by cli),`$SCALEWAY_ZONE` (used by terraform) |
55+
| `$SCW_API_URL` | Url of the API | - |
56+
| `$SCW_INSECURE` | Set this to `true` to enable the insecure mode | `$SCW_TLSVERIFY` (inverse flag used by the cli) |
57+
| `$SCW_PROFILE` | Set the config profile to use | - |

0 commit comments

Comments
 (0)