Document replicated profile command for authenticating with the cli #3651
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci added type::docs 
| @@ -1,3 +1,3 @@ | |||
| :::note | |||
| The `replicated login` command creates a token after you log in to your vendor account in a browser and saves it to a config file. Alteratively, if you do not have access to a browser, you can set the `REPLICATED_API_TOKEN` environment variable to authenticate. For more information, see [(Optional) Set Environment Variables](/reference/replicated-cli-installing#env-var). | |||
There was a problem hiding this comment.
Removed this second sentence, which implies that there are only two options (login or env var). Instead, this note can just explain what the login command does and not worry about listing the other auth options
| ::: | ||
| | ||
| Installing in Docker environments requires that you set the `REPLICATED_API_TOKEN` environment variable to authorize the Replicated CLI with an API token. For more information, see [(Optional) Set Environment Variables](/reference/replicated-cli-installing#env-var). | ||
| |
There was a problem hiding this comment.
^ moved this to a note in the procedure
| Replace `TOKEN` with your API token. | ||
| 1. To begin using the Replicated CLI to manage your applications, authenticate with your Replicated credentials. See [Authenticate](#auth). | ||
| | ||
| For more information about the `docker run` command, see [docker run](https://docs.docker.com/engine/reference/commandline/run/) in the Docker documentation. |
There was a problem hiding this comment.
^ replaced this step with a link to the more detailed documentation on authenticating with the replicated cli
| | ||
| <AuthToken/> | ||
| | ||
| 1. <Logout/> |
There was a problem hiding this comment.
^ also replaced with link to detailed info about the different auth options
| <InstallDocker/> | ||
| | ||
| ## (Optional) Set Environment Variables {#env-var} | ||
| ## Authenticate {#auth} |
There was a problem hiding this comment.
^ update this page with an overview of the different authentication options: login, env var, profile
| replicated app ls # Lists apps for company-b | ||
| ``` | ||
| | ||
| For more information, see [replicated profile](/reference/replicated-cli-profile). |
There was a problem hiding this comment.
^ link to profile cli docs for more details
| The Replicated CLI is the primary interface for the Replicated Platform. With the Replicated CLI, you can create and manage applications, releases, channels, customers, and more. You also use the Replicated CLI to create clusters with the Compatibility Matrix. | ||
| | ||
| After installing, you can authorize the Replicated CLI by logging in to your Replicated vendor account through the `replicated login` command. | ||
| After installing, authorize the Replicated CLI using your Replicated credentials. See [Authenticate](#auth) in _Install the Replicated CLI_. |
There was a problem hiding this comment.
^ from the Set Up Your Environment page in the getting started docs, link to the info about auth rather than telling people to just use the login command
| Before you create a release using the Replicated CLI, complete the following prerequisites: | ||
| | ||
| * Install the Replicated CLI and then log in to authorize the CLI. See [Install the Replicated CLI](/reference/replicated-cli-installing). | ||
| * Install the Replicated CLI. See [Install the Replicated CLI](/reference/replicated-cli-installing). |
There was a problem hiding this comment.
^ update the prerequisite in Creating Releases With the CLI to link to all auth options
| :::note | ||
| To remove a service account, select **Remove** for the service account that you want to delete. | ||
| ::: | ||
| 1. (Recommended) Add the token to a Replicated authentication profile. See [Authenticate](/reference/replicated-cli-installing#auth) in _Installing the Replicated CLI_. |
There was a problem hiding this comment.
^ in the how-to on generating API token from the Vendor Portal, add a step to recommend that people add their token to a profile
(This is an assumption on my part that this would be something we want to recommend)
| * Directly on MacOS | ||
| * Directly on Linux | ||
| * Through Docker (Useful for Windows, GitHub Actions, or computers without sufficient access) | ||
| * On Windows Subsystem for Linux (WSL) |
There was a problem hiding this comment.
^ this was missing from the list
| | ||
| * Directly on MacOS | ||
| * Directly on Linux | ||
| * Through Docker (Useful for Windows, GitHub Actions, or computers without sufficient access) |
There was a problem hiding this comment.
Removed "useful for windows" since we recommend WSL for windows users
Main changes in the Installing the Replicated CLI page to explain all the different auth options: https://deploy-preview-3651--replicated-docs.netlify.app/reference/replicated-cli-installing#auth
Other related changes: