Skip to content

Commit

Permalink
[docs-beta] migrate dagster-cloud-cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmpadden committed Dec 13, 2024
1 parent a64aa2c commit 0ee0369
Show file tree
Hide file tree
Showing 2 changed files with 148 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
---
title: dagster-cloud CLI reference
sidebar_position: 200
unlisted: true
---

{/* TODO copy from https://docs.dagster.io/dagster-plus/managing-deployments/dagster-plus-cli#reference */}
# dagster-cloud CLI reference

## Custom configuration file path

Point the CLI at an alternate config location by specifying the `DAGSTER_CLOUD_CLI_CONFIG` environment variable.

## Environment variables and CLI options

Environment variables and CLI options can be used in place of or to override the CLI configuration file.

The priority of these items is as follows:

- **CLI options** - highest
- **Environment variables**
- **CLI configuration** - lowest

| Setting | Environment variable | CLI flag | CLI config value |
| ------------ | ---------------------------- | ---------------------- | -------------------- |
| Organization | `DAGSTER_CLOUD_ORGANIZATION` | `--organization`, `-o` | `organization` |
| Deployment | `DAGSTER_CLOUD_DEPLOYMENT` | `--deployment`, `-d` | `default_deployment` |
| User Token | `DAGSTER_CLOUD_API_TOKEN` | `--user-token`, `-u` | `user_token` |
Original file line number Diff line number Diff line change
@@ -1,8 +1,133 @@
---
title: Installing and configuring the dagster-cloud CLI
sidebar_position: 100
unlisted: true
---

{/* TODO copy from "Installing the CLI" and "Configuring the CLI" sections of https://docs.dagster.io/dagster-plus/managing-deployments/dagster-plus-cli */}
# Installing and configuring the dagster-cloud CLI

:::note
This guide is applicable to Dagster+.
:::

The `dagster-cloud` CLI is a command-line toolkit designed to work with Dagster+.

In this guide, we'll cover how to install and configure the `dagster-cloud` CLI, get help, and use some helpful environment variables and CLI options.

## Installing the CLI

The Dagster+ Agent library is available in PyPi. To install, run:

```shell
pip install dagster-cloud
```

Refer to the [configuration section](#configuring-the-cli) for next steps.

### Completions

Optionally, you can install command-line completions to make using the `dagster-cloud` CLI easier.

To have the CLI install these completions to your shell, run:

```shell
dagster-cloud --install-completion
```

To print out the completion for copying or manual installation:

```shell
dagster-cloud --show-completion
```

## Configuring the CLI

The recommended way to set up your CLI's config for long-term use is through the configuration file, located by default at `~/.dagster_cloud_cli/config`.

Check failure on line 44 in docs/docs-beta/docs/dagster-plus/deployment/management/dagster-cloud-cli/installing-and-configuring.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Dagster.spelling] Is 'CLI's' spelled correctly? Raw Output: {"message": "[Dagster.spelling] Is 'CLI's' spelled correctly?", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/dagster-cloud-cli/installing-and-configuring.md", "range": {"start": {"line": 44, "column": 36}}}, "severity": "ERROR"}

Check failure on line 44 in docs/docs-beta/docs/dagster-plus/deployment/management/dagster-cloud-cli/installing-and-configuring.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'CLI's'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'CLI's'?", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/dagster-cloud-cli/installing-and-configuring.md", "range": {"start": {"line": 44, "column": 36}}}, "severity": "ERROR"}

### Setting up the configuration file

Set up the config file:

```shell
dagster-cloud config setup
```

Select your authentication method. **Note**: Browser authentication is the easiest method to configure.

<details>
<summary><strong>BROWSER AUTHENTICATION</strong></summary>

The easiest way to set up is to authenticate through the browser.

```shell
$ dagster-cloud config setup
? How would you like to authenticate the CLI? (Use arrow keys)
» Authenticate in browser
Authenticate using token
Authorized for organization `hooli`

? Default deployment: prod
```

When prompted, you can specify a default deployment. If specified, a deployment won't be required in subsequent `dagster-cloud` commands. The default deployment for a new Dagster+ organization is `prod`.

</details>

<details>
<summary><strong>TOKEN AUTHENTICATION</strong></summary>

Alternatively, you may authenticate using a user token. Refer to the [Managing user and agent tokens guide](/dagster-plus/account/managing-user-agent-tokens) for more info.

```shell
$ dagster-cloud config setup
? How would you like to authenticate the CLI? (Use arrow keys)
Authenticate in browser
» Authenticate using token

? Dagster+ organization: hooli
? Dagster+ user token: *************************************
? Default deployment: prod
```

When prompted, specify the following:

- **Organization** - Your organization name as it appears in your Dagster+ URL. For example, if your Dagster+ instance is `https://hooli.dagster.cloud/`, this would be `hooli`.
- **User token** - The user token.
- **Default deployment** - **Optional**. A default deployment. If specified, a deployment won't be required in subsequent `dagster-cloud` commands. The default deployment for a new Dagster+ organization is `prod`.

</details>

### Viewing and modifying the configuration file

To view the contents of the CLI configuration file, run:

```shell
$ dagster-cloud config view

default_deployment: prod
organization: hooli
user_token: '*******************************8214fe'
```

Specify the `--show-token` flag to show the full user token.

To modify the existing config, re-run:

```shell
dagster-cloud config setup
```

## Toggling between deployments

To quickly toggle between deployments, run:

```shell
dagster-cloud config set-deployment <deployment_name>
```

## Getting help

To view help options in the CLI:

```shell
dagster-cloud --help
```

0 comments on commit 0ee0369

Please sign in to comment.