Skip to content

Commit 815ff11

Browse files
LagojaLucilleH
andauthored
[Docs] Move cloud docs to main docs (#2049)
## Summary First draft of cloud docs. Collects all the features currently under the jetify cloud docs, and moves them into the devbox docs ## How was it tested? Localhost + `npm run build` to check for broken links --------- Signed-off-by: John Lago <[email protected]> Co-authored-by: Lucille Hua <[email protected]>
1 parent 5326d5b commit 815ff11

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+1263
-21
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# devbox cache
2+
3+
A collection of commands to interact with the Jetify Cache or other Nix caches.
4+
5+
```bash
6+
devbox cache [command]
7+
```
8+
9+
## Subcommands
10+
info Output information about the nix cache
11+
upload upload specified or nix packages in current project to cache
12+
13+
## Options
14+
| Option | Description |
15+
| --- | --- |
16+
| `-h, --help` | help for cache |
17+
| `-q, --quiet` | suppresses logs |
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# devbox cache configure
2+
3+
Configure Nix to use the Devbox cache as a substituter.
4+
5+
If the current Nix installation is multi-user, this command grants the Nix
6+
daemon access to Devbox caches by making the following changes:
7+
8+
- Adds the current user to Nix's list of trusted users in the system nix.conf.
9+
- Adds the cache credentials to ~root/.aws/config.
10+
11+
Configuration requires sudo, but only needs to happen once. The changes persist
12+
across Devbox accounts and organizations.
13+
14+
This command is a no-op for single-user Nix installs that aren't running the
15+
Nix daemon.
16+
17+
```bash
18+
devbox cache configure [flags]
19+
```
20+
21+
## Options
22+
23+
<!-- Markdown table of options -->
24+
| Option | Description |
25+
| --- | --- |
26+
| `--user string` | The OS user to configure Nix for. Defaults to the current user. |
27+
| `-h, --help` | help for configure |
28+
| `-q, --quiet` | suppresses logs |
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# devbox cache info
2+
3+
Output information about the nix cache
4+
5+
```bash
6+
devbox cache info [flags]
7+
```
8+
9+
## Options
10+
<!-- Markdown table of options -->
11+
| Option | Description |
12+
| --- | --- |
13+
| `-h, --help` | help for info |
14+
| `-q, --quiet` | suppresses logs |
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# devbox cache upload
2+
3+
Upload specified nix installable or nix packages in current project to cache.
4+
If [installable] is provided, only that installable will be uploaded.
5+
Otherwise, all packages in the project will be uploaded.
6+
To upload to specific cache, use --to flag. Otherwise, a cache from
7+
the cache provider will be used, if available.
8+
9+
```bash
10+
devbox cache upload [installable] [flags]
11+
```
12+
13+
## Aliases
14+
upload, copy
15+
16+
## Options
17+
18+
| Option | Description |
19+
| --- | --- |
20+
| `-c, --config string` | path to directory containing a devbox.json config file |
21+
| `-h, --help` | help for upload |
22+
| `--to string` | URI of the cache to copy to |
23+
| `-q, --quiet` | suppresses logs |
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# devbox secrets
2+
3+
Manage environment variables and secrets
4+
5+
## Synopsis
6+
7+
Manage environment variables and secrets
8+
9+
Securely stores and retrieves environment variables on the cloud.
10+
Environment variables are always encrypted, which makes it possible to
11+
store values that contain passwords and other secrets.
12+
13+
```bash
14+
devbox secrets [flags]
15+
```
16+
17+
## Options
18+
19+
```bash
20+
-h, --help help for devbox secrets
21+
```
22+
23+
## SEE ALSO
24+
25+
* [devbox_secrets_download](./devbox_secrets_download.md) - Download environment variables into the specified file
26+
* [devbox_secrets_init](./devbox_secrets_init.md) - initialize directory and devbox secrets project
27+
* [devbox_secrets_list](./devbox_secrets_list.md) - List all stored environment variables
28+
* [devbox_secrets_rm](./devbox_secrets_rm.md) - Delete one or more environment variables
29+
* [devbox_secrets_set](./devbox_secrets_set.md) - Securely store one or more environment variables
30+
* [devbox_secrets_upload](./devbox_secrets_upload.md) - Upload variables defined in a .env file
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# devbox secrets download
2+
3+
Download environment variables into the specified file
4+
5+
## Synopsis
6+
7+
Download environment variables stored into the specified file (most commonly a .env file). The format of the file is one NAME=VALUE per line.
8+
9+
```bash
10+
devbox secrets download <file1> [flags]
11+
```
12+
13+
## Options
14+
15+
```bash
16+
--environment string Environment name, such as dev or prod (default "dev")
17+
-f, --format string File format: env or json (default "env")
18+
-h, --help help for download
19+
--org-id string Organization id to namespace secrets by
20+
--project-id string Project id to namespace secrets by
21+
```
22+
23+
## SEE ALSO
24+
25+
* [devbox_secrets](./devbox_secrets.md) - Manage environment variables and secrets
26+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# devbox secrets init
2+
3+
Initialize devbox secrets in the project directory. This setup step creates/connects to an existing jetify cloud project
4+
5+
```bash
6+
devbox secrets init [flags]
7+
```
8+
9+
## Options
10+
11+
```bash
12+
-h, --help help for init
13+
```
14+
15+
## SEE ALSO
16+
17+
* [devbox_secrets](./devbox_secrets.md) - Manage environment variables and secrets
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# devbox secrets list
2+
3+
List all stored environment variables
4+
5+
## Synopsis
6+
7+
List all stored environment variables. If no environment flag is provided, variables in all environments will be listed.
8+
9+
```bash
10+
devbox secrets list [flags]
11+
```
12+
13+
## Options
14+
15+
```bash
16+
--environment string Environment name, such as dev or prod (default "dev")
17+
-f, --format string Display the key values in key=value format (default "table")
18+
-h, --help help for ls
19+
--org-id string Organization id to namespace secrets by
20+
--project-id string Project id to namespace secrets by
21+
-s, --show Display the value of each environment variable (secrets included)
22+
```
23+
24+
## SEE ALSO
25+
26+
* [devbox_secrets](./devbox_secrets.md) - Manage environment variables and secrets
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# devbox secrets rm
2+
3+
Delete one or more environment variables
4+
5+
## Synopsis
6+
7+
Delete one or more environment variables that are stored.
8+
9+
```bash
10+
devbox secrets rm <NAME1> [<NAME2>]... [flags]
11+
```
12+
13+
## Options
14+
15+
```bash
16+
--environment string Environment name, such as dev or prod (default "dev")
17+
-h, --help help for rm
18+
--org-id string Organization id to namespace secrets by
19+
--project-id string Project id to namespace secrets by
20+
```
21+
22+
## SEE ALSO
23+
24+
* [devbox_secrets](./devbox_secrets.md) - Manage environment variables and secrets
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# devbox secrets set
2+
3+
Securely store one or more environment variables
4+
5+
## Synopsis
6+
7+
Securely store one or more environment variables.
8+
9+
```bash
10+
devbox secrets set <NAME1>=<value1> [<NAME2>=<value2>]... [flags]
11+
```
12+
13+
## Options
14+
15+
```bash
16+
--environment string Environment name, such as dev or prod (default "dev")
17+
-h, --help help for set
18+
--org-id string Organization id to namespace secrets by
19+
--project-id string Project id to namespace secrets by
20+
```
21+
22+
## SEE ALSO
23+
24+
* [devbox_secrets](./devbox_secrets.md) - Manage environment variables and secrets

0 commit comments

Comments
 (0)