-
Notifications
You must be signed in to change notification settings - Fork 985
docs: API tokens & CI automation #4510
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8b6f2c2
reword: chore: add CI to dogfood template
bpmct c9d4298
use hardcoded URL
bpmct c27b289
use consistent name for tokens
bpmct 5a0d820
chore: add docs for template change management
bpmct c065ddd
add an example
bpmct 463f884
fix case
bpmct File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Automation | ||
|
||
We recommend automating Coder deployments through the CLI. Examples include [updating templates via CI/CD pipelines](../templates/change-management.md). | ||
|
||
## Tokens | ||
|
||
Long-lived tokens can be generated to perform actions on behalf of your user account: | ||
|
||
```sh | ||
coder tokens create | ||
``` | ||
|
||
## CLI | ||
|
||
You can use tokens with the CLI by setting the `--token` CLI flag or the `CODER_SESSION_TOKEN` | ||
environment variable. | ||
|
||
```sh | ||
export CODER_URL=https://coder.example.com | ||
export CODER_SESSION_TOKEN=***** | ||
coder workspaces ls | ||
``` | ||
|
||
## REST API | ||
|
||
You can use tokens with the Coder's REST API using the `Coder-Session-Token` HTTP header. | ||
|
||
```sh | ||
curl 'https://dev.coder.com/api/v2/workspaces' \ | ||
-H 'Coder-Session-Token: *****' | ||
``` | ||
|
||
> At this time, we do not publish an API reference. However, [codersdk](https://github.com/coder/coder/tree/main/codersdk) can be grepped to find the necessary routes and payloads. | ||
|
||
## Golang SDK | ||
|
||
Coder publishes a public [Golang SDK](https://pkg.go.dev/github.com/coder/coder@main/codersdk) for Coder. This is consumed by the [CLI package](https://github.com/coder/coder/tree/main/cli). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Template Change Management | ||
|
||
We recommend source controlling your templates as you would other code. [Install Coder](../install/) in CI/CD pipelines to push new template versions. | ||
|
||
```sh | ||
# Install the Coder CLI | ||
curl -L https://coder.com/install.sh | sh | ||
# curl -L https://coder.com/install.sh | sh -s -- --version=0.x | ||
|
||
# To create API tokens, use `coder tokens create`. | ||
# These variables are consumed by Coder | ||
export CODER_URL=https://coder.example.com | ||
export CODER_SESSION_TOKEN=***** | ||
|
||
# Template details | ||
export CODER_TEMPLATE_NAME=kubernetes | ||
export CODER_TEMPLATE_DIR=.coder/templates/kubernetes | ||
export CODER_TEMPLATE_VERSION=$(git rev-parse --short HEAD) | ||
|
||
coder templates push --yes $CODER_TEMPLATE_NAME \ | ||
--directory $CODER_TEMPLATE_DIR \ | ||
--name=$CODER_TEMPLATE_VERSION # Version name is optional | ||
``` | ||
Comment on lines
+3
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm really bought into this being the way we suggest customers manage these - at least until we hear feedback otherwise. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.