Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README (1).md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Platform Overview
---
# Platform Overview

## What is DevZero?

Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,8 @@ layout:

## Welcome to DevZero

{% hint style="info" %}
**New to the platform?**\
\
We recommend getting started with our [readme-1.md](getting-started/readme-1.md "mention") and then running through the [quickstart.md](getting-started/quickstart.md "mention") example.
{% endhint %}
> **New to the platform?**
> We recommend getting started with our [readme-1.md](getting-started/readme-1.md "mention") and then running through the [quickstart.md](getting-started/quickstart.md "mention") example.

***

Expand Down
1 change: 0 additions & 1 deletion STYLE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: DevZero docs style guide
---
# DevZero docs style guide

1. Images should have descriptive alt description

Expand Down
1 change: 0 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Table of contents
---
# Table of contents

## ℹ️ Getting Started

Expand Down
5 changes: 1 addition & 4 deletions admin/acls.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
title: ACLs
---
# ACLs

{% hint style="info" %}
**Coming soon...** We currently support a handful of predefined user roles and permission sets. Additional customization options are expected to land later this year.
{% endhint %}
> **Coming soon...** We currently support a handful of predefined user roles and permission sets. Additional customization options are expected to land later this year.
1 change: 0 additions & 1 deletion admin/hosting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Hosting
---
# Hosting

## Hosting Options

Expand Down
3 changes: 0 additions & 3 deletions admin/personal-access-tokens.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Personal Access Tokens
---
# Personal Access Tokens

## Managing Personal Access Tokens

Expand All @@ -17,8 +16,6 @@ Deleting a token is performed in the same section.

A personal access token can be used to authenticate the `dz` cli. Simply log in by passing the token contents via the `--token` flag. Upon token expiry, the cli will prompt to re-authenticate.

{% code lineNumbers="false" %}
```
dz auth login --token <token contents>
```
{% endcode %}
5 changes: 1 addition & 4 deletions admin/sso.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Single Sign-on (SSO
---
# Single Sign-on (SSO

Use-case:

Expand All @@ -19,6 +18,4 @@ Many organizations use SSO to easily manage onboarding and offboarding of employ

You can also create this as a [secret GitHub Gist](https://gist.github.com/) and send us a link!

{% hint style="info" %}
**Note...** We are aware that depending on the SSO provider you use, we might have to provide you a couple bits of information to put in your SSO Admin Portal. We will reach out to you if that's the case!
{% endhint %}
> **Note...** We are aware that depending on the SSO provider you use, we might have to provide you a couple bits of information to put in your SSO Admin Portal. We will reach out to you if that's the case!
1 change: 0 additions & 1 deletion admin/user-management.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: User Management
---
# User Management

## Inviting Teammates

Expand Down
1 change: 0 additions & 1 deletion builds/builds/team.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
title: Team
---
# Team
1 change: 0 additions & 1 deletion devzero-network/access-own-workspace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Access Running Applications
---
# Access Running Applications

## Access Your Running Application(s)

Expand Down
13 changes: 0 additions & 13 deletions devzero-network/connecting.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,50 @@
---
title: Adding Resources to your Network
---
# Adding Resources to your Network

## Add a peer to your DevZero network

1. Get a shell inside the node that you want to add to the network.
2. [Install the CLI.](../references/cli-man-page/install-the-cli.md)
3. Run

{% code %}
```
sudo dz auth login
```
{% endcode %}

4. Add the node to the network by running (_optional_ `--hostname` flag: replace `<some_name>` with a memorable hostname)

{% code %}
```
sudo dz network connect --hostname=<some_name>
# example: sudo dz net connect --hostname=my-rds-jump-node
```
{% endcode %}

5. Verify that the node is in the network by running

{% code %}
```
dz network status
```
{% endcode %}

## Advertise routes to your DevZero network

1. Get a shell inside the node that you want to add to the network.
2. Install the CLI following [these steps](./../references/cli-man-page/install-the-cli.md).
3. Run

{% code %}
```
sudo dz auth login
```
{% endcode %}

4. Add the node to the network by running (_optional_ `--hostname` flag: replace `<some_name>` with a memorable hostname)

{% code %}
```
sudo dz network connect --hostname=<some_name> --advertise-routes=<CIDR range>
# example: sudo dz net connect --hostname=my-rds-jump-node --advertise-routes=172.31.0.0/16
# where the current node is on a VPC w/ CIDR range 172.31.0.0/16
```
{% endcode %}

5. Verify that the node is in the network by running

{% code %}
```
dz network status
```
{% endcode %}
1 change: 0 additions & 1 deletion devzero-network/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Overview
---
# Overview

The DevZero Network uses a decentralized VPN strategy to enable secure access to [nodes](../references/terminology.md#node) across your team. We accomplish thiusing WireGuard.

Expand Down
7 changes: 2 additions & 5 deletions devzero-network/status.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
---
title: Network Status
---
# Network Status

Currently, to see the peers that are present within your DevZero network, run
{% code %}

```
dz network status
```
{% endcode %}

<figure><img src="../.gitbook/assets/net-status.png" alt=""><figcaption><p>dz network status</p></figcaption></figure>

To view all the peers in your team, run
{% code %}

```
dz network status --team
```
{% endcode %}

<figure><img src="../.gitbook/assets/net-status-team.png" alt=""><figcaption><p>dz network status --team</p></figcaption></figure>
1 change: 0 additions & 1 deletion devzero-storage/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: DevZero Storage
---
# DevZero Storage

## Volume

Expand Down
26 changes: 7 additions & 19 deletions devzero-storage/volume-elastic-nfs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Volume (elastic NFS)
---
# Volume (elastic NFS)

DevZero's volumes are multi-attach multi-read-write capable volumes (similar to AWS EFS).
Volumes are regional in nature and can be attached to any workspace in that region.
Expand All @@ -10,40 +9,33 @@ Volumes are regional in nature and can be attached to any workspace in that regi

### In your default region

{% code %}
```
$ dz storage volume create --name=my-fancy-volume --size=50
ID Name Total size (GB) Region
7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA
ID Name Total size (GB) Region
7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA
```
{% endcode %}

### In an arbitrary region

{% code %}
```
$ dz storage volume create --name=other-fancy-volume --size=50 --region=eu-north-1
ID Name Total size (GB) Region
e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden
ID Name Total size (GB) Region
e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden
```
{% endcode %}

## Listing your volumes

{% code %}
```
$ dz storage volume list
ID Name Total size (GB) Region
7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA
e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden
ID Name Total size (GB) Region
7947b1c8-881c-49fb-b5c7-c3e0367a76f2 my-fancy-volume 50 Portland, USA
e71e024e-ba0a-443a-b452-c931e8ce39a5 other-fancy-volume 50 Stockholm, Sweden
```
{% endcode %}

## Launching a workspace with a volume

The volume is mounted at the path specified by the `--mount` flag.

{% code %}
```
$ dz workspace launch "My Recipe Name" --region=us-west-2 --mount /mnt/my-shared-volume=7947b1c8-881c-49fb-b5c7-c3e0367a76f2
Your workspace is currently being built... please wait!
Expand All @@ -52,7 +44,6 @@ Successfully deployed workspace dear-filly-ubhg
To connect to this workspace, run:
dz workspace connect dear-filly-ubhg

# OR

$ dz workspace launch "My Recipe Name" --region=eu-north-1 --mount /mnt/my-shared-volume=e71e024e-ba0a-443a-b452-c931e8ce39a5
Your workspace is currently being built... please wait!
Expand All @@ -61,11 +52,9 @@ Successfully deployed workspace abominal-monkey-ytui
To connect to this workspace, run:
dz workspace connect abominal-monkey-ytui
```
{% endcode %}

### Verifying mounted volumes inside a workspace

{% code %}
```
$ dz workspace connect dear-filly-ubhg
....
Expand All @@ -79,4 +68,3 @@ Filesystem K-blocks Used Available Use% Mounted on
/dev/nvme6n1 51290592 16500 51257708 1% /home/devzero
[some path..] 10485760 0 10485760 0% /mnt/my-shared-volume
```
{% endcode %}
10 changes: 3 additions & 7 deletions environment-variables/env-vars.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Overview
---
# Overview

Environment variables are materially public in nature. If you want to store or reference a secret value, see [Secrets](secrets.md).

Expand All @@ -12,11 +11,8 @@ These are usually used by when:

Once an environment variable is saved, it will be visible in the UI or CLI. It will be available at build- or launch-time. It will also be available in the running workspaces.

{% hint style="warning" %}
**Reserved prefix** `DEVZERO_` is a reserved prefix used by the platform. They may change at any time so relying on them is not advisable.

You may store environment variables or secrets with line breaks.
{% endhint %}
> **Reserved prefix** `DEVZERO_` is a reserved prefix used by the platform. They may change at any time so relying on them is not advisable.
> You may store environment variables or secrets with line breaks.

You can access environment variables within builds or at launch-time. If your variable is called `MY_KEY`, to access its value anywhere, use `$MY_KEY`. At runtime, you can use the `env` binary to verify that the secrets are present within that context.

Expand All @@ -29,7 +25,7 @@ runtime:
value: "{{secret:team.TEST_TEAM_ENV}}"
- name: TEST_USER_ENV
value: "{{secret:user.TEST_USER_ENV}}"
- name: FOO
- name: FOO
value: "bar"
```

Expand Down
9 changes: 2 additions & 7 deletions environment-variables/personal.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
---
title: User-scoped
---
# User-scoped

## Saving an user-scoped environment variable

Visit the Environment Variables section at [https://www.devzero.io/dashboard/environment-variables/user](https://www.devzero.io/dashboard/environment-variables/user) to add, remove, or update your user-scoped environment variables and secrets. User-scoped environment variables can only be seen, managed, and used by you.

{% hint style="info" %}
User-scoped environment variables are automatically made available on each of your running workspaces by default.
{% endhint %}
> User-scoped environment variables are automatically made available on each of your running workspaces by default.

<figure><img src="../.gitbook/assets/Personal variables.gif" alt=""><figcaption><p>Adding personal environment variables</p></figcaption></figure>

Expand All @@ -19,9 +16,7 @@ User-scoped environment variables are automatically made available on each of yo

Using an environment variable within your workspace is how you would normally use any environment variable (eg: `echo $NOT_SO_SECRET_KEY`).

{% hint style="info" %}
Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace.
{% endhint %}
> Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace.

To use it in a recipe, you can reference it the same way. If your environment variable is called `MY_KEY`:

Expand Down
9 changes: 2 additions & 7 deletions environment-variables/secrets.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
---
title: Secrets
---
# Secrets

Secrets are used to store and reference secret values.

{% hint style="info" %}
To store a secret, navigate to the environment variables page and add a new key-value pair. Before saving, be sure to check "Secret". This stores the environment variable as a secret with the additional protections described below.
{% endhint %}
> To store a secret, navigate to the environment variables page and add a new key-value pair. Before saving, be sure to check "Secret". This stores the environment variable as a secret with the additional protections described below.

<figure><img src="../.gitbook/assets/Screenshot 2024-07-18 at 15.36.52.png" alt=""><figcaption></figcaption></figure>

Once a secret is saved, its value cannot be viewed or modified. You can only replace or delete the value. Otherwise, secrets work just like other environment variables.

{% hint style="info" %}
Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace.
{% endhint %}
> Note: User secrets are not available during build time, they are only available during launch and runtime steps. However, all user secrets are automatically available as environment variables within each user's workspace.

You can access secrets within builds or at build or launch time, just like you would access any environment variable. If your secret is called `MY_SECRET_KEY`, to access its value anywhere, use `$MY_SECRET_KEY`. At runtime, you can use the `env` binary to verify that the secrets are present within that context.

Expand Down
5 changes: 1 addition & 4 deletions environment-variables/team.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
title: Team-scoped
---
# Team-scoped

## Saving a team-scoped environment variable

Visit the Environment Variables section at [https://www.devzero.io/dashboard/environment-variables/team](https://www.devzero.io/dashboard/environment-variables/team) to add, remove or update your team-scoped environment variables. Team-scoped environment variables can be referenced and used by anyone within your DevZero team.

<figure><img src="../.gitbook/assets/Update environment variables (1).png" alt=""><figcaption><p>Team environment variables</p></figcaption></figure>

{% hint style="info" %}
Team-scoped environment variables and secrets must be directly referenced in your recipe template steps. Unlike user-scoped environment variables, they are **not** automatically added to every workspace.
{% endhint %}
> Team-scoped environment variables and secrets must be directly referenced in your recipe template steps. Unlike user-scoped environment variables, they are **not** automatically added to every workspace.

<figure><img src="../.gitbook/assets/Update environment variables.png" alt=""><figcaption><p>Team Environment Variables</p></figcaption></figure>

Expand Down
Loading