opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: API tokens & CI automation (#4510)

Browse Source 
* reword: chore: add CI to dogfood template

* use hardcoded URL

* use consistent name for tokens

* chore: add docs for template change management

* add an example

* fix case
This commit is contained in:
Ben Potter
2022-10-12 15:43:59 +00:00
committed by GitHub
parent abf14d976a
commit 2a1bfb3e44
8 changed files with 105 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/automation.md
+37
View File
@@ -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).