Compare commits
56 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e8f6578ece | ||
|
|
838ec95875 | ||
|
|
5a0efdf867 | ||
|
|
4debc3200d | ||
|
|
5476f819ce | ||
|
|
9a5ff6df64 | ||
|
|
bab0f7d24d | ||
|
|
fc914626a2 | ||
|
|
fdbb2e30d0 | ||
|
|
ee80d1f64c | ||
|
|
017f007bde | ||
|
|
18810cc51e | ||
|
|
98a428ae89 | ||
|
|
dd072e261a | ||
|
|
7e3743739e | ||
|
|
f5681b5206 | ||
|
|
de0813f37f | ||
|
|
d8fa7c959f | ||
|
|
c3d1b4125e | ||
|
|
472d80ade6 | ||
|
|
7d6c526146 | ||
|
|
a3dc364227 | ||
|
|
f335a62891 | ||
|
|
8ed13be726 | ||
|
|
b90f6f9de8 | ||
|
|
948280600a | ||
|
|
407738b2be | ||
|
|
08adb4a839 | ||
|
|
313ec59d46 | ||
|
|
4b04d18f39 | ||
|
|
ee53ca0281 | ||
|
|
8e254a3bb9 | ||
|
|
1ab53139b3 | ||
|
|
147bea9782 | ||
|
|
8d8910c52a | ||
|
|
c00b7536cb | ||
|
|
d66d7e994e | ||
|
|
d10ce91a64 | ||
|
|
534491613f | ||
|
|
ac64af6f02 | ||
|
|
b299f98161 | ||
|
|
7e897a51e6 | ||
|
|
ac54966f5e | ||
|
|
aef9b3b116 | ||
|
|
a5c4d00a01 | ||
|
|
3227a47044 | ||
|
|
cf1807dd5c | ||
|
|
4c993d342d | ||
|
|
5a7e3f6ca4 | ||
|
|
acab6437bc | ||
|
|
f16d7ca3f5 | ||
|
|
a9a58bff32 | ||
|
|
6b842004e6 | ||
|
|
376c0cae31 | ||
|
|
7d31865c94 | ||
|
|
d3fc2d2212 |
2
.github/workflows/ci.yaml
vendored
2
.github/workflows/ci.yaml
vendored
@@ -34,5 +34,7 @@ jobs:
|
|||||||
run: bun install
|
run: bun install
|
||||||
- name: Format
|
- name: Format
|
||||||
run: bun fmt:ci
|
run: bun fmt:ci
|
||||||
|
- name: typos-action
|
||||||
|
uses: crate-ci/typos@v1.17.2
|
||||||
- name: Lint
|
- name: Lint
|
||||||
run: bun lint
|
run: bun lint
|
||||||
|
|||||||
42
.github/workflows/update-readme.yaml
vendored
Normal file
42
.github/workflows/update-readme.yaml
vendored
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
name: Update README on Tag
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-readme:
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Get the latest tag
|
||||||
|
id: get-latest-tag
|
||||||
|
run: echo "TAG=$(git describe --tags --abbrev=0 | sed 's/^v//')" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Run update script
|
||||||
|
run: ./update-version.sh
|
||||||
|
|
||||||
|
- name: Create Pull Request
|
||||||
|
id: create-pr
|
||||||
|
uses: peter-evans/create-pull-request@v5
|
||||||
|
with:
|
||||||
|
commit-message: 'chore: bump version to ${{ env.TAG }} in README.md files'
|
||||||
|
title: 'chore: bump version to ${{ env.TAG }} in README.md files'
|
||||||
|
body: 'This is an auto-generated PR to update README.md files of all modules with the new tag ${{ env.TAG }}'
|
||||||
|
branch: 'update-readme-branch'
|
||||||
|
base: 'main'
|
||||||
|
env:
|
||||||
|
TAG: ${{ steps.get-latest-tag.outputs.TAG }}
|
||||||
|
|
||||||
|
- name: Auto-approve
|
||||||
|
uses: hmarr/auto-approve-action@v4
|
||||||
|
if: github.ref == 'refs/heads/update-readme-branch'
|
||||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 6.8 KiB |
1
.icons/node.svg
Normal file
1
.icons/node.svg
Normal file
@@ -0,0 +1 @@
|
|||||||
|
<svg width="2270" height="2500" viewBox="0 0 256 282" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMin meet"><g fill="#8CC84B"><path d="M116.504 3.58c6.962-3.985 16.03-4.003 22.986 0 34.995 19.774 70.001 39.517 104.99 59.303 6.581 3.707 10.983 11.031 10.916 18.614v118.968c.049 7.897-4.788 15.396-11.731 19.019-34.88 19.665-69.742 39.354-104.616 59.019-7.106 4.063-16.356 3.75-23.24-.646-10.457-6.062-20.932-12.094-31.39-18.15-2.137-1.274-4.546-2.288-6.055-4.36 1.334-1.798 3.719-2.022 5.657-2.807 4.365-1.388 8.374-3.616 12.384-5.778 1.014-.694 2.252-.428 3.224.193 8.942 5.127 17.805 10.403 26.777 15.481 1.914 1.105 3.852-.362 5.488-1.274 34.228-19.345 68.498-38.617 102.72-57.968 1.268-.61 1.969-1.956 1.866-3.345.024-39.245.006-78.497.012-117.742.145-1.576-.767-3.025-2.192-3.67-34.759-19.575-69.5-39.18-104.253-58.76a3.621 3.621 0 0 0-4.094-.006C91.2 39.257 56.465 58.88 21.712 78.454c-1.42.646-2.373 2.071-2.204 3.653.006 39.245 0 78.497 0 117.748a3.329 3.329 0 0 0 1.89 3.303c9.274 5.259 18.56 10.481 27.84 15.722 5.228 2.814 11.647 4.486 17.407 2.33 5.083-1.823 8.646-7.01 8.549-12.407.048-39.016-.024-78.038.036-117.048-.127-1.732 1.516-3.163 3.2-3 4.456-.03 8.918-.06 13.374.012 1.86-.042 3.14 1.823 2.91 3.568-.018 39.263.048 78.527-.03 117.79.012 10.464-4.287 21.85-13.966 26.97-11.924 6.177-26.662 4.867-38.442-1.056-10.198-5.09-19.93-11.097-29.947-16.55C5.368 215.886.555 208.357.604 200.466V81.497c-.073-7.74 4.504-15.197 11.29-18.85C46.768 42.966 81.636 23.27 116.504 3.58z"/><path d="M146.928 85.99c15.21-.979 31.493-.58 45.18 6.913 10.597 5.742 16.472 17.793 16.659 29.566-.296 1.588-1.956 2.464-3.472 2.355-4.413-.006-8.827.06-13.24-.03-1.872.072-2.96-1.654-3.195-3.309-1.268-5.633-4.34-11.212-9.642-13.929-8.139-4.075-17.576-3.87-26.451-3.785-6.479.344-13.446.905-18.935 4.715-4.214 2.886-5.494 8.712-3.99 13.404 1.418 3.369 5.307 4.456 8.489 5.458 18.33 4.794 37.754 4.317 55.734 10.626 7.444 2.572 14.726 7.572 17.274 15.366 3.333 10.446 1.872 22.932-5.56 31.318-6.027 6.901-14.805 10.657-23.56 12.697-11.647 2.597-23.734 2.663-35.562 1.51-11.122-1.268-22.696-4.19-31.282-11.768-7.342-6.375-10.928-16.308-10.572-25.895.085-1.619 1.697-2.748 3.248-2.615 4.444-.036 8.888-.048 13.332.006 1.775-.127 3.091 1.407 3.182 3.08.82 5.367 2.837 11 7.517 14.182 9.032 5.827 20.365 5.428 30.707 5.591 8.568-.38 18.186-.495 25.178-6.158 3.689-3.23 4.782-8.634 3.785-13.283-1.08-3.925-5.186-5.754-8.712-6.95-18.095-5.724-37.736-3.647-55.656-10.12-7.275-2.571-14.31-7.432-17.105-14.906-3.9-10.578-2.113-23.662 6.098-31.765 8.006-8.06 19.563-11.164 30.551-12.275z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 2.5 KiB |
BIN
.images/hcp-vault-secrets-credentials.png
Normal file
BIN
.images/hcp-vault-secrets-credentials.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 174 KiB |
@@ -11,10 +11,10 @@ tags: [helper]
|
|||||||
|
|
||||||
<!-- Describes what this module does -->
|
<!-- Describes what this module does -->
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "MODULE_NAME" {
|
module "MODULE_NAME" {
|
||||||
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -26,11 +26,11 @@ module "MODULE_NAME" {
|
|||||||
|
|
||||||
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
|
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "MODULE_NAME" {
|
module "MODULE_NAME" {
|
||||||
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
extensions = [
|
extensions = [
|
||||||
"dracula-theme.theme-dracula"
|
"dracula-theme.theme-dracula"
|
||||||
]
|
]
|
||||||
@@ -43,13 +43,13 @@ Enter the `<author>.<name>` into the extensions array and code-server will autom
|
|||||||
|
|
||||||
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
|
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "MODULE_NAME" {
|
module "MODULE_NAME" {
|
||||||
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
extensions = [ "dracula-theme.theme-dracula" ]
|
extensions = [ "dracula-theme.theme-dracula" ]
|
||||||
settings = {
|
settings = {
|
||||||
"workbench.colorTheme" = "Dracula"
|
"workbench.colorTheme" = "Dracula"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -59,11 +59,11 @@ module "MODULE_NAME" {
|
|||||||
|
|
||||||
Run code-server in the background, don't fetch it from GitHub:
|
Run code-server in the background, don't fetch it from GitHub:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "MODULE_NAME" {
|
module "MODULE_NAME" {
|
||||||
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
offline = true
|
offline = true
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -50,6 +50,12 @@ variable "mutable" {
|
|||||||
description = "Whether the parameter is mutable."
|
description = "Whether the parameter is mutable."
|
||||||
default = true
|
default = true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
# Add other variables here
|
# Add other variables here
|
||||||
|
|
||||||
|
|
||||||
@@ -69,9 +75,10 @@ resource "coder_app" "MODULE_NAME" {
|
|||||||
slug = "MODULE_NAME"
|
slug = "MODULE_NAME"
|
||||||
display_name = "MODULE_NAME"
|
display_name = "MODULE_NAME"
|
||||||
url = "http://localhost:${var.port}"
|
url = "http://localhost:${var.port}"
|
||||||
icon = loocal.icon_url
|
icon = local.icon_url
|
||||||
subdomain = false
|
subdomain = false
|
||||||
share = "owner"
|
share = "owner"
|
||||||
|
order = var.order
|
||||||
|
|
||||||
# Remove if the app does not have a healthcheck endpoint
|
# Remove if the app does not have a healthcheck endpoint
|
||||||
healthcheck {
|
healthcheck {
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
To create a new module, clone this repository and run:
|
To create a new module, clone this repository and run:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
./new.sh MOUDLE_NAME
|
./new.sh MODULE_NAME
|
||||||
```
|
```
|
||||||
|
|
||||||
## Testing a Module
|
## Testing a Module
|
||||||
@@ -19,7 +19,7 @@ $ bun test -t '<module>'
|
|||||||
|
|
||||||
You can test a module locally by updating the source as follows
|
You can test a module locally by updating the source as follows
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "example" {
|
module "example" {
|
||||||
source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
|
source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,10 +14,10 @@ Modules extend Templates to create reusable components for your development envi
|
|||||||
|
|
||||||
e.g.
|
e.g.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "code-server" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.main.id
|
agent_id = coder_agent.main.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -14,10 +14,10 @@ the region closest to them.
|
|||||||
|
|
||||||
Customize the preselected parameter value:
|
Customize the preselected parameter value:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "aws-region" {
|
module "aws-region" {
|
||||||
source = "registry.coder.com/modules/aws-region/coder"
|
source = "registry.coder.com/modules/aws-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
default = "us-east-1"
|
default = "us-east-1"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -34,16 +34,18 @@ provider "aws" {
|
|||||||
|
|
||||||
Change the display name and icon for a region using the corresponding maps:
|
Change the display name and icon for a region using the corresponding maps:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "aws-region" {
|
module "aws-region" {
|
||||||
source = "registry.coder.com/modules/aws-region/coder"
|
source = "registry.coder.com/modules/aws-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
default = "ap-south-1"
|
default = "ap-south-1"
|
||||||
|
|
||||||
custom_names = {
|
custom_names = {
|
||||||
"ap-south-1": "Awesome Mumbai!"
|
"ap-south-1" : "Awesome Mumbai!"
|
||||||
}
|
}
|
||||||
|
|
||||||
custom_icons = {
|
custom_icons = {
|
||||||
"ap-south-1": "/emojis/1f33a.png"
|
"ap-south-1" : "/emojis/1f33a.png"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -58,11 +60,11 @@ provider "aws" {
|
|||||||
|
|
||||||
Hide the Asia Pacific regions Seoul and Osaka:
|
Hide the Asia Pacific regions Seoul and Osaka:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "aws-region" {
|
module "aws-region" {
|
||||||
source = "registry.coder.com/modules/aws-region/coder"
|
source = "registry.coder.com/modules/aws-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
exclude = [ "ap-northeast-2", "ap-northeast-3" ]
|
exclude = ["ap-northeast-2", "ap-northeast-3"]
|
||||||
}
|
}
|
||||||
|
|
||||||
provider "aws" {
|
provider "aws" {
|
||||||
|
|||||||
@@ -56,6 +56,14 @@ locals {
|
|||||||
# frequently and including the `aws_regions` data source requires
|
# frequently and including the `aws_regions` data source requires
|
||||||
# the provider, which requires a region.
|
# the provider, which requires a region.
|
||||||
regions = {
|
regions = {
|
||||||
|
"af-south-1" = {
|
||||||
|
name = "Africa (Cape Town)"
|
||||||
|
icon = "/emojis/1f1ff-1f1e6.png"
|
||||||
|
}
|
||||||
|
"ap-east-1" = {
|
||||||
|
name = "Asia Pacific (Hong Kong)"
|
||||||
|
icon = "/emojis/1f1ed-1f1f0.png"
|
||||||
|
}
|
||||||
"ap-northeast-1" = {
|
"ap-northeast-1" = {
|
||||||
name = "Asia Pacific (Tokyo)"
|
name = "Asia Pacific (Tokyo)"
|
||||||
icon = "/emojis/1f1ef-1f1f5.png"
|
icon = "/emojis/1f1ef-1f1f5.png"
|
||||||
@@ -72,6 +80,10 @@ locals {
|
|||||||
name = "Asia Pacific (Mumbai)"
|
name = "Asia Pacific (Mumbai)"
|
||||||
icon = "/emojis/1f1ee-1f1f3.png"
|
icon = "/emojis/1f1ee-1f1f3.png"
|
||||||
}
|
}
|
||||||
|
"ap-south-2" = {
|
||||||
|
name = "Asia Pacific (Hyderabad)"
|
||||||
|
icon = "/emojis/1f1ee-1f1f3.png"
|
||||||
|
}
|
||||||
"ap-southeast-1" = {
|
"ap-southeast-1" = {
|
||||||
name = "Asia Pacific (Singapore)"
|
name = "Asia Pacific (Singapore)"
|
||||||
icon = "/emojis/1f1f8-1f1ec.png"
|
icon = "/emojis/1f1f8-1f1ec.png"
|
||||||
@@ -80,18 +92,42 @@ locals {
|
|||||||
name = "Asia Pacific (Sydney)"
|
name = "Asia Pacific (Sydney)"
|
||||||
icon = "/emojis/1f1e6-1f1fa.png"
|
icon = "/emojis/1f1e6-1f1fa.png"
|
||||||
}
|
}
|
||||||
|
"ap-southeast-3" = {
|
||||||
|
name = "Asia Pacific (Jakarta)"
|
||||||
|
icon = "/emojis/1f1ee-1f1e9.png"
|
||||||
|
}
|
||||||
|
"ap-southeast-4" = {
|
||||||
|
name = "Asia Pacific (Melbourne)"
|
||||||
|
icon = "/emojis/1f1e6-1f1fa.png"
|
||||||
|
}
|
||||||
"ca-central-1" = {
|
"ca-central-1" = {
|
||||||
name = "Canada (Central)"
|
name = "Canada (Central)"
|
||||||
icon = "/emojis/1f1e8-1f1e6.png"
|
icon = "/emojis/1f1e8-1f1e6.png"
|
||||||
}
|
}
|
||||||
|
"ca-west-1" = {
|
||||||
|
name = "Canada West (Calgary)"
|
||||||
|
icon = "/emojis/1f1e8-1f1e6.png"
|
||||||
|
}
|
||||||
"eu-central-1" = {
|
"eu-central-1" = {
|
||||||
name = "EU (Frankfurt)"
|
name = "EU (Frankfurt)"
|
||||||
icon = "/emojis/1f1ea-1f1fa.png"
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
}
|
}
|
||||||
|
"eu-central-2" = {
|
||||||
|
name = "Europe (Zurich)"
|
||||||
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
|
}
|
||||||
"eu-north-1" = {
|
"eu-north-1" = {
|
||||||
name = "EU (Stockholm)"
|
name = "EU (Stockholm)"
|
||||||
icon = "/emojis/1f1ea-1f1fa.png"
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
}
|
}
|
||||||
|
"eu-south-1" = {
|
||||||
|
name = "Europe (Milan)"
|
||||||
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
|
}
|
||||||
|
"eu-south-2" = {
|
||||||
|
name = "Europe (Spain)"
|
||||||
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
|
}
|
||||||
"eu-west-1" = {
|
"eu-west-1" = {
|
||||||
name = "EU (Ireland)"
|
name = "EU (Ireland)"
|
||||||
icon = "/emojis/1f1ea-1f1fa.png"
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
@@ -104,6 +140,14 @@ locals {
|
|||||||
name = "EU (Paris)"
|
name = "EU (Paris)"
|
||||||
icon = "/emojis/1f1ea-1f1fa.png"
|
icon = "/emojis/1f1ea-1f1fa.png"
|
||||||
}
|
}
|
||||||
|
"il-central-1" = {
|
||||||
|
name = "Israel (Tel Aviv)"
|
||||||
|
icon = "/emojis/1f1ee-1f1f1.png"
|
||||||
|
}
|
||||||
|
"me-south-1" = {
|
||||||
|
name = "Middle East (Bahrain)"
|
||||||
|
icon = "/emojis/1f1e7-1f1ed.png"
|
||||||
|
}
|
||||||
"sa-east-1" = {
|
"sa-east-1" = {
|
||||||
name = "South America (São Paulo)"
|
name = "South America (São Paulo)"
|
||||||
icon = "/emojis/1f1e7-1f1f7.png"
|
icon = "/emojis/1f1e7-1f1f7.png"
|
||||||
@@ -145,4 +189,4 @@ data "coder_parameter" "region" {
|
|||||||
|
|
||||||
output "value" {
|
output "value" {
|
||||||
value = data.coder_parameter.region.value
|
value = data.coder_parameter.region.value
|
||||||
}
|
}
|
||||||
@@ -11,10 +11,10 @@ tags: [helper, parameter, azure, regions]
|
|||||||
|
|
||||||
This module adds a parameter with all Azure regions, allowing developers to select the region closest to them.
|
This module adds a parameter with all Azure regions, allowing developers to select the region closest to them.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "azure_region" {
|
module "azure_region" {
|
||||||
source = "registry.coder.com/modules/azure-region/coder"
|
source = "registry.coder.com/modules/azure-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "eastus"
|
default = "eastus"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -31,15 +31,15 @@ resource "azurem_resource_group" "example" {
|
|||||||
|
|
||||||
Change the display name and icon for a region using the corresponding maps:
|
Change the display name and icon for a region using the corresponding maps:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "azure-region" {
|
module "azure-region" {
|
||||||
source = "registry.coder.com/modules/azure-region/coder"
|
source = "registry.coder.com/modules/azure-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
custom_names = {
|
custom_names = {
|
||||||
"australia": "Go Australia!"
|
"australia" : "Go Australia!"
|
||||||
}
|
}
|
||||||
custom_icons = {
|
custom_icons = {
|
||||||
"australia": "/icons/smiley.svg"
|
"australia" : "/icons/smiley.svg"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -54,10 +54,10 @@ resource "azurerm_resource_group" "example" {
|
|||||||
|
|
||||||
Hide all regions in Australia except australiacentral:
|
Hide all regions in Australia except australiacentral:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "azure-region" {
|
module "azure-region" {
|
||||||
source = "registry.coder.com/modules/azure-region/coder"
|
source = "registry.coder.com/modules/azure-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
exclude = [
|
exclude = [
|
||||||
"australia",
|
"australia",
|
||||||
"australiacentral2",
|
"australiacentral2",
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ tags: [helper, ide, web]
|
|||||||
|
|
||||||
Automatically install [code-server](https://github.com/coder/code-server) in a workspace, create an app to access it via the dashboard, install extensions, and pre-configure editor settings.
|
Automatically install [code-server](https://github.com/coder/code-server) in a workspace, create an app to access it via the dashboard, install extensions, and pre-configure editor settings.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "code-server" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -25,10 +25,10 @@ module "code-server" {
|
|||||||
|
|
||||||
### Pin Versions
|
### Pin Versions
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "code-server" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
install_version = "4.8.3"
|
install_version = "4.8.3"
|
||||||
}
|
}
|
||||||
@@ -38,10 +38,10 @@ module "code-server" {
|
|||||||
|
|
||||||
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
|
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "code-server" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
extensions = [
|
extensions = [
|
||||||
"dracula-theme.theme-dracula"
|
"dracula-theme.theme-dracula"
|
||||||
@@ -55,12 +55,12 @@ Enter the `<author>.<name>` into the extensions array and code-server will autom
|
|||||||
|
|
||||||
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
|
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "settings" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
extensions = [ "dracula-theme.theme-dracula" ]
|
extensions = ["dracula-theme.theme-dracula"]
|
||||||
settings = {
|
settings = {
|
||||||
"workbench.colorTheme" = "Dracula"
|
"workbench.colorTheme" = "Dracula"
|
||||||
}
|
}
|
||||||
@@ -71,24 +71,38 @@ module "settings" {
|
|||||||
|
|
||||||
Just run code-server in the background, don't fetch it from GitHub:
|
Just run code-server in the background, don't fetch it from GitHub:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "settings" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
extensions = [ "dracula-theme.theme-dracula", "ms-azuretools.vscode-docker" ]
|
extensions = ["dracula-theme.theme-dracula", "ms-azuretools.vscode-docker"]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Offline Mode
|
### Offline and Use Cached Modes
|
||||||
|
|
||||||
|
By default the module looks for code-server at `/tmp/code-server` but this can be changed with `install_prefix`.
|
||||||
|
|
||||||
|
Run an existing copy of code-server if found, otherwise download from GitHub:
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "code-server" {
|
||||||
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
use_cached = true
|
||||||
|
extensions = ["dracula-theme.theme-dracula", "ms-azuretools.vscode-docker"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Just run code-server in the background, don't fetch it from GitHub:
|
Just run code-server in the background, don't fetch it from GitHub:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "settings" {
|
module "code-server" {
|
||||||
source = "registry.coder.com/modules/code-server/coder"
|
source = "registry.coder.com/modules/code-server/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
offline = true
|
offline = true
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,5 +1,9 @@
|
|||||||
import { describe, expect, it } from "bun:test";
|
import { describe, expect, it } from "bun:test";
|
||||||
import { runTerraformInit, testRequiredVariables } from "../test";
|
import {
|
||||||
|
runTerraformApply,
|
||||||
|
runTerraformInit,
|
||||||
|
testRequiredVariables,
|
||||||
|
} from "../test";
|
||||||
|
|
||||||
describe("code-server", async () => {
|
describe("code-server", async () => {
|
||||||
await runTerraformInit(import.meta.dir);
|
await runTerraformInit(import.meta.dir);
|
||||||
@@ -8,5 +12,27 @@ describe("code-server", async () => {
|
|||||||
agent_id: "foo",
|
agent_id: "foo",
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("use_cached and offline can not be used together", () => {
|
||||||
|
const t = async () => {
|
||||||
|
await runTerraformApply(import.meta.dir, {
|
||||||
|
agent_id: "foo",
|
||||||
|
use_cached: "true",
|
||||||
|
offline: "true",
|
||||||
|
});
|
||||||
|
};
|
||||||
|
expect(t).toThrow("Offline and Use Cached can not be used together");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("offline and extensions can not be used together", () => {
|
||||||
|
const t = async () => {
|
||||||
|
await runTerraformApply(import.meta.dir, {
|
||||||
|
agent_id: "foo",
|
||||||
|
offline: "true",
|
||||||
|
extensions: '["1", "2"]',
|
||||||
|
});
|
||||||
|
};
|
||||||
|
expect(t).toThrow("Offline mode does not allow extensions to be installed");
|
||||||
|
});
|
||||||
|
|
||||||
// More tests depend on shebang refactors
|
// More tests depend on shebang refactors
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -32,6 +32,12 @@ variable "display_name" {
|
|||||||
default = "code-server"
|
default = "code-server"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "slug" {
|
||||||
|
type = string
|
||||||
|
description = "The slug for the code-server application."
|
||||||
|
default = "code-server"
|
||||||
|
}
|
||||||
|
|
||||||
variable "settings" {
|
variable "settings" {
|
||||||
type = map(string)
|
type = map(string)
|
||||||
description = "A map of settings to apply to code-server."
|
description = "A map of settings to apply to code-server."
|
||||||
@@ -71,6 +77,24 @@ variable "share" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "offline" {
|
||||||
|
type = bool
|
||||||
|
description = "Just run code-server in the background, don't fetch it from GitHub"
|
||||||
|
default = false
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "use_cached" {
|
||||||
|
type = bool
|
||||||
|
description = "Uses cached copy code-server in the background, otherwise fetched it from GitHub"
|
||||||
|
default = false
|
||||||
|
}
|
||||||
|
|
||||||
resource "coder_script" "code-server" {
|
resource "coder_script" "code-server" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
display_name = "code-server"
|
display_name = "code-server"
|
||||||
@@ -78,23 +102,39 @@ resource "coder_script" "code-server" {
|
|||||||
script = templatefile("${path.module}/run.sh", {
|
script = templatefile("${path.module}/run.sh", {
|
||||||
VERSION : var.install_version,
|
VERSION : var.install_version,
|
||||||
EXTENSIONS : join(",", var.extensions),
|
EXTENSIONS : join(",", var.extensions),
|
||||||
|
APP_NAME : var.display_name,
|
||||||
PORT : var.port,
|
PORT : var.port,
|
||||||
LOG_PATH : var.log_path,
|
LOG_PATH : var.log_path,
|
||||||
INSTALL_PREFIX : var.install_prefix,
|
INSTALL_PREFIX : var.install_prefix,
|
||||||
// This is necessary otherwise the quotes are stripped!
|
// This is necessary otherwise the quotes are stripped!
|
||||||
SETTINGS : replace(jsonencode(var.settings), "\"", "\\\""),
|
SETTINGS : replace(jsonencode(var.settings), "\"", "\\\""),
|
||||||
|
OFFLINE : var.offline,
|
||||||
|
USE_CACHED : var.use_cached,
|
||||||
})
|
})
|
||||||
run_on_start = true
|
run_on_start = true
|
||||||
|
|
||||||
|
lifecycle {
|
||||||
|
precondition {
|
||||||
|
condition = !var.offline || length(var.extensions) == 0
|
||||||
|
error_message = "Offline mode does not allow extensions to be installed"
|
||||||
|
}
|
||||||
|
|
||||||
|
precondition {
|
||||||
|
condition = !var.offline || !var.use_cached
|
||||||
|
error_message = "Offline and Use Cached can not be used together"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "coder_app" "code-server" {
|
resource "coder_app" "code-server" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
slug = "code-server"
|
slug = var.slug
|
||||||
display_name = var.display_name
|
display_name = var.display_name
|
||||||
url = "http://localhost:${var.port}/${var.folder != "" ? "?folder=${urlencode(var.folder)}" : ""}"
|
url = "http://localhost:${var.port}/${var.folder != "" ? "?folder=${urlencode(var.folder)}" : ""}"
|
||||||
icon = "/icon/code.svg"
|
icon = "/icon/code.svg"
|
||||||
subdomain = false
|
subdomain = false
|
||||||
share = var.share
|
share = var.share
|
||||||
|
order = var.order
|
||||||
|
|
||||||
healthcheck {
|
healthcheck {
|
||||||
url = "http://localhost:${var.port}/healthz"
|
url = "http://localhost:${var.port}/healthz"
|
||||||
|
|||||||
@@ -4,6 +4,34 @@ EXTENSIONS=("${EXTENSIONS}")
|
|||||||
BOLD='\033[0;1m'
|
BOLD='\033[0;1m'
|
||||||
CODE='\033[36;40;1m'
|
CODE='\033[36;40;1m'
|
||||||
RESET='\033[0m'
|
RESET='\033[0m'
|
||||||
|
CODE_SERVER="${INSTALL_PREFIX}/bin/code-server"
|
||||||
|
|
||||||
|
function run_code_server() {
|
||||||
|
echo "👷 Running code-server in the background..."
|
||||||
|
echo "Check logs at ${LOG_PATH}!"
|
||||||
|
$CODE_SERVER --auth none --port "${PORT}" --app-name "${APP_NAME}" > "${LOG_PATH}" 2>&1 &
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if the settings file exists...
|
||||||
|
if [ ! -f ~/.local/share/code-server/User/settings.json ]; then
|
||||||
|
echo "⚙️ Creating settings file..."
|
||||||
|
mkdir -p ~/.local/share/code-server/User
|
||||||
|
echo "${SETTINGS}" > ~/.local/share/code-server/User/settings.json
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if code-server is already installed for offline or cached mode
|
||||||
|
if [ -f "$CODE_SERVER" ]; then
|
||||||
|
if [ "${OFFLINE}" = true ] || [ "${USE_CACHED}" = true ]; then
|
||||||
|
echo "🥳 Found a copy of code-server"
|
||||||
|
run_code_server
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
# Offline mode always expects a copy of code-server to be present
|
||||||
|
if [ "${OFFLINE}" = true ]; then
|
||||||
|
echo "Failed to find a copy of code-server"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
printf "$${BOLD}Installing code-server!\n"
|
printf "$${BOLD}Installing code-server!\n"
|
||||||
|
|
||||||
@@ -22,8 +50,6 @@ if [ $? -ne 0 ]; then
|
|||||||
fi
|
fi
|
||||||
printf "🥳 code-server has been installed in ${INSTALL_PREFIX}\n\n"
|
printf "🥳 code-server has been installed in ${INSTALL_PREFIX}\n\n"
|
||||||
|
|
||||||
CODE_SERVER="${INSTALL_PREFIX}/bin/code-server"
|
|
||||||
|
|
||||||
# Install each extension...
|
# Install each extension...
|
||||||
IFS=',' read -r -a EXTENSIONLIST <<< "$${EXTENSIONS}"
|
IFS=',' read -r -a EXTENSIONLIST <<< "$${EXTENSIONS}"
|
||||||
for extension in "$${EXTENSIONLIST[@]}"; do
|
for extension in "$${EXTENSIONLIST[@]}"; do
|
||||||
@@ -38,13 +64,4 @@ for extension in "$${EXTENSIONLIST[@]}"; do
|
|||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|
||||||
# Check if the settings file exists...
|
run_code_server
|
||||||
if [ ! -f ~/.local/share/code-server/User/settings.json ]; then
|
|
||||||
echo "⚙️ Creating settings file..."
|
|
||||||
mkdir -p ~/.local/share/code-server/User
|
|
||||||
echo "${SETTINGS}" > ~/.local/share/code-server/User/settings.json
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "👷 Running code-server in the background..."
|
|
||||||
echo "Check logs at ${LOG_PATH}!"
|
|
||||||
$CODE_SERVER --auth none --port ${PORT} > ${LOG_PATH} 2>&1 &
|
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ tags: [helper]
|
|||||||
|
|
||||||
Automatically logs the user into Coder when creating their workspace.
|
Automatically logs the user into Coder when creating their workspace.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "coder-login" {
|
module "coder-login" {
|
||||||
source = "registry.coder.com/modules/coder-login/coder"
|
source = "registry.coder.com/modules/coder-login/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ tags: [helper]
|
|||||||
|
|
||||||
Allow developers to optionally bring their own [dotfiles repository](https://dotfiles.github.io)! Under the hood, this module uses the [coder dotfiles](https://coder.com/docs/v2/latest/dotfiles) command.
|
Allow developers to optionally bring their own [dotfiles repository](https://dotfiles.github.io)! Under the hood, this module uses the [coder dotfiles](https://coder.com/docs/v2/latest/dotfiles) command.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "dotfiles" {
|
module "dotfiles" {
|
||||||
source = "registry.coder.com/modules/dotfiles/coder"
|
source = "registry.coder.com/modules/dotfiles/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -10,20 +10,20 @@ tags: [helper, parameter, instances, exoscale]
|
|||||||
# exoscale-instance-type
|
# exoscale-instance-type
|
||||||
|
|
||||||
A parameter with all Exoscale instance types. This allows developers to select
|
A parameter with all Exoscale instance types. This allows developers to select
|
||||||
their desired virtuell machine for the workspace.
|
their desired virtual machine for the workspace.
|
||||||
|
|
||||||
Customize the preselected parameter value:
|
Customize the preselected parameter value:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "exoscale-instance-type" {
|
module "exoscale-instance-type" {
|
||||||
source = "registry.coder.com/modules/exoscale-instance-type/coder"
|
source = "registry.coder.com/modules/exoscale-instance-type/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "standard.medium"
|
default = "standard.medium"
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "exoscale_compute_instance" "instance" {
|
resource "exoscale_compute_instance" "instance" {
|
||||||
type = module.exoscale-instance-type.value
|
type = module.exoscale-instance-type.value
|
||||||
...
|
# ...
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "coder_metadata" "workspace_info" {
|
resource "coder_metadata" "workspace_info" {
|
||||||
@@ -42,22 +42,24 @@ resource "coder_metadata" "workspace_info" {
|
|||||||
|
|
||||||
Change the display name a type using the corresponding maps:
|
Change the display name a type using the corresponding maps:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "exoscale-instance-type" {
|
module "exoscale-instance-type" {
|
||||||
source = "registry.coder.com/modules/exoscale-instance-type/coder"
|
source = "registry.coder.com/modules/exoscale-instance-type/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "standard.medium"
|
default = "standard.medium"
|
||||||
|
|
||||||
custom_names = {
|
custom_names = {
|
||||||
"standard.medium": "Mittlere Instanz" # German translation
|
"standard.medium" : "Mittlere Instanz" # German translation
|
||||||
}
|
}
|
||||||
|
|
||||||
custom_descriptions = {
|
custom_descriptions = {
|
||||||
"standard.medium": "4 GB Arbeitsspeicher, 2 Kerne, 10 - 400 GB Festplatte" # German translation
|
"standard.medium" : "4 GB Arbeitsspeicher, 2 Kerne, 10 - 400 GB Festplatte" # German translation
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "exoscale_compute_instance" "instance" {
|
resource "exoscale_compute_instance" "instance" {
|
||||||
type = module.exoscale-instance-type.value
|
type = module.exoscale-instance-type.value
|
||||||
...
|
# ...
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "coder_metadata" "workspace_info" {
|
resource "coder_metadata" "workspace_info" {
|
||||||
@@ -70,17 +72,17 @@ resource "coder_metadata" "workspace_info" {
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Use category and exlude type
|
### Use category and exclude type
|
||||||
|
|
||||||
Show only gpu1 types
|
Show only gpu1 types
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "exoscale-instance-type" {
|
module "exoscale-instance-type" {
|
||||||
source = "registry.coder.com/modules/exoscale-instance-type/coder"
|
source = "registry.coder.com/modules/exoscale-instance-type/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "gpu.large"
|
default = "gpu.large"
|
||||||
type_category = ["gpu"]
|
type_category = ["gpu"]
|
||||||
exclude = [
|
exclude = [
|
||||||
"gpu2.small",
|
"gpu2.small",
|
||||||
"gpu2.medium",
|
"gpu2.medium",
|
||||||
"gpu2.large",
|
"gpu2.large",
|
||||||
@@ -93,8 +95,8 @@ module "exoscale-instance-type" {
|
|||||||
}
|
}
|
||||||
|
|
||||||
resource "exoscale_compute_instance" "instance" {
|
resource "exoscale_compute_instance" "instance" {
|
||||||
type = module.exoscale-instance-type.value
|
type = module.exoscale-instance-type.value
|
||||||
...
|
# ...
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "coder_metadata" "workspace_info" {
|
resource "coder_metadata" "workspace_info" {
|
||||||
|
|||||||
@@ -14,10 +14,10 @@ the zone closest to them.
|
|||||||
|
|
||||||
Customize the preselected parameter value:
|
Customize the preselected parameter value:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "exoscale-zone" {
|
module "exoscale-zone" {
|
||||||
source = "registry.coder.com/modules/exoscale-zone/coder"
|
source = "registry.coder.com/modules/exoscale-zone/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "ch-dk-2"
|
default = "ch-dk-2"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -28,8 +28,8 @@ data "exoscale_compute_template" "my_template" {
|
|||||||
}
|
}
|
||||||
|
|
||||||
resource "exoscale_compute_instance" "instance" {
|
resource "exoscale_compute_instance" "instance" {
|
||||||
zone = module.exoscale-zone.value
|
zone = module.exoscale-zone.value
|
||||||
....
|
# ...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -41,16 +41,18 @@ resource "exoscale_compute_instance" "instance" {
|
|||||||
|
|
||||||
Change the display name and icon for a zone using the corresponding maps:
|
Change the display name and icon for a zone using the corresponding maps:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "exoscale-zone" {
|
module "exoscale-zone" {
|
||||||
source = "registry.coder.com/modules/exoscale-zone/coder"
|
source = "registry.coder.com/modules/exoscale-zone/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "at-vie-1"
|
default = "at-vie-1"
|
||||||
|
|
||||||
custom_names = {
|
custom_names = {
|
||||||
"at-vie-1": "Home Vienna"
|
"at-vie-1" : "Home Vienna"
|
||||||
}
|
}
|
||||||
|
|
||||||
custom_icons = {
|
custom_icons = {
|
||||||
"at-vie-1": "/emojis/1f3e0.png"
|
"at-vie-1" : "/emojis/1f3e0.png"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -60,8 +62,8 @@ data "exoscale_compute_template" "my_template" {
|
|||||||
}
|
}
|
||||||
|
|
||||||
resource "exoscale_compute_instance" "instance" {
|
resource "exoscale_compute_instance" "instance" {
|
||||||
zone = module.exoscale-zone.value
|
zone = module.exoscale-zone.value
|
||||||
....
|
# ...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -71,11 +73,11 @@ resource "exoscale_compute_instance" "instance" {
|
|||||||
|
|
||||||
Hide the Switzerland zones Geneva and Zurich
|
Hide the Switzerland zones Geneva and Zurich
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "exoscale-zone" {
|
module "exoscale-zone" {
|
||||||
source = "registry.coder.com/modules/exoscale-zone/coder"
|
source = "registry.coder.com/modules/exoscale-zone/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
exclude = [ "ch-gva-2", "ch-dk-2" ]
|
exclude = ["ch-gva-2", "ch-dk-2"]
|
||||||
}
|
}
|
||||||
|
|
||||||
data "exoscale_compute_template" "my_template" {
|
data "exoscale_compute_template" "my_template" {
|
||||||
@@ -84,8 +86,8 @@ data "exoscale_compute_template" "my_template" {
|
|||||||
}
|
}
|
||||||
|
|
||||||
resource "exoscale_compute_instance" "instance" {
|
resource "exoscale_compute_instance" "instance" {
|
||||||
zone = module.exoscale-zone.value
|
zone = module.exoscale-zone.value
|
||||||
....
|
# ...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ tags: [helper, filebrowser]
|
|||||||
|
|
||||||
A file browser for your workspace.
|
A file browser for your workspace.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "filebrowser" {
|
module "filebrowser" {
|
||||||
source = "registry.coder.com/modules/filebrowser/coder"
|
source = "registry.coder.com/modules/filebrowser/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -25,22 +25,22 @@ module "filebrowser" {
|
|||||||
|
|
||||||
### Serve a specific directory
|
### Serve a specific directory
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "filebrowser" {
|
module "filebrowser" {
|
||||||
source = "registry.coder.com/modules/filebrowser/coder"
|
source = "registry.coder.com/modules/filebrowser/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
folder = "/home/coder/project"
|
folder = "/home/coder/project"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Specify location of `filebrowser.db`
|
### Specify location of `filebrowser.db`
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "filebrowser" {
|
module "filebrowser" {
|
||||||
source = "registry.coder.com/modules/filebrowser/coder"
|
source = "registry.coder.com/modules/filebrowser/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
database_path = ".config/filebrowser.db"
|
database_path = ".config/filebrowser.db"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ describe("filebrowser", async () => {
|
|||||||
expect(output.stdout).toEqual([
|
expect(output.stdout).toEqual([
|
||||||
"\u001b[0;1mInstalling filebrowser ",
|
"\u001b[0;1mInstalling filebrowser ",
|
||||||
"",
|
"",
|
||||||
"🥳 Installation comlete! ",
|
"🥳 Installation complete! ",
|
||||||
"",
|
"",
|
||||||
"👷 Starting filebrowser in background... ",
|
"👷 Starting filebrowser in background... ",
|
||||||
"",
|
"",
|
||||||
@@ -55,7 +55,7 @@ describe("filebrowser", async () => {
|
|||||||
expect(output.stdout).toEqual([
|
expect(output.stdout).toEqual([
|
||||||
"\u001b[0;1mInstalling filebrowser ",
|
"\u001b[0;1mInstalling filebrowser ",
|
||||||
"",
|
"",
|
||||||
"🥳 Installation comlete! ",
|
"🥳 Installation complete! ",
|
||||||
"",
|
"",
|
||||||
"👷 Starting filebrowser in background... ",
|
"👷 Starting filebrowser in background... ",
|
||||||
"",
|
"",
|
||||||
@@ -77,7 +77,7 @@ describe("filebrowser", async () => {
|
|||||||
expect(output.stdout).toEqual([
|
expect(output.stdout).toEqual([
|
||||||
"\u001B[0;1mInstalling filebrowser ",
|
"\u001B[0;1mInstalling filebrowser ",
|
||||||
"",
|
"",
|
||||||
"🥳 Installation comlete! ",
|
"🥳 Installation complete! ",
|
||||||
"",
|
"",
|
||||||
"👷 Starting filebrowser in background... ",
|
"👷 Starting filebrowser in background... ",
|
||||||
"",
|
"",
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -52,6 +52,12 @@ variable "share" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
resource "coder_script" "filebrowser" {
|
resource "coder_script" "filebrowser" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
display_name = "File Browser"
|
display_name = "File Browser"
|
||||||
@@ -74,4 +80,5 @@ resource "coder_app" "filebrowser" {
|
|||||||
icon = "https://raw.githubusercontent.com/filebrowser/logo/master/icon_raw.svg"
|
icon = "https://raw.githubusercontent.com/filebrowser/logo/master/icon_raw.svg"
|
||||||
subdomain = true
|
subdomain = true
|
||||||
share = var.share
|
share = var.share
|
||||||
|
order = var.order
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ printf "$${BOLD}Installing filebrowser \n\n"
|
|||||||
|
|
||||||
curl -fsSL https://raw.githubusercontent.com/filebrowser/get/master/get.sh | bash
|
curl -fsSL https://raw.githubusercontent.com/filebrowser/get/master/get.sh | bash
|
||||||
|
|
||||||
printf "🥳 Installation comlete! \n\n"
|
printf "🥳 Installation complete! \n\n"
|
||||||
|
|
||||||
printf "👷 Starting filebrowser in background... \n\n"
|
printf "👷 Starting filebrowser in background... \n\n"
|
||||||
|
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ This module adds Fly.io regions to your Coder template. Regions can be whitelist
|
|||||||
|
|
||||||
We can use the simplest format here, only adding a default selection as the `atl` region.
|
We can use the simplest format here, only adding a default selection as the `atl` region.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "fly-region" {
|
module "fly-region" {
|
||||||
source = "registry.coder.com/modules/fly-region/coder"
|
source = "registry.coder.com/modules/fly-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "atl"
|
default = "atl"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -29,10 +29,10 @@ module "fly-region" {
|
|||||||
|
|
||||||
The regions argument can be used to display only the desired regions in the Coder parameter.
|
The regions argument can be used to display only the desired regions in the Coder parameter.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "fly-region" {
|
module "fly-region" {
|
||||||
source = "registry.coder.com/modules/fly-region/coder"
|
source = "registry.coder.com/modules/fly-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "ams"
|
default = "ams"
|
||||||
regions = ["ams", "arn", "atl"]
|
regions = ["ams", "arn", "atl"]
|
||||||
}
|
}
|
||||||
@@ -44,16 +44,18 @@ module "fly-region" {
|
|||||||
|
|
||||||
Set custom icons and names with their respective maps.
|
Set custom icons and names with their respective maps.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "fly-region" {
|
module "fly-region" {
|
||||||
source = "registry.coder.com/modules/fly-region/coder"
|
source = "registry.coder.com/modules/fly-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = "ams"
|
default = "ams"
|
||||||
|
|
||||||
custom_icons = {
|
custom_icons = {
|
||||||
"ams" = "/emojis/1f90e.png"
|
"ams" = "/emojis/1f90e.png"
|
||||||
}
|
}
|
||||||
|
|
||||||
custom_names = {
|
custom_names = {
|
||||||
"ams" = "We love the Netherlands!"
|
"ams" = "We love the Netherlands!"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ tags: [gcp, regions, parameter, helper]
|
|||||||
|
|
||||||
This module adds Google Cloud Platform regions to your Coder template.
|
This module adds Google Cloud Platform regions to your Coder template.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "gcp_region" {
|
module "gcp_region" {
|
||||||
source = "registry.coder.com/modules/gcp-region/coder"
|
source = "registry.coder.com/modules/gcp-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
regions = ["us", "europe"]
|
regions = ["us", "europe"]
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -31,10 +31,10 @@ resource "google_compute_instance" "example" {
|
|||||||
|
|
||||||
Note: setting `gpu_only = true` and using a default region without GPU support, the default will be set to `null`.
|
Note: setting `gpu_only = true` and using a default region without GPU support, the default will be set to `null`.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "gcp_region" {
|
module "gcp_region" {
|
||||||
source = "registry.coder.com/modules/gcp-region/coder"
|
source = "registry.coder.com/modules/gcp-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
default = ["us-west1-a"]
|
default = ["us-west1-a"]
|
||||||
regions = ["us-west1"]
|
regions = ["us-west1"]
|
||||||
gpu_only = false
|
gpu_only = false
|
||||||
@@ -47,10 +47,10 @@ resource "google_compute_instance" "example" {
|
|||||||
|
|
||||||
### Add all zones in the Europe West region
|
### Add all zones in the Europe West region
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "gcp_region" {
|
module "gcp_region" {
|
||||||
source = "registry.coder.com/modules/gcp-region/coder"
|
source = "registry.coder.com/modules/gcp-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
regions = ["europe-west"]
|
regions = ["europe-west"]
|
||||||
single_zone_per_region = false
|
single_zone_per_region = false
|
||||||
}
|
}
|
||||||
@@ -60,12 +60,12 @@ resource "google_compute_instance" "example" {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Add a single zone from each region in US and Europe that laos has GPUs
|
### Add a single zone from each region in US and Europe that has GPUs
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "gcp_region" {
|
module "gcp_region" {
|
||||||
source = "registry.coder.com/modules/gcp-region/coder"
|
source = "registry.coder.com/modules/gcp-region/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
regions = ["us", "europe"]
|
regions = ["us", "europe"]
|
||||||
gpu_only = true
|
gpu_only = true
|
||||||
single_zone_per_region = true
|
single_zone_per_region = true
|
||||||
|
|||||||
@@ -9,35 +9,44 @@ tags: [git, helper]
|
|||||||
|
|
||||||
# Git Clone
|
# Git Clone
|
||||||
|
|
||||||
This module allows you to automatically clone a repository by URL and skip if it exists in the path provided.
|
This module allows you to automatically clone a repository by URL and skip if it exists in the base directory provided.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "git-clone" {
|
module "git-clone" {
|
||||||
source = "registry.coder.com/modules/git-clone/coder"
|
source = "registry.coder.com/modules/git-clone/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
url = "https://github.com/coder/coder"
|
url = "https://github.com/coder/coder"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
To use with [Git Authentication](https://coder.com/docs/v2/latest/admin/git-providers), add the provider by ID to your template:
|
|
||||||
|
|
||||||
```hcl
|
|
||||||
data "coder_git_auth" "github" {
|
|
||||||
id = "github"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
### Custom Path
|
### Custom Path
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "git-clone" {
|
module "git-clone" {
|
||||||
source = "registry.coder.com/modules/git-clone/coder"
|
source = "registry.coder.com/modules/git-clone/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
url = "https://github.com/coder/coder"
|
url = "https://github.com/coder/coder"
|
||||||
path = "~/projects/coder/coder"
|
base_dir = "~/projects/coder"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Git Authentication
|
||||||
|
|
||||||
|
To use with [Git Authentication](https://coder.com/docs/v2/latest/admin/git-providers), add the provider by ID to your template:
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "git-clone" {
|
||||||
|
source = "registry.coder.com/modules/git-clone/coder"
|
||||||
|
version = "1.0.2"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
url = "https://github.com/coder/coder"
|
||||||
|
}
|
||||||
|
|
||||||
|
data "coder_git_auth" "github" {
|
||||||
|
id = "github"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -14,9 +14,9 @@ variable "url" {
|
|||||||
type = string
|
type = string
|
||||||
}
|
}
|
||||||
|
|
||||||
variable "path" {
|
variable "base_dir" {
|
||||||
default = ""
|
default = ""
|
||||||
description = "The path to clone the repository. Defaults to \"$HOME/<basename of url>\"."
|
description = "The base directory to clone the repository. Defaults to \"$HOME\"."
|
||||||
type = string
|
type = string
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -25,10 +25,19 @@ variable "agent_id" {
|
|||||||
type = string
|
type = string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
locals {
|
||||||
|
clone_path = var.base_dir != "" ? join("/", [var.base_dir, replace(basename(var.url), ".git", "")]) : join("/", ["~", replace(basename(var.url), ".git", "")])
|
||||||
|
}
|
||||||
|
|
||||||
|
output "repo_dir" {
|
||||||
|
value = local.clone_path
|
||||||
|
description = "Full path of cloned repo directory"
|
||||||
|
}
|
||||||
|
|
||||||
resource "coder_script" "git_clone" {
|
resource "coder_script" "git_clone" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
script = templatefile("${path.module}/run.sh", {
|
script = templatefile("${path.module}/run.sh", {
|
||||||
CLONE_PATH = var.path != "" ? join("/", [var.path, replace(basename(var.url), ".git", "")]) : join("/", ["~", replace(basename(var.url), ".git", "")])
|
CLONE_PATH = local.clone_path
|
||||||
REPO_URL : var.url,
|
REPO_URL : var.url,
|
||||||
})
|
})
|
||||||
display_name = "Git Clone"
|
display_name = "Git Clone"
|
||||||
|
|||||||
@@ -16,10 +16,10 @@ Please observe that using the SSH key that's part of your Coder account for comm
|
|||||||
|
|
||||||
This module has a chance of conflicting with the user's dotfiles / the personalize module if one of those has configuration directives that overwrite this module's / each other's git configuration.
|
This module has a chance of conflicting with the user's dotfiles / the personalize module if one of those has configuration directives that overwrite this module's / each other's git configuration.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "git-commit-signing" {
|
module "git-commit-signing" {
|
||||||
source = "registry.coder.com/modules/git-commit-signing/coder"
|
source = "registry.coder.com/modules/git-commit-signing/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.9"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ variable "agent_id" {
|
|||||||
|
|
||||||
resource "coder_script" "git-commit-signing" {
|
resource "coder_script" "git-commit-signing" {
|
||||||
display_name = "Git commit signing"
|
display_name = "Git commit signing"
|
||||||
icon = "https://raw.githubusercontent.com/coder/modules/main/.icons/git.svg"
|
icon = "/icon/git.svg"
|
||||||
|
|
||||||
script = file("${path.module}/run.sh")
|
script = file("${path.module}/run.sh")
|
||||||
run_on_start = true
|
run_on_start = true
|
||||||
|
|||||||
@@ -21,7 +21,8 @@ echo "Downloading SSH key"
|
|||||||
|
|
||||||
ssh_key=$(curl --request GET \
|
ssh_key=$(curl --request GET \
|
||||||
--url "${CODER_AGENT_URL}api/v2/workspaceagents/me/gitsshkey" \
|
--url "${CODER_AGENT_URL}api/v2/workspaceagents/me/gitsshkey" \
|
||||||
--header "Coder-Session-Token: ${CODER_AGENT_TOKEN}")
|
--header "Coder-Session-Token: ${CODER_AGENT_TOKEN}" \
|
||||||
|
--silent --show-error)
|
||||||
|
|
||||||
jq --raw-output ".public_key" > ~/.ssh/git-commit-signing/coder.pub << EOF
|
jq --raw-output ".public_key" > ~/.ssh/git-commit-signing/coder.pub << EOF
|
||||||
$ssh_key
|
$ssh_key
|
||||||
@@ -31,8 +32,8 @@ jq --raw-output ".private_key" > ~/.ssh/git-commit-signing/coder << EOF
|
|||||||
$ssh_key
|
$ssh_key
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
chmod -R 400 ~/.ssh/git-commit-signing/coder
|
chmod -R 600 ~/.ssh/git-commit-signing/coder
|
||||||
chmod -R 400 ~/.ssh/git-commit-signing/coder.pub
|
chmod -R 644 ~/.ssh/git-commit-signing/coder.pub
|
||||||
|
|
||||||
echo "Configuring git to use the SSH key"
|
echo "Configuring git to use the SSH key"
|
||||||
|
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ tags: [helper, git]
|
|||||||
|
|
||||||
Runs a script that updates git credentials in the workspace to match the user's Coder credentials, optionally allowing to the developer to override the defaults.
|
Runs a script that updates git credentials in the workspace to match the user's Coder credentials, optionally allowing to the developer to override the defaults.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "git-config" {
|
module "git-config" {
|
||||||
source = "registry.coder.com/modules/git-config/coder"
|
source = "registry.coder.com/modules/git-config/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.3"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -25,11 +25,11 @@ TODO: Add screenshot
|
|||||||
|
|
||||||
### Allow users to override both username and email
|
### Allow users to override both username and email
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "git-config" {
|
module "git-config" {
|
||||||
source = "registry.coder.com/modules/git-config/coder"
|
source = "registry.coder.com/modules/git-config/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.3"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
allow_email_change = true
|
allow_email_change = true
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -38,14 +38,12 @@ TODO: Add screenshot
|
|||||||
|
|
||||||
## Disallowing users from overriding both username and email
|
## Disallowing users from overriding both username and email
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "git-config" {
|
module "git-config" {
|
||||||
source = "registry.coder.com/modules/git-config/coder"
|
source = "registry.coder.com/modules/git-config/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.3"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
allow_username_change = false
|
allow_username_change = false
|
||||||
allow_email_change = false
|
allow_email_change = false
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
TODO: Add screenshot
|
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
import { describe, expect, it } from "bun:test";
|
|
||||||
import {
|
|
||||||
executeScriptInContainer,
|
|
||||||
runTerraformApply,
|
|
||||||
runTerraformInit,
|
|
||||||
testRequiredVariables,
|
|
||||||
} from "../test";
|
|
||||||
|
|
||||||
describe("git-config", async () => {
|
|
||||||
await runTerraformInit(import.meta.dir);
|
|
||||||
|
|
||||||
testRequiredVariables(import.meta.dir, {
|
|
||||||
agent_id: "foo",
|
|
||||||
});
|
|
||||||
|
|
||||||
it("fails without git", async () => {
|
|
||||||
const state = await runTerraformApply(import.meta.dir, {
|
|
||||||
agent_id: "foo",
|
|
||||||
});
|
|
||||||
const output = await executeScriptInContainer(state, "alpine");
|
|
||||||
expect(output.exitCode).toBe(1);
|
|
||||||
expect(output.stdout).toEqual([
|
|
||||||
"\u001B[0;1mChecking git-config!",
|
|
||||||
"Git is not installed!",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("runs with git", async () => {
|
|
||||||
const state = await runTerraformApply(import.meta.dir, {
|
|
||||||
agent_id: "foo",
|
|
||||||
});
|
|
||||||
const output = await executeScriptInContainer(state, "alpine/git");
|
|
||||||
expect(output.exitCode).toBe(0);
|
|
||||||
expect(output.stdout).toEqual([
|
|
||||||
"\u001B[0;1mChecking git-config!",
|
|
||||||
"git-config: No user.email found, setting to ",
|
|
||||||
"git-config: No user.name found, setting to default",
|
|
||||||
"",
|
|
||||||
"\u001B[0;1mgit-config: using email: ",
|
|
||||||
"\u001B[0;1mgit-config: using username: default",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.13"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -34,7 +34,7 @@ data "coder_parameter" "user_email" {
|
|||||||
name = "user_email"
|
name = "user_email"
|
||||||
type = "string"
|
type = "string"
|
||||||
default = ""
|
default = ""
|
||||||
description = "Git user.email to be used for commits. Leave empty to default to Coder username."
|
description = "Git user.email to be used for commits. Leave empty to default to Coder user's email."
|
||||||
display_name = "Git config user.email"
|
display_name = "Git config user.email"
|
||||||
mutable = true
|
mutable = true
|
||||||
}
|
}
|
||||||
@@ -44,18 +44,31 @@ data "coder_parameter" "username" {
|
|||||||
name = "username"
|
name = "username"
|
||||||
type = "string"
|
type = "string"
|
||||||
default = ""
|
default = ""
|
||||||
description = "Git user.name to be used for commits. Leave empty to default to Coder username."
|
description = "Git user.name to be used for commits. Leave empty to default to Coder user's Full Name."
|
||||||
display_name = "Git config user.name"
|
display_name = "Full Name for Git config"
|
||||||
mutable = true
|
mutable = true
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "coder_script" "git_config" {
|
resource "coder_env" "git_author_name" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
script = templatefile("${path.module}/run.sh", {
|
name = "GIT_AUTHOR_NAME"
|
||||||
GIT_USERNAME = try(data.coder_parameter.username[0].value, "") == "" ? data.coder_workspace.me.owner : try(data.coder_parameter.username[0].value, "")
|
value = coalesce(try(data.coder_parameter.username[0].value, ""), data.coder_workspace.me.owner_name, data.coder_workspace.me.owner)
|
||||||
GIT_EMAIL = try(data.coder_parameter.user_email[0].value, "") == "" ? data.coder_workspace.me.owner_email : try(data.coder_parameter.user_email[0].value, "")
|
}
|
||||||
})
|
|
||||||
display_name = "Git Config"
|
resource "coder_env" "git_commmiter_name" {
|
||||||
icon = "/icon/git.svg"
|
agent_id = var.agent_id
|
||||||
run_on_start = true
|
name = "GIT_COMMITTER_NAME"
|
||||||
|
value = coalesce(try(data.coder_parameter.username[0].value, ""), data.coder_workspace.me.owner_name, data.coder_workspace.me.owner)
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_env" "git_author_email" {
|
||||||
|
agent_id = var.agent_id
|
||||||
|
name = "GIT_AUTHOR_EMAIL"
|
||||||
|
value = coalesce(try(data.coder_parameter.user_email[0].value, ""), data.coder_workspace.me.owner_email)
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_env" "git_commmiter_email" {
|
||||||
|
agent_id = var.agent_id
|
||||||
|
name = "GIT_COMMITTER_EMAIL"
|
||||||
|
value = coalesce(try(data.coder_parameter.user_email[0].value, ""), data.coder_workspace.me.owner_email)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
#!/usr/bin/env sh
|
|
||||||
|
|
||||||
BOLD='\033[0;1m'
|
|
||||||
printf "$${BOLD}Checking git-config!\n"
|
|
||||||
|
|
||||||
# Check if git is installed
|
|
||||||
command -v git > /dev/null 2>&1 || {
|
|
||||||
echo "Git is not installed!"
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# Set git username and email if missing
|
|
||||||
if [ -z $(git config --get user.email) ]; then
|
|
||||||
printf "git-config: No user.email found, setting to ${GIT_EMAIL}\n"
|
|
||||||
git config --global user.email "${GIT_EMAIL}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z $(git config --get user.name) ]; then
|
|
||||||
printf "git-config: No user.name found, setting to ${GIT_USERNAME}\n"
|
|
||||||
git config --global user.name "${GIT_USERNAME}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
printf "\n$${BOLD}git-config: using email: $(git config --get user.email)\n"
|
|
||||||
printf "$${BOLD}git-config: using username: $(git config --get user.name)\n\n"
|
|
||||||
80
hcp-vault-secrets/README.md
Normal file
80
hcp-vault-secrets/README.md
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
---
|
||||||
|
display_name: "HCP Vault Secrets"
|
||||||
|
description: "Fetch secrets from HCP Vault"
|
||||||
|
icon: ../.icons/vault.svg
|
||||||
|
maintainer_github: coder
|
||||||
|
partner_github: hashicorp
|
||||||
|
verified: true
|
||||||
|
tags: [helper, integration, vault, hashicorp, hvs]
|
||||||
|
---
|
||||||
|
|
||||||
|
# HCP Vault Secrets
|
||||||
|
|
||||||
|
This module lets you fetch all or selective secrets from a [HCP Vault Secrets](https://developer.hashicorp.com/hcp/docs/vault-secrets) app into your [Coder](https://coder.com) workspaces. It makes use of the [`hcp_vault_secrets_app`](https://registry.terraform.io/providers/hashicorp/hcp/latest/docs/data-sources/vault_secrets_app) data source from the [HCP provider](https://registry.terraform.io/providers/hashicorp/hcp/latest).
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "vault" {
|
||||||
|
source = "registry.coder.com/modules/hcp-vault-secrets/coder"
|
||||||
|
version = "1.0.7"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
app_name = "demo-app"
|
||||||
|
project_id = "aaa-bbb-ccc"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
To configure the HCP Vault Secrets module, follow these steps,
|
||||||
|
|
||||||
|
1. [Create secrets in HCP Vault Secrets](https://developer.hashicorp.com/vault/tutorials/hcp-vault-secrets-get-started/hcp-vault-secrets-create-secret)
|
||||||
|
2. Create an HCP Service Principal from the HCP Vault Secrets app in the HCP console. This will give you the `HCP_CLIENT_ID` and `HCP_CLIENT_SECRET` that you need to authenticate with HCP Vault Secrets.
|
||||||
|

|
||||||
|
3. Set `HCP_CLIENT_ID` and `HCP_CLIENT_SECRET` variables on the coder provisioner (recommended) or supply them as input to the module.
|
||||||
|
4. Set the `project_id`. This is the ID of the project where the HCP Vault Secrets app is running.
|
||||||
|
|
||||||
|
> See the [HCP Vault Secrets documentation](https://developer.hashicorp.com/hcp/docs/vault-secrets) for more information.
|
||||||
|
|
||||||
|
## Fetch All Secrets
|
||||||
|
|
||||||
|
To fetch all secrets from the HCP Vault Secrets app, skip the `secrets` input.
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "vault" {
|
||||||
|
source = "registry.coder.com/modules/hcp-vault-secrets/coder"
|
||||||
|
version = "1.0.7"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
app_name = "demo-app"
|
||||||
|
project_id = "aaa-bbb-ccc"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fetch Selective Secrets
|
||||||
|
|
||||||
|
To fetch selective secrets from the HCP Vault Secrets app, set the `secrets` input.
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "vault" {
|
||||||
|
source = "registry.coder.com/modules/hcp-vault-secrets/coder"
|
||||||
|
version = "1.0.7"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
app_name = "demo-app"
|
||||||
|
project_id = "aaa-bbb-ccc"
|
||||||
|
secrets = ["MY_SECRET_1", "MY_SECRET_2"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Set Client ID and Client Secret as Inputs
|
||||||
|
|
||||||
|
Set `client_id` and `client_secret` as module inputs.
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "vault" {
|
||||||
|
source = "registry.coder.com/modules/hcp-vault-secrets/coder"
|
||||||
|
version = "1.0.7"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
app_name = "demo-app"
|
||||||
|
project_id = "aaa-bbb-ccc"
|
||||||
|
client_id = "HCP_CLIENT_ID"
|
||||||
|
client_secret = "HCP_CLIENT_SECRET"
|
||||||
|
}
|
||||||
|
```
|
||||||
73
hcp-vault-secrets/main.tf
Normal file
73
hcp-vault-secrets/main.tf
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
terraform {
|
||||||
|
required_version = ">= 1.0"
|
||||||
|
|
||||||
|
required_providers {
|
||||||
|
coder = {
|
||||||
|
source = "coder/coder"
|
||||||
|
version = ">= 0.12.4"
|
||||||
|
}
|
||||||
|
hcp = {
|
||||||
|
source = "hashicorp/hcp"
|
||||||
|
version = ">= 0.82.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
provider "hcp" {
|
||||||
|
client_id = var.client_id
|
||||||
|
client_secret = var.client_secret
|
||||||
|
project_id = var.project_id
|
||||||
|
}
|
||||||
|
|
||||||
|
provider "coder" {}
|
||||||
|
|
||||||
|
variable "agent_id" {
|
||||||
|
type = string
|
||||||
|
description = "The ID of a Coder agent."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "project_id" {
|
||||||
|
type = string
|
||||||
|
description = "The ID of the HCP project."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "client_id" {
|
||||||
|
type = string
|
||||||
|
description = <<-EOF
|
||||||
|
The client ID for the HCP Vault Secrets service principal. (Optional if HCP_CLIENT_ID is set as an environment variable.)
|
||||||
|
EOF
|
||||||
|
default = null
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "client_secret" {
|
||||||
|
type = string
|
||||||
|
description = <<-EOF
|
||||||
|
The client secret for the HCP Vault Secrets service principal. (Optional if HCP_CLIENT_SECRET is set as an environment variable.)
|
||||||
|
EOF
|
||||||
|
default = null
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "app_name" {
|
||||||
|
type = string
|
||||||
|
description = "The name of the secrets app in HCP Vault Secrets"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "secrets" {
|
||||||
|
type = list(string)
|
||||||
|
description = "The names of the secrets to retrieve from HCP Vault Secrets"
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
|
data "hcp_vault_secrets_app" "secrets" {
|
||||||
|
app_name = var.app_name
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_env" "hvs_secrets" {
|
||||||
|
# https://support.hashicorp.com/hc/en-us/articles/4538432032787-Variable-has-a-sensitive-value-and-cannot-be-used-as-for-each-arguments
|
||||||
|
for_each = var.secrets != null ? toset(var.secrets) : nonsensitive(toset(keys(data.hcp_vault_secrets_app.secrets.secrets)))
|
||||||
|
agent_id = var.agent_id
|
||||||
|
name = each.key
|
||||||
|
value = data.hcp_vault_secrets_app.secrets.secrets[each.key]
|
||||||
|
}
|
||||||
@@ -11,14 +11,15 @@ tags: [ide, jetbrains, helper, parameter]
|
|||||||
|
|
||||||
This module adds a JetBrains Gateway Button to open any workspace with a single click.
|
This module adds a JetBrains Gateway Button to open any workspace with a single click.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jetbrains_gateway" {
|
module "jetbrains_gateway" {
|
||||||
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.9"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
|
agent_name = "example"
|
||||||
folder = "/home/coder/example"
|
folder = "/home/coder/example"
|
||||||
jetbrains_ides = ["GO", "WS", "IU", "PY", "PS", "CL", "RM"]
|
jetbrains_ides = ["CL", "GO", "IU", "PY", "WS"]
|
||||||
default = "PY"
|
default = "GO"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -28,14 +29,15 @@ module "jetbrains_gateway" {
|
|||||||
|
|
||||||
### Add GoLand and WebStorm with the default set to GoLand
|
### Add GoLand and WebStorm with the default set to GoLand
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jetbrains_gateway" {
|
module "jetbrains_gateway" {
|
||||||
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
source = "registry.coder.com/modules/jetbrains-gateway/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.9"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
folder = "/home/coder/example"
|
agent_name = "example"
|
||||||
jetbrains_ides = ["GO", "WS"]
|
folder = "/home/coder/example"
|
||||||
default = "GO"
|
jetbrains_ides = ["GO", "WS"]
|
||||||
|
default = "GO"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -50,3 +52,4 @@ This module and JetBrains Gateway support the following JetBrains IDEs:
|
|||||||
- PhpStorm (`PS`)
|
- PhpStorm (`PS`)
|
||||||
- CLion (`CL`)
|
- CLion (`CL`)
|
||||||
- RubyMine (`RM`)
|
- RubyMine (`RM`)
|
||||||
|
- Rider (`RD`)
|
||||||
|
|||||||
@@ -11,18 +11,16 @@ describe("jetbrains-gateway", async () => {
|
|||||||
await testRequiredVariables(import.meta.dir, {
|
await testRequiredVariables(import.meta.dir, {
|
||||||
agent_id: "foo",
|
agent_id: "foo",
|
||||||
agent_name: "foo",
|
agent_name: "foo",
|
||||||
folder: "/baz/",
|
folder: "/home/foo",
|
||||||
});
|
});
|
||||||
|
|
||||||
it("default to first ide", async () => {
|
it("default to first ide", async () => {
|
||||||
const state = await runTerraformApply(import.meta.dir, {
|
const state = await runTerraformApply(import.meta.dir, {
|
||||||
agent_id: "foo",
|
agent_id: "foo",
|
||||||
agent_name: "foo",
|
agent_name: "foo",
|
||||||
folder: "/baz/",
|
folder: "/home/foo",
|
||||||
jetbrains_ides: '["IU", "GO", "PY"]',
|
jetbrains_ides: '["IU", "GO", "PY"]',
|
||||||
});
|
});
|
||||||
expect(state.outputs.jetbrains_ides.value).toBe(
|
expect(state.outputs.identifier.value).toBe("IU");
|
||||||
'["IU","232.10203.10","https://download.jetbrains.com/idea/ideaIU-2023.2.4.tar.gz"]',
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.11"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -22,6 +22,10 @@ variable "agent_name" {
|
|||||||
variable "folder" {
|
variable "folder" {
|
||||||
type = string
|
type = string
|
||||||
description = "The directory to open in the IDE. e.g. /home/coder/project"
|
description = "The directory to open in the IDE. e.g. /home/coder/project"
|
||||||
|
validation {
|
||||||
|
condition = can(regex("^(?:/[^/]+)+$", var.folder))
|
||||||
|
error_message = "The folder must be a full path and must not start with a ~."
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
variable "default" {
|
variable "default" {
|
||||||
@@ -30,17 +34,79 @@ variable "default" {
|
|||||||
description = "Default IDE"
|
description = "Default IDE"
|
||||||
}
|
}
|
||||||
|
|
||||||
variable "jetbrains_ides" {
|
variable "order" {
|
||||||
type = list(string)
|
type = number
|
||||||
description = "The list of IDE product codes."
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
default = ["IU", "PS", "WS", "PY", "CL", "GO", "RM"]
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "coder_parameter_order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "jetbrains_ide_versions" {
|
||||||
|
type = map(object({
|
||||||
|
build_number = string
|
||||||
|
version = string
|
||||||
|
}))
|
||||||
|
description = "The set of versions for each jetbrains IDE"
|
||||||
|
default = {
|
||||||
|
"IU" = {
|
||||||
|
build_number = "241.14494.240"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"PS" = {
|
||||||
|
build_number = "241.14494.237"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"WS" = {
|
||||||
|
build_number = "241.14494.235"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"PY" = {
|
||||||
|
build_number = "241.14494.241"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"CL" = {
|
||||||
|
build_number = "241.14494.288"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"GO" = {
|
||||||
|
build_number = "241.14494.238"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"RM" = {
|
||||||
|
build_number = "241.14494.234"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
"RD" = {
|
||||||
|
build_number = "241.14494.307"
|
||||||
|
version = "2024.1"
|
||||||
|
}
|
||||||
|
}
|
||||||
validation {
|
validation {
|
||||||
condition = (
|
condition = (
|
||||||
alltrue([
|
alltrue([
|
||||||
for code in var.jetbrains_ides : contains(["IU", "PS", "WS", "PY", "CL", "GO", "RM"], code)
|
for code in keys(var.jetbrains_ide_versions) : contains(["IU", "PS", "WS", "PY", "CL", "GO", "RM", "RD"], code)
|
||||||
])
|
])
|
||||||
)
|
)
|
||||||
error_message = "The jetbrains_ides must be a list of valid product codes. Valid product codes are IU, PS, WS, PY, CL, GO, RM."
|
error_message = "The jetbrains_ide_versions must contain a map of valid product codes. Valid product codes are ${join(",", ["IU", "PS", "WS", "PY", "CL", "GO", "RM", "RD"])}."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "jetbrains_ides" {
|
||||||
|
type = list(string)
|
||||||
|
description = "The list of IDE product codes."
|
||||||
|
default = ["IU", "PS", "WS", "PY", "CL", "GO", "RM", "RD"]
|
||||||
|
validation {
|
||||||
|
condition = (
|
||||||
|
alltrue([
|
||||||
|
for code in var.jetbrains_ides : contains(["IU", "PS", "WS", "PY", "CL", "GO", "RM", "RD"], code)
|
||||||
|
])
|
||||||
|
)
|
||||||
|
error_message = "The jetbrains_ides must be a list of valid product codes. Valid product codes are ${join(",", ["IU", "PS", "WS", "PY", "CL", "GO", "RM", "RD"])}."
|
||||||
}
|
}
|
||||||
# check if the list is empty
|
# check if the list is empty
|
||||||
validation {
|
validation {
|
||||||
@@ -57,58 +123,79 @@ variable "jetbrains_ides" {
|
|||||||
locals {
|
locals {
|
||||||
jetbrains_ides = {
|
jetbrains_ides = {
|
||||||
"GO" = {
|
"GO" = {
|
||||||
icon = "/icon/goland.svg",
|
icon = "/icon/goland.svg",
|
||||||
name = "GoLand",
|
name = "GoLand",
|
||||||
value = jsonencode(["GO", "232.10203.20", "https://download.jetbrains.com/go/goland-2023.2.4.tar.gz"])
|
identifier = "GO",
|
||||||
|
build_number = var.jetbrains_ide_versions["GO"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/go/goland-${var.jetbrains_ide_versions["GO"].version}.tar.gz"
|
||||||
},
|
},
|
||||||
"WS" = {
|
"WS" = {
|
||||||
icon = "/icon/webstorm.svg",
|
icon = "/icon/webstorm.svg",
|
||||||
name = "WebStorm",
|
name = "WebStorm",
|
||||||
value = jsonencode(["WS", "232.10203.14", "https://download.jetbrains.com/webstorm/WebStorm-2023.2.4.tar.gz"])
|
identifier = "WS",
|
||||||
|
build_number = var.jetbrains_ide_versions["WS"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/webstorm/WebStorm-${var.jetbrains_ide_versions["WS"].version}.tar.gz"
|
||||||
},
|
},
|
||||||
"IU" = {
|
"IU" = {
|
||||||
icon = "/icon/intellij.svg",
|
icon = "/icon/intellij.svg",
|
||||||
name = "IntelliJ IDEA Ultimate",
|
name = "IntelliJ IDEA Ultimate",
|
||||||
value = jsonencode(["IU", "232.10203.10", "https://download.jetbrains.com/idea/ideaIU-2023.2.4.tar.gz"])
|
identifier = "IU",
|
||||||
|
build_number = var.jetbrains_ide_versions["IU"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/idea/ideaIU-${var.jetbrains_ide_versions["IU"].version}.tar.gz"
|
||||||
},
|
},
|
||||||
"PY" = {
|
"PY" = {
|
||||||
icon = "/icon/pycharm.svg",
|
icon = "/icon/pycharm.svg",
|
||||||
name = "PyCharm Professional",
|
name = "PyCharm Professional",
|
||||||
value = jsonencode(["PY", "232.10203.26", "https://download.jetbrains.com/python/pycharm-professional-2023.2.4.tar.gz"])
|
identifier = "PY",
|
||||||
|
build_number = var.jetbrains_ide_versions["PY"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/python/pycharm-professional-${var.jetbrains_ide_versions["PY"].version}.tar.gz"
|
||||||
},
|
},
|
||||||
"CL" = {
|
"CL" = {
|
||||||
icon = "/icon/clion.svg",
|
icon = "/icon/clion.svg",
|
||||||
name = "CLion",
|
name = "CLion",
|
||||||
value = jsonencode(["CL", "232.9921.42", "https://download.jetbrains.com/cpp/CLion-2023.2.2.tar.gz"])
|
identifier = "CL",
|
||||||
|
build_number = var.jetbrains_ide_versions["CL"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/cpp/CLion-${var.jetbrains_ide_versions["CL"].version}.tar.gz"
|
||||||
},
|
},
|
||||||
"PS" = {
|
"PS" = {
|
||||||
icon = "/icon/phpstorm.svg",
|
icon = "/icon/phpstorm.svg",
|
||||||
name = "PhpStorm",
|
name = "PhpStorm",
|
||||||
value = jsonencode(["PS", "232.10072.32", "https://download.jetbrains.com/webide/PhpStorm-2023.2.3.tar.gz"])
|
identifier = "PS",
|
||||||
|
build_number = var.jetbrains_ide_versions["PS"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/webide/PhpStorm-${var.jetbrains_ide_versions["PS"].version}.tar.gz"
|
||||||
},
|
},
|
||||||
"RM" = {
|
"RM" = {
|
||||||
icon = "/icon/rubymine.svg",
|
icon = "/icon/rubymine.svg",
|
||||||
name = "RubyMine",
|
name = "RubyMine",
|
||||||
value = jsonencode(["RM", "232.10203.15", "https://download.jetbrains.com/ruby/RubyMine-2023.2.4.tar.gz"])
|
identifier = "RM",
|
||||||
|
build_number = var.jetbrains_ide_versions["RM"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/ruby/RubyMine-${var.jetbrains_ide_versions["RM"].version}.tar.gz"
|
||||||
|
}
|
||||||
|
"RD" = {
|
||||||
|
icon = "/icon/rider.svg",
|
||||||
|
name = "Rider",
|
||||||
|
identifier = "RD",
|
||||||
|
build_number = var.jetbrains_ide_versions["RD"].build_number,
|
||||||
|
download_link = "https://download.jetbrains.com/rider/JetBrains.Rider-${var.jetbrains_ide_versions["RD"].version}.tar.gz"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
data "coder_parameter" "jetbrains_ide" {
|
data "coder_parameter" "jetbrains_ide" {
|
||||||
type = "list(string)"
|
type = "string"
|
||||||
name = "jetbrains_ide"
|
name = "jetbrains_ide"
|
||||||
display_name = "JetBrains IDE"
|
display_name = "JetBrains IDE"
|
||||||
icon = "/icon/gateway.svg"
|
icon = "/icon/gateway.svg"
|
||||||
mutable = true
|
mutable = true
|
||||||
# check if default is in the jet_brains_ides list and if it is not empty or null otherwise set it to null
|
default = var.default == "" ? var.jetbrains_ides[0] : var.default
|
||||||
default = var.default != null && var.default != "" && contains(var.jetbrains_ides, var.default) ? local.jetbrains_ides[var.default].value : local.jetbrains_ides[var.jetbrains_ides[0]].value
|
order = var.coder_parameter_order
|
||||||
|
|
||||||
dynamic "option" {
|
dynamic "option" {
|
||||||
for_each = { for key, value in local.jetbrains_ides : key => value if contains(var.jetbrains_ides, key) }
|
for_each = var.jetbrains_ides
|
||||||
content {
|
content {
|
||||||
icon = option.value.icon
|
icon = lookup(local.jetbrains_ides, option.value).icon
|
||||||
name = option.value.name
|
name = lookup(local.jetbrains_ides, option.value).name
|
||||||
value = option.value.value
|
value = lookup(local.jetbrains_ides, option.value).identifier
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -117,10 +204,11 @@ data "coder_workspace" "me" {}
|
|||||||
|
|
||||||
resource "coder_app" "gateway" {
|
resource "coder_app" "gateway" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
display_name = data.coder_parameter.jetbrains_ide.option[index(data.coder_parameter.jetbrains_ide.option.*.value, data.coder_parameter.jetbrains_ide.value)].name
|
|
||||||
slug = "gateway"
|
slug = "gateway"
|
||||||
icon = data.coder_parameter.jetbrains_ide.option[index(data.coder_parameter.jetbrains_ide.option.*.value, data.coder_parameter.jetbrains_ide.value)].icon
|
display_name = try(lookup(local.jetbrains_ides, data.coder_parameter.jetbrains_ide.value).name, "JetBrains IDE")
|
||||||
|
icon = try(lookup(local.jetbrains_ides, data.coder_parameter.jetbrains_ide.value).icon, "/icon/gateway.svg")
|
||||||
external = true
|
external = true
|
||||||
|
order = var.order
|
||||||
url = join("", [
|
url = join("", [
|
||||||
"jetbrains-gateway://connect#type=coder&workspace=",
|
"jetbrains-gateway://connect#type=coder&workspace=",
|
||||||
data.coder_workspace.me.name,
|
data.coder_workspace.me.name,
|
||||||
@@ -133,14 +221,38 @@ resource "coder_app" "gateway" {
|
|||||||
"&token=",
|
"&token=",
|
||||||
"$SESSION_TOKEN",
|
"$SESSION_TOKEN",
|
||||||
"&ide_product_code=",
|
"&ide_product_code=",
|
||||||
jsondecode(data.coder_parameter.jetbrains_ide.value)[0],
|
local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].identifier,
|
||||||
"&ide_build_number=",
|
"&ide_build_number=",
|
||||||
jsondecode(data.coder_parameter.jetbrains_ide.value)[1],
|
local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].build_number,
|
||||||
"&ide_download_link=",
|
"&ide_download_link=",
|
||||||
jsondecode(data.coder_parameter.jetbrains_ide.value)[2],
|
local.jetbrains_ides[data.coder_parameter.jetbrains_ide.value].download_link
|
||||||
])
|
])
|
||||||
}
|
}
|
||||||
|
|
||||||
output "jetbrains_ides" {
|
output "identifier" {
|
||||||
value = data.coder_parameter.jetbrains_ide.value
|
value = data.coder_parameter.jetbrains_ide.value
|
||||||
}
|
}
|
||||||
|
|
||||||
|
output "name" {
|
||||||
|
value = coder_app.gateway.display_name
|
||||||
|
}
|
||||||
|
|
||||||
|
output "icon" {
|
||||||
|
value = coder_app.gateway.icon
|
||||||
|
}
|
||||||
|
|
||||||
|
output "download_link" {
|
||||||
|
value = lookup(local.jetbrains_ides, data.coder_parameter.jetbrains_ide.value).download_link
|
||||||
|
}
|
||||||
|
|
||||||
|
output "build_number" {
|
||||||
|
value = lookup(local.jetbrains_ides, data.coder_parameter.jetbrains_ide.value).build_number
|
||||||
|
}
|
||||||
|
|
||||||
|
output "version" {
|
||||||
|
value = var.jetbrains_ide_versions[data.coder_parameter.jetbrains_ide.value].version
|
||||||
|
}
|
||||||
|
|
||||||
|
output "url" {
|
||||||
|
value = coder_app.gateway.url
|
||||||
|
}
|
||||||
|
|||||||
@@ -10,23 +10,22 @@ tags: [integration, jfrog]
|
|||||||
|
|
||||||
# JFrog
|
# JFrog
|
||||||
|
|
||||||
Install the JF CLI and authenticate package managers with Artifactory using OAuth configured via the Coder `external-auth` feature.
|
Install the JF CLI and authenticate package managers with Artifactory using OAuth configured via the Coder [`external-auth`](https://coder.com/docs/v2/latest/admin/external-auth) feature.
|
||||||
|
|
||||||
<p align="center">
|

|
||||||
<img src='../.images/jfrog-oauth.png' alt="JFrog OAuth" width='600'>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
source = "registry.coder.com/modules/jfrog-oauth/coder"
|
source = "registry.coder.com/modules/jfrog-oauth/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.5"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
jfrog_url = "https://jfrog.example.com"
|
jfrog_url = "https://example.jfrog.io"
|
||||||
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
|
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
|
||||||
|
|
||||||
package_managers = {
|
package_managers = {
|
||||||
"npm": "npm",
|
"npm" : "npm",
|
||||||
"go": "go",
|
"go" : "go",
|
||||||
"pypi": "pypi"
|
"pypi" : "pypi"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -36,64 +35,22 @@ module "jfrog" {
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Coder [`external-auth`](https://coder.com/docs/v2/latest/admin/external-auth) configured with Artifactory. This requires a [custom integration](https://jfrog.com/help/r/jfrog-installation-setup-documentation/enable-new-integrations) in Artifactory with **Callback URL** set to `https://<your-coder-url>/external-auth/jfrog/callback`.
|
This module is usable by JFrog self-hosted (on-premises) Artifactory as it requires configuring a custom integration. This integration benefits from Coder's [external-auth](https://coder.com/docs/v2/latest/admin/external-auth) feature and allows each user to authenticate with Artifactory using an OAuth flow and issues user-scoped tokens to each user. For configuration instructions, see this [guide](https://coder.com/docs/v2/latest/guides/artifactory-integration#jfrog-oauth) on the Coder documentation.
|
||||||
|
|
||||||
To set this up,
|
|
||||||
|
|
||||||
1. Modify your `values.yaml` for JFrog Artifactory to add,
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
artifactory:
|
|
||||||
enabled: true
|
|
||||||
frontend:
|
|
||||||
extraEnvironmentVariables:
|
|
||||||
- name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION
|
|
||||||
value: "true"
|
|
||||||
access:
|
|
||||||
accessConfig:
|
|
||||||
integrations-enabled: true
|
|
||||||
integration-templates:
|
|
||||||
- id: "1"
|
|
||||||
name: "CODER"
|
|
||||||
redirect-uri: "https://CODER_URL/external-auth/jfrog/callback"
|
|
||||||
scope: "applied-permissions/user"
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note
|
|
||||||
> Replace `CODER_URL` with your Coder deployment URL, e.g., <coder.example.com>
|
|
||||||
|
|
||||||
2. Add a new [external authetication](https://coder.com/docs/v2/latest/admin/external-auth) to Coder by setting these env variables,
|
|
||||||
|
|
||||||
```env
|
|
||||||
# JFrog Artifactory External Auth
|
|
||||||
CODER_EXTERNAL_AUTH_1_ID="jfrog"
|
|
||||||
CODER_EXTERNAL_AUTH_1_TYPE="jfrog"
|
|
||||||
CODER_EXTERNAL_AUTH_1_CLIENT_ID="YYYYYYYYYYYYYYY"
|
|
||||||
CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXX"
|
|
||||||
CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="JFrog Artifactory"
|
|
||||||
CODER_EXTERNAL_AUTH_1_DISPLAY_ICON="/icon/jfrog.svg"
|
|
||||||
CODER_EXTERNAL_AUTH_1_AUTH_URL="https://JFROG_URL/ui/authorization"
|
|
||||||
CODER_EXTERNAL_AUTH_1_TOKEN_URL="https://JFROG_URL/access/api/v1/integrations/YYYYYYYYYYYYYYY/token"
|
|
||||||
CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note
|
|
||||||
> Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g., <artifactory.example.com>
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Configure the Python pip package manager to fetch packages from Artifactory while mapping the Coder email to the Artifactory username.
|
Configure the Python pip package manager to fetch packages from Artifactory while mapping the Coder email to the Artifactory username.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
source = "registry.coder.com/modules/jfrog-oauth/coder"
|
source = "registry.coder.com/modules/jfrog-oauth/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.5"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
jfrog_url = "https://jfrog.example.com"
|
jfrog_url = "https://example.jfrog.io"
|
||||||
auth_method = "oauth"
|
|
||||||
username_field = "email"
|
username_field = "email"
|
||||||
|
|
||||||
package_managers = {
|
package_managers = {
|
||||||
"pypi": "pypi"
|
"pypi" : "pypi"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -112,18 +69,18 @@ pip install requests
|
|||||||
|
|
||||||
The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extension) for VS Code allows you to interact with Artifactory from within the IDE.
|
The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extension) for VS Code allows you to interact with Artifactory from within the IDE.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
source = "registry.coder.com/modules/jfrog-oauth/coder"
|
source = "registry.coder.com/modules/jfrog-oauth/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.5"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
jfrog_url = "https://jfrog.example.com"
|
jfrog_url = "https://example.jfrog.io"
|
||||||
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
|
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
|
||||||
configure_code_server = true # Add JFrog extension configuration for code-server
|
configure_code_server = true # Add JFrog extension configuration for code-server
|
||||||
package_managers = {
|
package_managers = {
|
||||||
"npm": "npm",
|
"npm" : "npm",
|
||||||
"go": "go",
|
"go" : "go",
|
||||||
"pypi": "pypi"
|
"pypi" : "pypi"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -132,14 +89,15 @@ module "jfrog" {
|
|||||||
|
|
||||||
JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
|
JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
|
|
||||||
provider "docker" {
|
provider "docker" {
|
||||||
...
|
# ...
|
||||||
registry_auth {
|
registry_auth {
|
||||||
address = "https://YYYY.jfrog.io/artifactory/api/docker/REPO-KEY"
|
address = "https://example.jfrog.io/artifactory/api/docker/REPO-KEY"
|
||||||
username = module.jfrog.username
|
username = module.jfrog.username
|
||||||
password = module.jfrog.access_token
|
password = module.jfrog.access_token
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> Here `REPO_KEY` is the name of docker repository in Artifactory.
|
||||||
|
|||||||
@@ -19,6 +19,12 @@ variable "jfrog_url" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "jfrog_server_id" {
|
||||||
|
type = string
|
||||||
|
description = "The server ID of the JFrog instance for JFrog CLI configuration"
|
||||||
|
default = "0"
|
||||||
|
}
|
||||||
|
|
||||||
variable "username_field" {
|
variable "username_field" {
|
||||||
type = string
|
type = string
|
||||||
description = "The field to use for the artifactory username. i.e. Coder username or email."
|
description = "The field to use for the artifactory username. i.e. Coder username or email."
|
||||||
@@ -79,6 +85,7 @@ resource "coder_script" "jfrog" {
|
|||||||
script = templatefile("${path.module}/run.sh", {
|
script = templatefile("${path.module}/run.sh", {
|
||||||
JFROG_URL : var.jfrog_url,
|
JFROG_URL : var.jfrog_url,
|
||||||
JFROG_HOST : local.jfrog_host,
|
JFROG_HOST : local.jfrog_host,
|
||||||
|
JFROG_SERVER_ID : var.jfrog_server_id,
|
||||||
ARTIFACTORY_USERNAME : local.username,
|
ARTIFACTORY_USERNAME : local.username,
|
||||||
ARTIFACTORY_EMAIL : data.coder_workspace.me.owner_email,
|
ARTIFACTORY_EMAIL : data.coder_workspace.me.owner_email,
|
||||||
ARTIFACTORY_ACCESS_TOKEN : data.coder_external_auth.jfrog.access_token,
|
ARTIFACTORY_ACCESS_TOKEN : data.coder_external_auth.jfrog.access_token,
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ fi
|
|||||||
# flows.
|
# flows.
|
||||||
export CI=true
|
export CI=true
|
||||||
# Authenticate JFrog CLI with Artifactory.
|
# Authenticate JFrog CLI with Artifactory.
|
||||||
echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" --overwrite 0
|
echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" --overwrite "${JFROG_SERVER_ID}"
|
||||||
# Set the configured server as the default.
|
# Set the configured server as the default.
|
||||||
jf c use 0
|
jf c use "${JFROG_SERVER_ID}"
|
||||||
|
|
||||||
# Configure npm to use the Artifactory "npm" repository.
|
# Configure npm to use the Artifactory "npm" repository.
|
||||||
if [ -z "${REPOSITORY_NPM}" ]; then
|
if [ -z "${REPOSITORY_NPM}" ]; then
|
||||||
|
|||||||
@@ -12,29 +12,22 @@ tags: [integration, jfrog]
|
|||||||
|
|
||||||
Install the JF CLI and authenticate package managers with Artifactory using Artifactory terraform provider.
|
Install the JF CLI and authenticate package managers with Artifactory using Artifactory terraform provider.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
source = "registry.coder.com/modules/jfrog-token/coder"
|
source = "registry.coder.com/modules/jfrog-token/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
jfrog_url = "https://XXXX.jfrog.io"
|
jfrog_url = "https://XXXX.jfrog.io"
|
||||||
artifactory_access_token = var.artifactory_access_token
|
artifactory_access_token = var.artifactory_access_token
|
||||||
package_managers = {
|
package_managers = {
|
||||||
"npm": "npm",
|
"npm" : "npm",
|
||||||
"go": "go",
|
"go" : "go",
|
||||||
"pypi": "pypi"
|
"pypi" : "pypi"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Get a JFrog access token from your Artifactory instance. The token must be an [admin token](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token). It is recommended to store the token in a secret terraform variable.
|
For detailed instructions, please see this [guide](https://coder.com/docs/v2/latest/guides/artifactory-integration#jfrog-token) on the Coder documentation.
|
||||||
|
|
||||||
```hcl
|
|
||||||
variable "artifactory_access_token" {
|
|
||||||
type = string
|
|
||||||
sensitive = true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note
|
> Note
|
||||||
> This module does not install `npm`, `go`, `pip`, etc but only configure them. You need to handle the installation of these tools yourself.
|
> This module does not install `npm`, `go`, `pip`, etc but only configure them. You need to handle the installation of these tools yourself.
|
||||||
@@ -45,17 +38,17 @@ variable "artifactory_access_token" {
|
|||||||
|
|
||||||
### Configure npm, go, and pypi to use Artifactory local repositories
|
### Configure npm, go, and pypi to use Artifactory local repositories
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
source = "registry.coder.com/modules/jfrog-token/coder"
|
source = "registry.coder.com/modules/jfrog-token/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
jfrog_url = "https://YYYY.jfrog.io"
|
jfrog_url = "https://YYYY.jfrog.io"
|
||||||
artifactory_access_token = var.artifactory_access_token # An admin access token
|
artifactory_access_token = var.artifactory_access_token # An admin access token
|
||||||
package_managers = {
|
package_managers = {
|
||||||
"npm": "npm-local",
|
"npm" : "npm-local",
|
||||||
"go": "go-local",
|
"go" : "go-local",
|
||||||
"pypi": "pypi-local"
|
"pypi" : "pypi-local"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -78,18 +71,38 @@ pip install requests
|
|||||||
|
|
||||||
The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extension) for VS Code allows you to interact with Artifactory from within the IDE.
|
The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extension) for VS Code allows you to interact with Artifactory from within the IDE.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jfrog" {
|
module "jfrog" {
|
||||||
source = "registry.coder.com/modules/jfrog-token/coder"
|
source = "registry.coder.com/modules/jfrog-token/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
jfrog_url = "https://XXXX.jfrog.io"
|
jfrog_url = "https://XXXX.jfrog.io"
|
||||||
artifactory_access_token = var.artifactory_access_token
|
artifactory_access_token = var.artifactory_access_token
|
||||||
configure_code_server = true # Add JFrog extension configuration for code-server
|
configure_code_server = true # Add JFrog extension configuration for code-server
|
||||||
package_managers = {
|
package_managers = {
|
||||||
"npm": "npm",
|
"npm" : "npm",
|
||||||
"go": "go",
|
"go" : "go",
|
||||||
"pypi": "pypi"
|
"pypi" : "pypi"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Add a custom token description
|
||||||
|
|
||||||
|
```tf
|
||||||
|
data "coder_workspace" "me" {}
|
||||||
|
|
||||||
|
module "jfrog" {
|
||||||
|
source = "registry.coder.com/modules/jfrog-token/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
jfrog_url = "https://XXXX.jfrog.io"
|
||||||
|
artifactory_access_token = var.artifactory_access_token
|
||||||
|
token_description = "Token for Coder workspace: ${data.coder_workspace.me.owner}/${data.coder_workspace.me.name}"
|
||||||
|
package_managers = {
|
||||||
|
"npm" : "npm",
|
||||||
|
"go" : "go",
|
||||||
|
"pypi" : "pypi"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -98,14 +111,16 @@ module "jfrog" {
|
|||||||
|
|
||||||
JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
|
JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
|
|
||||||
provider "docker" {
|
provider "docker" {
|
||||||
...
|
# ...
|
||||||
registry_auth {
|
registry_auth {
|
||||||
address = "https://YYYY.jfrog.io/artifactory/api/docker/REPO-KEY"
|
address = "https://YYYY.jfrog.io/artifactory/api/docker/REPO-KEY"
|
||||||
username = module.jfrog.username
|
username = module.jfrog.username
|
||||||
password = module.jfrog.access_token
|
password = module.jfrog.access_token
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> Here `REPO_KEY` is the name of docker repository in Artifactory.
|
||||||
|
|||||||
@@ -23,11 +23,23 @@ variable "jfrog_url" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "jfrog_server_id" {
|
||||||
|
type = string
|
||||||
|
description = "The server ID of the JFrog instance for JFrog CLI configuration"
|
||||||
|
default = "0"
|
||||||
|
}
|
||||||
|
|
||||||
variable "artifactory_access_token" {
|
variable "artifactory_access_token" {
|
||||||
type = string
|
type = string
|
||||||
description = "The admin-level access token to use for JFrog."
|
description = "The admin-level access token to use for JFrog."
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "token_description" {
|
||||||
|
type = string
|
||||||
|
description = "Free text token description. Useful for filtering and managing tokens."
|
||||||
|
default = "Token for Coder workspace"
|
||||||
|
}
|
||||||
|
|
||||||
variable "check_license" {
|
variable "check_license" {
|
||||||
type = bool
|
type = bool
|
||||||
description = "Toggle for pre-flight checking of Artifactory license. Default to `true`."
|
description = "Toggle for pre-flight checking of Artifactory license. Default to `true`."
|
||||||
@@ -101,6 +113,7 @@ resource "artifactory_scoped_token" "me" {
|
|||||||
scopes = ["applied-permissions/user"]
|
scopes = ["applied-permissions/user"]
|
||||||
refreshable = var.refreshable
|
refreshable = var.refreshable
|
||||||
expires_in = var.expires_in
|
expires_in = var.expires_in
|
||||||
|
description = var.token_description
|
||||||
}
|
}
|
||||||
|
|
||||||
data "coder_workspace" "me" {}
|
data "coder_workspace" "me" {}
|
||||||
@@ -112,6 +125,7 @@ resource "coder_script" "jfrog" {
|
|||||||
script = templatefile("${path.module}/run.sh", {
|
script = templatefile("${path.module}/run.sh", {
|
||||||
JFROG_URL : var.jfrog_url,
|
JFROG_URL : var.jfrog_url,
|
||||||
JFROG_HOST : local.jfrog_host,
|
JFROG_HOST : local.jfrog_host,
|
||||||
|
JFROG_SERVER_ID : var.jfrog_server_id,
|
||||||
ARTIFACTORY_USERNAME : local.username,
|
ARTIFACTORY_USERNAME : local.username,
|
||||||
ARTIFACTORY_EMAIL : data.coder_workspace.me.owner_email,
|
ARTIFACTORY_EMAIL : data.coder_workspace.me.owner_email,
|
||||||
ARTIFACTORY_ACCESS_TOKEN : artifactory_scoped_token.me.access_token,
|
ARTIFACTORY_ACCESS_TOKEN : artifactory_scoped_token.me.access_token,
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ fi
|
|||||||
# flows.
|
# flows.
|
||||||
export CI=true
|
export CI=true
|
||||||
# Authenticate JFrog CLI with Artifactory.
|
# Authenticate JFrog CLI with Artifactory.
|
||||||
echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" --overwrite 0
|
echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" --overwrite "${JFROG_SERVER_ID}"
|
||||||
# Set the configured server as the default.
|
# Set the configured server as the default.
|
||||||
jf c use 0
|
jf c use "${JFROG_SERVER_ID}"
|
||||||
|
|
||||||
# Configure npm to use the Artifactory "npm" repository.
|
# Configure npm to use the Artifactory "npm" repository.
|
||||||
if [ -z "${REPOSITORY_NPM}" ]; then
|
if [ -z "${REPOSITORY_NPM}" ]; then
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ A module that adds Jupyter Notebook in your Coder template.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jupyter-notebook" {
|
module "jupyter-notebook" {
|
||||||
source = "registry.coder.com/modules/jupyter-notebook/coder"
|
source = "registry.coder.com/modules/jupyter-notebook/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -36,6 +36,12 @@ variable "share" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
resource "coder_script" "jupyter-notebook" {
|
resource "coder_script" "jupyter-notebook" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
display_name = "jupyter-notebook"
|
display_name = "jupyter-notebook"
|
||||||
@@ -55,4 +61,5 @@ resource "coder_app" "jupyter-notebook" {
|
|||||||
icon = "/icon/jupyter.svg"
|
icon = "/icon/jupyter.svg"
|
||||||
subdomain = true
|
subdomain = true
|
||||||
share = var.share
|
share = var.share
|
||||||
|
order = var.order
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ A module that adds JupyterLab in your Coder template.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "jupyterlab" {
|
module "jupyterlab" {
|
||||||
source = "registry.coder.com/modules/jupyterlab/coder"
|
source = "registry.coder.com/modules/jupyterlab/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -36,6 +36,12 @@ variable "share" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
resource "coder_script" "jupyterlab" {
|
resource "coder_script" "jupyterlab" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
display_name = "jupyterlab"
|
display_name = "jupyterlab"
|
||||||
@@ -55,4 +61,5 @@ resource "coder_app" "jupyterlab" {
|
|||||||
icon = "/icon/jupyter.svg"
|
icon = "/icon/jupyter.svg"
|
||||||
subdomain = true
|
subdomain = true
|
||||||
share = var.share
|
share = var.share
|
||||||
|
order = var.order
|
||||||
}
|
}
|
||||||
|
|||||||
49
lint.ts
49
lint.ts
@@ -13,9 +13,39 @@ let badExit = false;
|
|||||||
// error reports an error to the console and sets badExit to true
|
// error reports an error to the console and sets badExit to true
|
||||||
// so that the process will exit with a non-zero exit code.
|
// so that the process will exit with a non-zero exit code.
|
||||||
const error = (...data: any[]) => {
|
const error = (...data: any[]) => {
|
||||||
console.error(...data);
|
console.error(...data);
|
||||||
badExit = true;
|
badExit = true;
|
||||||
}
|
};
|
||||||
|
|
||||||
|
const verifyCodeBlocks = (
|
||||||
|
tokens: marked.Token[],
|
||||||
|
res = {
|
||||||
|
codeIsTF: false,
|
||||||
|
codeIsHCL: false,
|
||||||
|
}
|
||||||
|
) => {
|
||||||
|
for (const token of tokens) {
|
||||||
|
// Check in-depth.
|
||||||
|
if (token.type === "list") {
|
||||||
|
verifyCodeBlocks(token.items, res);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (token.type === "list_item") {
|
||||||
|
verifyCodeBlocks(token.tokens, res);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (token.type === "code") {
|
||||||
|
if (token.lang === "tf") {
|
||||||
|
res.codeIsTF = true;
|
||||||
|
}
|
||||||
|
if (token.lang === "hcl") {
|
||||||
|
res.codeIsHCL = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return res;
|
||||||
|
};
|
||||||
|
|
||||||
// Ensures that each README has the proper format.
|
// Ensures that each README has the proper format.
|
||||||
// Exits with 0 if all is good!
|
// Exits with 0 if all is good!
|
||||||
@@ -62,6 +92,7 @@ for (const dir of dirs) {
|
|||||||
let h1 = false;
|
let h1 = false;
|
||||||
let code = false;
|
let code = false;
|
||||||
let paragraph = false;
|
let paragraph = false;
|
||||||
|
let version = true;
|
||||||
|
|
||||||
for (const token of tokens) {
|
for (const token of tokens) {
|
||||||
if (token.type === "heading" && token.depth === 1) {
|
if (token.type === "heading" && token.depth === 1) {
|
||||||
@@ -77,6 +108,10 @@ for (const dir of dirs) {
|
|||||||
}
|
}
|
||||||
if (token.type === "code") {
|
if (token.type === "code") {
|
||||||
code = true;
|
code = true;
|
||||||
|
if (token.lang === "tf" && !token.text.includes("version")) {
|
||||||
|
version = false;
|
||||||
|
error(dir.name, "missing version in tf code block");
|
||||||
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -89,6 +124,14 @@ for (const dir of dirs) {
|
|||||||
if (!code) {
|
if (!code) {
|
||||||
error(dir.name, "missing example code block after paragraph");
|
error(dir.name, "missing example code block after paragraph");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const { codeIsTF, codeIsHCL } = verifyCodeBlocks(tokens);
|
||||||
|
if (!codeIsTF) {
|
||||||
|
error(dir.name, "missing example tf code block");
|
||||||
|
}
|
||||||
|
if (codeIsHCL) {
|
||||||
|
error(dir.name, "hcl code block should be tf");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (badExit) {
|
if (badExit) {
|
||||||
|
|||||||
4
new.sh
4
new.sh
@@ -1,6 +1,6 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
# This scripts creates a new sample moduledir with requried files
|
# This scripts creates a new sample moduledir with required files
|
||||||
# Run it like : ./new.sh my-module
|
# Run it like : ./new.sh my-module
|
||||||
|
|
||||||
MODULE_NAME=$1
|
MODULE_NAME=$1
|
||||||
@@ -11,7 +11,7 @@ if [ -z "$MODULE_NAME" ]; then
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Create module directory and exit if it alredy exists
|
# Create module directory and exit if it already exists
|
||||||
if [ -d "$MODULE_NAME" ]; then
|
if [ -d "$MODULE_NAME" ]; then
|
||||||
echo "Module with name $MODULE_NAME already exists"
|
echo "Module with name $MODULE_NAME already exists"
|
||||||
echo "Please choose a different name"
|
echo "Please choose a different name"
|
||||||
|
|||||||
58
nodejs/README.md
Normal file
58
nodejs/README.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
---
|
||||||
|
display_name: nodejs
|
||||||
|
description: Install Node.js via nvm
|
||||||
|
icon: ../.icons/node.svg
|
||||||
|
maintainer_github: TheZoker
|
||||||
|
verified: false
|
||||||
|
tags: [helper]
|
||||||
|
---
|
||||||
|
|
||||||
|
# nodejs
|
||||||
|
|
||||||
|
Automatically installs [Node.js](https://github.com/nodejs/node) via [nvm](https://github.com/nvm-sh/nvm). It can also install multiple versions of node and set a default version. If no options are specified, the latest version is installed.
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "nodejs" {
|
||||||
|
source = "registry.coder.com/modules/nodejs/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install multiple versions
|
||||||
|
|
||||||
|
This installs multiple versions of Node.js:
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "nodejs" {
|
||||||
|
source = "registry.coder.com/modules/nodejs/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
node_versions = [
|
||||||
|
"18",
|
||||||
|
"20",
|
||||||
|
"node"
|
||||||
|
]
|
||||||
|
default_node_version = "20"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Full example
|
||||||
|
|
||||||
|
A example with all available options:
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "nodejs" {
|
||||||
|
source = "registry.coder.com/modules/nodejs/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
nvm_version = "v0.39.7"
|
||||||
|
nvm_install_prefix = "/opt/nvm"
|
||||||
|
node_versions = [
|
||||||
|
"16",
|
||||||
|
"18",
|
||||||
|
"node"
|
||||||
|
]
|
||||||
|
default_node_version = "16"
|
||||||
|
}
|
||||||
|
```
|
||||||
12
nodejs/main.test.ts
Normal file
12
nodejs/main.test.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { describe, expect, it } from "bun:test";
|
||||||
|
import { runTerraformInit, testRequiredVariables } from "../test";
|
||||||
|
|
||||||
|
describe("nodejs", async () => {
|
||||||
|
await runTerraformInit(import.meta.dir);
|
||||||
|
|
||||||
|
testRequiredVariables(import.meta.dir, {
|
||||||
|
agent_id: "foo",
|
||||||
|
});
|
||||||
|
|
||||||
|
// More tests depend on shebang refactors
|
||||||
|
});
|
||||||
52
nodejs/main.tf
Normal file
52
nodejs/main.tf
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
terraform {
|
||||||
|
required_version = ">= 1.0"
|
||||||
|
|
||||||
|
required_providers {
|
||||||
|
coder = {
|
||||||
|
source = "coder/coder"
|
||||||
|
version = ">= 0.12"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "agent_id" {
|
||||||
|
type = string
|
||||||
|
description = "The ID of a Coder agent."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "nvm_version" {
|
||||||
|
type = string
|
||||||
|
description = "The version of nvm to install."
|
||||||
|
default = "master"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "nvm_install_prefix" {
|
||||||
|
type = string
|
||||||
|
description = "The prefix to install nvm to (relative to $HOME)."
|
||||||
|
default = ".nvm"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "node_versions" {
|
||||||
|
type = list(string)
|
||||||
|
description = "A list of Node.js versions to install."
|
||||||
|
default = ["node"]
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "default_node_version" {
|
||||||
|
type = string
|
||||||
|
description = "The default Node.js version"
|
||||||
|
default = "node"
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_script" "nodejs" {
|
||||||
|
agent_id = var.agent_id
|
||||||
|
display_name = "Node.js:"
|
||||||
|
script = templatefile("${path.module}/run.sh", {
|
||||||
|
NVM_VERSION : var.nvm_version,
|
||||||
|
INSTALL_PREFIX : var.nvm_install_prefix,
|
||||||
|
NODE_VERSIONS : join(",", var.node_versions),
|
||||||
|
DEFAULT : var.default_node_version,
|
||||||
|
})
|
||||||
|
run_on_start = true
|
||||||
|
start_blocks_login = true
|
||||||
|
}
|
||||||
51
nodejs/run.sh
Executable file
51
nodejs/run.sh
Executable file
@@ -0,0 +1,51 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
NVM_VERSION='${NVM_VERSION}'
|
||||||
|
NODE_VERSIONS='${NODE_VERSIONS}'
|
||||||
|
INSTALL_PREFIX='${INSTALL_PREFIX}'
|
||||||
|
DEFAULT='${DEFAULT}'
|
||||||
|
BOLD='\033[0;1m'
|
||||||
|
CODE='\033[36;40;1m'
|
||||||
|
RESET='\033[0m'
|
||||||
|
|
||||||
|
printf "$${BOLD}Installing nvm!$${RESET}\n"
|
||||||
|
|
||||||
|
export NVM_DIR="$HOME/$${INSTALL_PREFIX}/nvm"
|
||||||
|
mkdir -p "$NVM_DIR"
|
||||||
|
|
||||||
|
script="$(curl -sS -o- "https://raw.githubusercontent.com/nvm-sh/nvm/$${NVM_VERSION}/install.sh" 2>&1)"
|
||||||
|
if [ $? -ne 0 ]; then
|
||||||
|
echo "Failed to download nvm installation script: $script"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
output="$(bash <<< "$script" 2>&1)"
|
||||||
|
if [ $? -ne 0 ]; then
|
||||||
|
echo "Failed to install nvm: $output"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf "🥳 nvm has been installed\n\n"
|
||||||
|
|
||||||
|
# Set up nvm for the rest of the script.
|
||||||
|
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
|
||||||
|
|
||||||
|
# Install each node version...
|
||||||
|
IFS=',' read -r -a VERSIONLIST <<< "$${NODE_VERSIONS}"
|
||||||
|
for version in "$${VERSIONLIST[@]}"; do
|
||||||
|
if [ -z "$version" ]; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
printf "🛠️ Installing node version $${CODE}$version$${RESET}...\n"
|
||||||
|
output=$(nvm install "$version" 2>&1)
|
||||||
|
if [ $? -ne 0 ]; then
|
||||||
|
echo "Failed to install version: $version: $output"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Set default if provided
|
||||||
|
if [ -n "$${DEFAULT}" ]; then
|
||||||
|
printf "🛠️ Setting default node version $${CODE}$DEFAULT$${RESET}...\n"
|
||||||
|
output=$(nvm alias default $DEFAULT 2>&1)
|
||||||
|
fi
|
||||||
20
package.json
20
package.json
@@ -2,17 +2,25 @@
|
|||||||
"name": "modules",
|
"name": "modules",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "bun test",
|
"test": "bun test",
|
||||||
"fmt": "bun x prettier --plugin prettier-plugin-sh -w **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt **/*.tf .sample/main.tf",
|
"fmt": "bun x prettier -w **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt **/*.tf .sample/main.tf",
|
||||||
"fmt:ci": "bun x prettier --plugin prettier-plugin-sh --check **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt -check **/*.tf .sample/main.tf",
|
"fmt:ci": "bun x prettier --check **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt -check **/*.tf .sample/main.tf",
|
||||||
"lint": "bun run lint.ts"
|
"lint": "bun run lint.ts && ./terraform_validate.sh",
|
||||||
|
"update-version": "./update-version.sh"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"bun-types": "^1.0.18",
|
"bun-types": "^1.0.18",
|
||||||
"gray-matter": "^4.0.3",
|
"gray-matter": "^4.0.3",
|
||||||
"marked": "^11.1.0",
|
"marked": "^12.0.0",
|
||||||
"prettier-plugin-sh": "^0.13.1"
|
"prettier-plugin-sh": "^0.13.1",
|
||||||
|
"prettier-plugin-terraform-formatter": "^1.2.1"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"typescript": "^5.3.3"
|
"typescript": "^5.3.3"
|
||||||
|
},
|
||||||
|
"prettier": {
|
||||||
|
"plugins": [
|
||||||
|
"prettier-plugin-sh",
|
||||||
|
"prettier-plugin-terraform-formatter"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -11,10 +11,10 @@ tags: [helper]
|
|||||||
|
|
||||||
Run a script on workspace start that allows developers to run custom commands to personalize their workspace.
|
Run a script on workspace start that allows developers to run custom commands to personalize their workspace.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "personalize" {
|
module "personalize" {
|
||||||
source = "registry.coder.com/modules/personalize/coder"
|
source = "registry.coder.com/modules/personalize/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -54,11 +54,11 @@ slackme npm run long-build
|
|||||||
|
|
||||||
3. Restart your Coder deployment. Any Template can now import the Slack Me module, and `slackme` will be available on the `$PATH`:
|
3. Restart your Coder deployment. Any Template can now import the Slack Me module, and `slackme` will be available on the `$PATH`:
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "slackme" {
|
module "slackme" {
|
||||||
source = "registry.coder.com/modules/slackme/coder"
|
source = "registry.coder.com/modules/slackme/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
auth_provider_id = "slack"
|
auth_provider_id = "slack"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -70,13 +70,13 @@ slackme npm run long-build
|
|||||||
- `$COMMAND` is replaced with the command the user executed.
|
- `$COMMAND` is replaced with the command the user executed.
|
||||||
- `$DURATION` is replaced with a human-readable duration the command took to execute.
|
- `$DURATION` is replaced with a human-readable duration the command took to execute.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "slackme" {
|
module "slackme" {
|
||||||
source = "registry.coder.com/modules/slackme/coder"
|
source = "registry.coder.com/modules/slackme/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.2"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
auth_provider_id = "slack"
|
auth_provider_id = "slack"
|
||||||
slack_message = <<EOF
|
slack_message = <<EOF
|
||||||
👋 Hey there from Coder! $COMMAND took $DURATION to execute!
|
👋 Hey there from Coder! $COMMAND took $DURATION to execute!
|
||||||
EOF
|
EOF
|
||||||
}
|
}
|
||||||
|
|||||||
29
terraform_validate.sh
Executable file
29
terraform_validate.sh
Executable file
@@ -0,0 +1,29 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Function to run terraform init and validate in a directory
|
||||||
|
run_terraform() {
|
||||||
|
local dir="$1"
|
||||||
|
echo "Running terraform init and validate in $dir"
|
||||||
|
pushd "$dir"
|
||||||
|
terraform init -upgrade
|
||||||
|
terraform validate
|
||||||
|
popd
|
||||||
|
}
|
||||||
|
|
||||||
|
# Main script
|
||||||
|
main() {
|
||||||
|
# Get the directory of the script
|
||||||
|
script_dir=$(dirname "$(readlink -f "$0")")
|
||||||
|
|
||||||
|
# Get all subdirectories in the repository
|
||||||
|
subdirs=$(find "$script_dir" -mindepth 1 -maxdepth 1 -type d -not -name ".*" | sort)
|
||||||
|
|
||||||
|
for dir in $subdirs; do
|
||||||
|
run_terraform "$dir"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run the main script
|
||||||
|
main
|
||||||
29
update-version.sh
Executable file
29
update-version.sh
Executable file
@@ -0,0 +1,29 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# This script updates the version number in the README.md files of all modules
|
||||||
|
# to the latest tag in the repository. It is intended to be run from the root
|
||||||
|
# of the repository or by using the `bun update-version` command.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
current_tag=$(git describe --tags --abbrev=0)
|
||||||
|
previous_tag=$(git describe --tags --abbrev=0 $current_tag^)
|
||||||
|
mapfile -t changed_dirs < <(git diff --name-only "$previous_tag"..."$current_tag" -- ':!**/README.md' ':!**/*.test.ts' | xargs dirname | grep -v '^\.' | sort -u)
|
||||||
|
|
||||||
|
LATEST_TAG=$(git describe --abbrev=0 --tags | sed 's/^v//') || exit $?
|
||||||
|
|
||||||
|
for dir in "${changed_dirs[@]}"; do
|
||||||
|
if [[ -f "$dir/README.md" ]]; then
|
||||||
|
echo "Bumping version in $dir/README.md"
|
||||||
|
file="$dir/README.md"
|
||||||
|
tmpfile=$(mktemp /tmp/tempfile.XXXXXX)
|
||||||
|
awk -v tag="$LATEST_TAG" '{
|
||||||
|
if ($1 == "version" && $2 == "=") {
|
||||||
|
sub(/"[^"]*"/, "\"" tag "\"")
|
||||||
|
print
|
||||||
|
} else {
|
||||||
|
print
|
||||||
|
}
|
||||||
|
}' "$file" > "$tmpfile" && mv "$tmpfile" "$file"
|
||||||
|
fi
|
||||||
|
done
|
||||||
@@ -3,6 +3,7 @@ display_name: Hashicorp Vault Integration (GitHub)
|
|||||||
description: Authenticates with Vault using GitHub
|
description: Authenticates with Vault using GitHub
|
||||||
icon: ../.icons/vault.svg
|
icon: ../.icons/vault.svg
|
||||||
maintainer_github: coder
|
maintainer_github: coder
|
||||||
|
partner_github: hashicorp
|
||||||
verified: true
|
verified: true
|
||||||
tags: [helper, integration, vault, github]
|
tags: [helper, integration, vault, github]
|
||||||
---
|
---
|
||||||
@@ -11,10 +12,10 @@ tags: [helper, integration, vault, github]
|
|||||||
|
|
||||||
This module lets you authenticate with [Hashicorp Vault](https://www.vaultproject.io/) in your Coder workspaces using [external auth](https://coder.com/docs/v2/latest/admin/external-auth) for GitHub.
|
This module lets you authenticate with [Hashicorp Vault](https://www.vaultproject.io/) in your Coder workspaces using [external auth](https://coder.com/docs/v2/latest/admin/external-auth) for GitHub.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vault" {
|
module "vault" {
|
||||||
source = "registry.coder.com/modules/vault-github/coder"
|
source = "registry.coder.com/modules/vault-github/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.7"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
vault_addr = "https://vault.example.com"
|
vault_addr = "https://vault.example.com"
|
||||||
}
|
}
|
||||||
@@ -23,13 +24,13 @@ module "vault" {
|
|||||||
Then you can use the Vault CLI in your workspaces to fetch secrets from Vault:
|
Then you can use the Vault CLI in your workspaces to fetch secrets from Vault:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
vault kv get -mount=secret my-secret
|
vault kv get -namespace=coder -mount=secrets coder
|
||||||
```
|
```
|
||||||
|
|
||||||
or using the Vault API:
|
or using the Vault API:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -H "X-Vault-Token: ${VAULT_TOKEN}" -X GET "${VAULT_ADDR}/v1/secret/data/my-secret"
|
curl -H "X-Vault-Token: ${VAULT_TOKEN}" -X GET "${VAULT_ADDR}/v1/coder/secrets/data/coder"
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
@@ -42,10 +43,10 @@ To configure the Vault module, you must set up a Vault GitHub auth method. See t
|
|||||||
|
|
||||||
### Configure Vault integration with a different Coder GitHub external auth ID (i.e., not the default `github`)
|
### Configure Vault integration with a different Coder GitHub external auth ID (i.e., not the default `github`)
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vault" {
|
module "vault" {
|
||||||
source = "registry.coder.com/modules/vault-github/coder"
|
source = "registry.coder.com/modules/vault-github/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.7"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
vault_addr = "https://vault.example.com"
|
vault_addr = "https://vault.example.com"
|
||||||
coder_github_auth_id = "my-github-auth-id"
|
coder_github_auth_id = "my-github-auth-id"
|
||||||
@@ -54,10 +55,10 @@ module "vault" {
|
|||||||
|
|
||||||
### Configure Vault integration with a different Coder GitHub external auth ID and a different Vault GitHub auth path
|
### Configure Vault integration with a different Coder GitHub external auth ID and a different Vault GitHub auth path
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vault" {
|
module "vault" {
|
||||||
source = "registry.coder.com/modules/vault-github/coder"
|
source = "registry.coder.com/modules/vault-github/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.7"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
vault_addr = "https://vault.example.com"
|
vault_addr = "https://vault.example.com"
|
||||||
coder_github_auth_id = "my-github-auth-id"
|
coder_github_auth_id = "my-github-auth-id"
|
||||||
@@ -67,10 +68,10 @@ module "vault" {
|
|||||||
|
|
||||||
### Configure Vault integration and install a specific version of the Vault CLI
|
### Configure Vault integration and install a specific version of the Vault CLI
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vault" {
|
module "vault" {
|
||||||
source = "registry.coder.com/modules/vault-github/coder"
|
source = "registry.coder.com/modules/vault-github/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.7"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
vault_addr = "https://vault.example.com"
|
vault_addr = "https://vault.example.com"
|
||||||
vault_cli_version = "1.15.0"
|
vault_cli_version = "1.15.0"
|
||||||
|
|||||||
11
vault-github/main.test.ts
Normal file
11
vault-github/main.test.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import { describe } from "bun:test";
|
||||||
|
import { runTerraformInit, testRequiredVariables } from "../test";
|
||||||
|
|
||||||
|
describe("vault-github", async () => {
|
||||||
|
await runTerraformInit(import.meta.dir);
|
||||||
|
|
||||||
|
testRequiredVariables(import.meta.dir, {
|
||||||
|
agent_id: "foo",
|
||||||
|
vault_addr: "foo",
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -49,7 +49,6 @@ resource "coder_script" "vault" {
|
|||||||
display_name = "Vault (GitHub)"
|
display_name = "Vault (GitHub)"
|
||||||
icon = "/icon/vault.svg"
|
icon = "/icon/vault.svg"
|
||||||
script = templatefile("${path.module}/run.sh", {
|
script = templatefile("${path.module}/run.sh", {
|
||||||
VAULT_ADDR : var.vault_addr,
|
|
||||||
AUTH_PATH : var.vault_github_auth_path,
|
AUTH_PATH : var.vault_github_auth_path,
|
||||||
GITHUB_EXTERNAL_AUTH_ID : data.coder_external_auth.github.id,
|
GITHUB_EXTERNAL_AUTH_ID : data.coder_external_auth.github.id,
|
||||||
INSTALL_VERSION : var.vault_cli_version,
|
INSTALL_VERSION : var.vault_cli_version,
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
#!/usr/bin/env sh
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
# Convert all templated variables to shell variables
|
# Convert all templated variables to shell variables
|
||||||
INSTALL_VERSION=${INSTALL_VERSION}
|
INSTALL_VERSION=${INSTALL_VERSION}
|
||||||
VAULT_ADDR=${VAULT_ADDR}
|
|
||||||
GITHUB_EXTERNAL_AUTH_ID=${GITHUB_EXTERNAL_AUTH_ID}
|
GITHUB_EXTERNAL_AUTH_ID=${GITHUB_EXTERNAL_AUTH_ID}
|
||||||
AUTH_PATH=${AUTH_PATH}
|
AUTH_PATH=${AUTH_PATH}
|
||||||
|
|
||||||
@@ -21,7 +20,7 @@ fetch() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
unzip() {
|
unzip_safe() {
|
||||||
if command -v unzip > /dev/null 2>&1; then
|
if command -v unzip > /dev/null 2>&1; then
|
||||||
command unzip "$@"
|
command unzip "$@"
|
||||||
elif command -v busybox > /dev/null 2>&1; then
|
elif command -v busybox > /dev/null 2>&1; then
|
||||||
@@ -32,57 +31,78 @@ unzip() {
|
|||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Fetch the latest version of Vault if INSTALL_VERSION is 'latest'
|
install() {
|
||||||
if [ "$${INSTALL_VERSION}" = "latest" ]; then
|
# Get the architecture of the system
|
||||||
LATEST_VERSION=$(curl -s https://releases.hashicorp.com/vault/ | grep -oP 'vault/\K[0-9]+\.[0-9]+\.[0-9]+' | sort -V | tail -n 1)
|
ARCH=$(uname -m)
|
||||||
printf "Latest version of Vault is %s.\n\n" "$${LATEST_VERSION}"
|
if [ "$${ARCH}" = "x86_64" ]; then
|
||||||
if [ -z "$${LATEST_VERSION}" ]; then
|
ARCH="amd64"
|
||||||
printf "Failed to determine the latest Vault version.\n"
|
elif [ "$${ARCH}" = "aarch64" ]; then
|
||||||
exit 1
|
ARCH="arm64"
|
||||||
fi
|
|
||||||
VERSION=$${LATEST_VERSION}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check if the vault CLI is installed and has the correct version
|
|
||||||
installation_needed=1
|
|
||||||
if command -v vault > /dev/null 2>&1; then
|
|
||||||
CURRENT_VERSION=$(vault version | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
|
|
||||||
if [ "$${CURRENT_VERSION}" = "$${INSTALL_VERSION}" ]; then
|
|
||||||
printf "Vault version %s is already installed and up-to-date.\n\n" "$${CURRENT_VERSION}"
|
|
||||||
installation_needed=0
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ $${installation_needed} -eq 1 ]; then
|
|
||||||
# Download and install Vault
|
|
||||||
if [ -z "$${CURRENT_VERSION}" ]; then
|
|
||||||
printf "Installing Vault CLI ...\n\n"
|
|
||||||
else
|
else
|
||||||
printf "Upgrading Vault CLI from version %s to %s ...\n\n" "$${CURRENT_VERSION}" "$${VERSION}"
|
printf "Unsupported architecture: $${ARCH}\n"
|
||||||
|
return 1
|
||||||
fi
|
fi
|
||||||
fetch vault.zip "https://releases.hashicorp.com/vault/$${VERSION}/vault_$${VERSION}_linux_amd64.zip"
|
# Fetch the latest version of Vault if INSTALL_VERSION is 'latest'
|
||||||
if [ $? -ne 0 ]; then
|
if [ "$${INSTALL_VERSION}" = "latest" ]; then
|
||||||
printf "Failed to download Vault.\n"
|
LATEST_VERSION=$(curl -s https://releases.hashicorp.com/vault/ | grep -v 'rc' | grep -oE 'vault/[0-9]+\.[0-9]+\.[0-9]+' | sed 's/vault\///' | sort -V | tail -n 1)
|
||||||
exit 1
|
printf "Latest version of Vault is %s.\n\n" "$${LATEST_VERSION}"
|
||||||
fi
|
if [ -z "$${LATEST_VERSION}" ]; then
|
||||||
unzip vault.zip
|
printf "Failed to determine the latest Vault version.\n"
|
||||||
if [ $? -ne 0 ]; then
|
return 1
|
||||||
printf "Failed to unzip Vault.\n"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
rm vault.zip
|
|
||||||
if sudo mv vault /usr/local/bin/vault 2> /dev/null; then
|
|
||||||
printf "Vault installed successfully!\n\n"
|
|
||||||
else
|
|
||||||
mkdir -p ~/.local/bin
|
|
||||||
mv vault ~/.local/bin/vault
|
|
||||||
if [ ! -f ~/.local/bin/vault ]; then
|
|
||||||
printf "Failed to move Vault to local bin.\n"
|
|
||||||
exit 1
|
|
||||||
fi
|
fi
|
||||||
printf "Please add ~/.local/bin to your PATH to use vault CLI.\n"
|
INSTALL_VERSION=$${LATEST_VERSION}
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Check if the vault CLI is installed and has the correct version
|
||||||
|
installation_needed=1
|
||||||
|
if command -v vault > /dev/null 2>&1; then
|
||||||
|
CURRENT_VERSION=$(vault version | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
|
||||||
|
if [ "$${CURRENT_VERSION}" = "$${INSTALL_VERSION}" ]; then
|
||||||
|
printf "Vault version %s is already installed and up-to-date.\n\n" "$${CURRENT_VERSION}"
|
||||||
|
installation_needed=0
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $${installation_needed} -eq 1 ]; then
|
||||||
|
# Download and install Vault
|
||||||
|
if [ -z "$${CURRENT_VERSION}" ]; then
|
||||||
|
printf "Installing Vault CLI ...\n\n"
|
||||||
|
else
|
||||||
|
printf "Upgrading Vault CLI from version %s to %s ...\n\n" "$${CURRENT_VERSION}" "${INSTALL_VERSION}"
|
||||||
|
fi
|
||||||
|
fetch vault.zip "https://releases.hashicorp.com/vault/$${INSTALL_VERSION}/vault_$${INSTALL_VERSION}_linux_$${ARCH}.zip"
|
||||||
|
if [ $? -ne 0 ]; then
|
||||||
|
printf "Failed to download Vault.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if ! unzip_safe vault.zip; then
|
||||||
|
printf "Failed to unzip Vault.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
rm vault.zip
|
||||||
|
if sudo mv vault /usr/local/bin/vault 2> /dev/null; then
|
||||||
|
printf "Vault installed successfully!\n\n"
|
||||||
|
else
|
||||||
|
mkdir -p ~/.local/bin
|
||||||
|
if ! mv vault ~/.local/bin/vault; then
|
||||||
|
printf "Failed to move Vault to local bin.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
printf "Please add ~/.local/bin to your PATH to use vault CLI.\n"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
TMP=$(mktemp -d)
|
||||||
|
if ! (
|
||||||
|
cd "$TMP"
|
||||||
|
install
|
||||||
|
); then
|
||||||
|
echo "Failed to install Vault CLI."
|
||||||
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
rm -rf "$TMP"
|
||||||
|
|
||||||
# Authenticate with Vault
|
# Authenticate with Vault
|
||||||
printf "🔑 Authenticating with Vault ...\n\n"
|
printf "🔑 Authenticating with Vault ...\n\n"
|
||||||
@@ -92,8 +112,6 @@ if [ $? -ne 0 ]; then
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
export VAULT_ADDR="$${VAULT_ADDR}"
|
|
||||||
|
|
||||||
# Login to vault using the GitHub token
|
# Login to vault using the GitHub token
|
||||||
printf "🔑 Logging in to Vault ...\n\n"
|
printf "🔑 Logging in to Vault ...\n\n"
|
||||||
vault login -no-print -method=github -path=/$${AUTH_PATH} token="$${GITHUB_TOKEN}"
|
vault login -no-print -method=github -path=/$${AUTH_PATH} token="$${GITHUB_TOKEN}"
|
||||||
|
|||||||
83
vault-token/README.md
Normal file
83
vault-token/README.md
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
---
|
||||||
|
display_name: Hashicorp Vault Integration (Token)
|
||||||
|
description: Authenticates with Vault using Token
|
||||||
|
icon: ../.icons/vault.svg
|
||||||
|
maintainer_github: coder
|
||||||
|
partner_github: hashicorp
|
||||||
|
verified: true
|
||||||
|
tags: [helper, integration, vault, token]
|
||||||
|
---
|
||||||
|
|
||||||
|
# Hashicorp Vault Integration (Token)
|
||||||
|
|
||||||
|
This module lets you authenticate with [Hashicorp Vault](https://www.vaultproject.io/) in your Coder workspaces using a [Vault token](https://developer.hashicorp.com/vault/docs/auth/token).
|
||||||
|
|
||||||
|
```tf
|
||||||
|
variable "vault_token" {
|
||||||
|
type = string
|
||||||
|
description = "The Vault token to use for authentication."
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
module "vault" {
|
||||||
|
source = "registry.coder.com/modules/vault-token/coder"
|
||||||
|
version = "1.0.7"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
vault_token = var.token
|
||||||
|
vault_addr = "https://vault.example.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you can use the Vault CLI in your workspaces to fetch secrets from Vault:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
vault kv get -namespace=coder -mount=secrets coder
|
||||||
|
```
|
||||||
|
|
||||||
|
or using the Vault API:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
curl -H "X-Vault-Token: ${VAULT_TOKEN}" -X GET "${VAULT_ADDR}/v1/coder/secrets/data/coder"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
To configure the Vault module, you must create a Vault token with the the required permissions and configure the module with the token and Vault address.
|
||||||
|
|
||||||
|
1. Create a vault policy with read access to the secret mount you need your developers to access.
|
||||||
|
```shell
|
||||||
|
vault policy write read-coder-secrets - <<EOF
|
||||||
|
path "coder/data/*" {
|
||||||
|
capabilities = ["read"]
|
||||||
|
}
|
||||||
|
path "coder/metadata/*" {
|
||||||
|
capabilities = ["read"]
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
2. Create a token using this policy.
|
||||||
|
```shell
|
||||||
|
vault token create -policy="read-coder-secrets"
|
||||||
|
```
|
||||||
|
3. Copy the generated token and use in your template.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Configure Vault integration and install a specific version of the Vault CLI
|
||||||
|
|
||||||
|
```tf
|
||||||
|
variable "vault_token" {
|
||||||
|
type = string
|
||||||
|
description = "The Vault token to use for authentication."
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
module "vault" {
|
||||||
|
source = "registry.coder.com/modules/vault-token/coder"
|
||||||
|
version = "1.0.7"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
vault_addr = "https://vault.example.com"
|
||||||
|
vault_token = var.token
|
||||||
|
vault_cli_version = "1.15.0"
|
||||||
|
}
|
||||||
|
```
|
||||||
12
vault-token/main.test.ts
Normal file
12
vault-token/main.test.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { describe } from "bun:test";
|
||||||
|
import { runTerraformInit, testRequiredVariables } from "../test";
|
||||||
|
|
||||||
|
describe("vault-token", async () => {
|
||||||
|
await runTerraformInit(import.meta.dir);
|
||||||
|
|
||||||
|
testRequiredVariables(import.meta.dir, {
|
||||||
|
agent_id: "foo",
|
||||||
|
vault_addr: "foo",
|
||||||
|
vault_token: "foo",
|
||||||
|
});
|
||||||
|
});
|
||||||
62
vault-token/main.tf
Normal file
62
vault-token/main.tf
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
terraform {
|
||||||
|
required_version = ">= 1.0"
|
||||||
|
|
||||||
|
required_providers {
|
||||||
|
coder = {
|
||||||
|
source = "coder/coder"
|
||||||
|
version = ">= 0.12.4"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Add required variables for your modules and remove any unneeded variables
|
||||||
|
variable "agent_id" {
|
||||||
|
type = string
|
||||||
|
description = "The ID of a Coder agent."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "vault_addr" {
|
||||||
|
type = string
|
||||||
|
description = "The address of the Vault server."
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "vault_token" {
|
||||||
|
type = string
|
||||||
|
description = "The Vault token to use for authentication."
|
||||||
|
sensitive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "vault_cli_version" {
|
||||||
|
type = string
|
||||||
|
description = "The version of Vault to install."
|
||||||
|
default = "latest"
|
||||||
|
validation {
|
||||||
|
condition = can(regex("^(latest|[0-9]+\\.[0-9]+\\.[0-9]+)$", var.vault_cli_version))
|
||||||
|
error_message = "Vault version must be in the format 0.0.0 or latest"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
data "coder_workspace" "me" {}
|
||||||
|
|
||||||
|
resource "coder_script" "vault" {
|
||||||
|
agent_id = var.agent_id
|
||||||
|
display_name = "Vault (Token)"
|
||||||
|
icon = "/icon/vault.svg"
|
||||||
|
script = templatefile("${path.module}/run.sh", {
|
||||||
|
INSTALL_VERSION : var.vault_cli_version,
|
||||||
|
})
|
||||||
|
run_on_start = true
|
||||||
|
start_blocks_login = true
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_env" "vault_addr" {
|
||||||
|
agent_id = var.agent_id
|
||||||
|
name = "VAULT_ADDR"
|
||||||
|
value = var.vault_addr
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_env" "vault_token" {
|
||||||
|
agent_id = var.agent_id
|
||||||
|
name = "VAULT_TOKEN"
|
||||||
|
value = var.vault_token
|
||||||
|
}
|
||||||
103
vault-token/run.sh
Normal file
103
vault-token/run.sh
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# Convert all templated variables to shell variables
|
||||||
|
INSTALL_VERSION=${INSTALL_VERSION}
|
||||||
|
|
||||||
|
fetch() {
|
||||||
|
dest="$1"
|
||||||
|
url="$2"
|
||||||
|
if command -v curl > /dev/null 2>&1; then
|
||||||
|
curl -sSL --fail "$${url}" -o "$${dest}"
|
||||||
|
elif command -v wget > /dev/null 2>&1; then
|
||||||
|
wget -O "$${dest}" "$${url}"
|
||||||
|
elif command -v busybox > /dev/null 2>&1; then
|
||||||
|
busybox wget -O "$${dest}" "$${url}"
|
||||||
|
else
|
||||||
|
printf "curl, wget, or busybox is not installed. Please install curl or wget in your image.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
unzip_safe() {
|
||||||
|
if command -v unzip > /dev/null 2>&1; then
|
||||||
|
command unzip "$@"
|
||||||
|
elif command -v busybox > /dev/null 2>&1; then
|
||||||
|
busybox unzip "$@"
|
||||||
|
else
|
||||||
|
printf "unzip or busybox is not installed. Please install unzip in your image.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
install() {
|
||||||
|
# Get the architecture of the system
|
||||||
|
ARCH=$(uname -m)
|
||||||
|
if [ "$${ARCH}" = "x86_64" ]; then
|
||||||
|
ARCH="amd64"
|
||||||
|
elif [ "$${ARCH}" = "aarch64" ]; then
|
||||||
|
ARCH="arm64"
|
||||||
|
else
|
||||||
|
printf "Unsupported architecture: $${ARCH}\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
# Fetch the latest version of Vault if INSTALL_VERSION is 'latest'
|
||||||
|
if [ "$${INSTALL_VERSION}" = "latest" ]; then
|
||||||
|
LATEST_VERSION=$(curl -s https://releases.hashicorp.com/vault/ | grep -v 'rc' | grep -oE 'vault/[0-9]+\.[0-9]+\.[0-9]+' | sed 's/vault\///' | sort -V | tail -n 1)
|
||||||
|
printf "Latest version of Vault is %s.\n\n" "$${LATEST_VERSION}"
|
||||||
|
if [ -z "$${LATEST_VERSION}" ]; then
|
||||||
|
printf "Failed to determine the latest Vault version.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
INSTALL_VERSION=$${LATEST_VERSION}
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if the vault CLI is installed and has the correct version
|
||||||
|
installation_needed=1
|
||||||
|
if command -v vault > /dev/null 2>&1; then
|
||||||
|
CURRENT_VERSION=$(vault version | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
|
||||||
|
if [ "$${CURRENT_VERSION}" = "$${INSTALL_VERSION}" ]; then
|
||||||
|
printf "Vault version %s is already installed and up-to-date.\n\n" "$${CURRENT_VERSION}"
|
||||||
|
installation_needed=0
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $${installation_needed} -eq 1 ]; then
|
||||||
|
# Download and install Vault
|
||||||
|
if [ -z "$${CURRENT_VERSION}" ]; then
|
||||||
|
printf "Installing Vault CLI ...\n\n"
|
||||||
|
else
|
||||||
|
printf "Upgrading Vault CLI from version %s to %s ...\n\n" "$${CURRENT_VERSION}" "${INSTALL_VERSION}"
|
||||||
|
fi
|
||||||
|
fetch vault.zip "https://releases.hashicorp.com/vault/$${INSTALL_VERSION}/vault_$${INSTALL_VERSION}_linux_amd64.zip"
|
||||||
|
if [ $? -ne 0 ]; then
|
||||||
|
printf "Failed to download Vault.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if ! unzip_safe vault.zip; then
|
||||||
|
printf "Failed to unzip Vault.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
rm vault.zip
|
||||||
|
if sudo mv vault /usr/local/bin/vault 2> /dev/null; then
|
||||||
|
printf "Vault installed successfully!\n\n"
|
||||||
|
else
|
||||||
|
mkdir -p ~/.local/bin
|
||||||
|
if ! mv vault ~/.local/bin/vault; then
|
||||||
|
printf "Failed to move Vault to local bin.\n"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
printf "Please add ~/.local/bin to your PATH to use vault CLI.\n"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
TMP=$(mktemp -d)
|
||||||
|
if ! (
|
||||||
|
cd "$TMP"
|
||||||
|
install
|
||||||
|
); then
|
||||||
|
echo "Failed to install Vault CLI."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
rm -rf "$TMP"
|
||||||
@@ -13,10 +13,10 @@ Add a button to open any workspace with a single click.
|
|||||||
|
|
||||||
Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder).
|
Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder).
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vscode" {
|
module "vscode" {
|
||||||
source = "registry.coder.com/modules/vscode-desktop/coder"
|
source = "registry.coder.com/modules/vscode-desktop/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -25,11 +25,11 @@ module "vscode" {
|
|||||||
|
|
||||||
### Open in a specific directory
|
### Open in a specific directory
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vscode" {
|
module "vscode" {
|
||||||
source = "registry.coder.com/modules/vscode-desktop/coder"
|
source = "registry.coder.com/modules/vscode-desktop/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.8"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
folder = "/home/coder/project"
|
folder = "/home/coder/project"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -20,5 +20,18 @@ describe("vscode-desktop", async () => {
|
|||||||
expect(state.outputs.vscode_url.value).toBe(
|
expect(state.outputs.vscode_url.value).toBe(
|
||||||
"vscode://coder.coder-remote/open?owner=default&workspace=default&token=$SESSION_TOKEN",
|
"vscode://coder.coder-remote/open?owner=default&workspace=default&token=$SESSION_TOKEN",
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const resources: any = state.resources;
|
||||||
|
expect(resources[1].instances[0].attributes.order).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("expect order to be set", async () => {
|
||||||
|
const state = await runTerraformApply(import.meta.dir, {
|
||||||
|
agent_id: "foo",
|
||||||
|
order: "22",
|
||||||
|
});
|
||||||
|
|
||||||
|
const resources: any = state.resources;
|
||||||
|
expect(resources[1].instances[0].attributes.order).toBe(22);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -20,6 +20,12 @@ variable "folder" {
|
|||||||
default = ""
|
default = ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
data "coder_workspace" "me" {}
|
data "coder_workspace" "me" {}
|
||||||
|
|
||||||
resource "coder_app" "vscode" {
|
resource "coder_app" "vscode" {
|
||||||
@@ -28,6 +34,7 @@ resource "coder_app" "vscode" {
|
|||||||
icon = "/icon/code.svg"
|
icon = "/icon/code.svg"
|
||||||
slug = "vscode"
|
slug = "vscode"
|
||||||
display_name = "VS Code Desktop"
|
display_name = "VS Code Desktop"
|
||||||
|
order = var.order
|
||||||
url = var.folder != "" ? join("", [
|
url = var.folder != "" ? join("", [
|
||||||
"vscode://coder.coder-remote/open?owner=",
|
"vscode://coder.coder-remote/open?owner=",
|
||||||
data.coder_workspace.me.owner,
|
data.coder_workspace.me.owner,
|
||||||
|
|||||||
@@ -9,12 +9,12 @@ tags: [helper, ide, vscode, web]
|
|||||||
|
|
||||||
# VS Code Web
|
# VS Code Web
|
||||||
|
|
||||||
Automatically install [Visual Studio Code Server](https://code.visualstudio.com/docs/remote/vscode-server) in a workspace using the [VS Code CLI](https://code.visualstudio.com/docs/editor/command-line) and create an app to access it via the dashboard.
|
Automatically install [Visual Studio Code Server](https://code.visualstudio.com/docs/remote/vscode-server) in a workspace and create an app to access it via the dashboard.
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vscode-web" {
|
module "vscode-web" {
|
||||||
source = "registry.coder.com/modules/vscode-web/coder"
|
source = "registry.coder.com/modules/vscode-web/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
accept_license = true
|
accept_license = true
|
||||||
}
|
}
|
||||||
@@ -26,13 +26,42 @@ module "vscode-web" {
|
|||||||
|
|
||||||
### Install VS Code Web to a custom folder
|
### Install VS Code Web to a custom folder
|
||||||
|
|
||||||
```hcl
|
```tf
|
||||||
module "vscode-web" {
|
module "vscode-web" {
|
||||||
source = "registry.coder.com/modules/vscode-web/coder"
|
source = "registry.coder.com/modules/vscode-web/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.10"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
install_dir = "/home/coder/.vscode-web"
|
install_prefix = "/home/coder/.vscode-web"
|
||||||
folder = "/home/coder"
|
folder = "/home/coder"
|
||||||
accept_license = true
|
accept_license = true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install Extensions
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "vscode-web" {
|
||||||
|
source = "registry.coder.com/modules/vscode-web/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
extensions = ["github.copilot", "ms-python.python", "ms-toolsai.jupyter"]
|
||||||
|
accept_license = true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pre-configure Settings
|
||||||
|
|
||||||
|
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "vscode-web" {
|
||||||
|
source = "registry.coder.com/modules/vscode-web/coder"
|
||||||
|
version = "1.0.10"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
extensions = ["dracula-theme.theme-dracula"]
|
||||||
|
settings = {
|
||||||
|
"workbench.colorTheme" = "Dracula"
|
||||||
|
}
|
||||||
|
accept_license = true
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,63 +0,0 @@
|
|||||||
import { describe, expect, it } from "bun:test";
|
|
||||||
import {
|
|
||||||
executeScriptInContainer,
|
|
||||||
runTerraformApply,
|
|
||||||
runTerraformInit,
|
|
||||||
} from "../test";
|
|
||||||
|
|
||||||
describe("vscode-web", async () => {
|
|
||||||
await runTerraformInit(import.meta.dir);
|
|
||||||
|
|
||||||
// replaces testRequiredVariables due to license variable
|
|
||||||
// may add a testRequiredVariablesWithLicense function later
|
|
||||||
it("missing agent_id", async () => {
|
|
||||||
try {
|
|
||||||
await runTerraformApply(import.meta.dir, {
|
|
||||||
accept_license: "true",
|
|
||||||
});
|
|
||||||
} catch (ex) {
|
|
||||||
expect(ex.message).toContain('input variable "agent_id" is not set');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
it("invalid license_agreement", async () => {
|
|
||||||
try {
|
|
||||||
await runTerraformApply(import.meta.dir, {
|
|
||||||
agent_id: "foo",
|
|
||||||
});
|
|
||||||
} catch (ex) {
|
|
||||||
expect(ex.message).toContain(
|
|
||||||
"You must accept the VS Code license agreement by setting accept_license=true",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
it("fails without curl", async () => {
|
|
||||||
const state = await runTerraformApply(import.meta.dir, {
|
|
||||||
agent_id: "foo",
|
|
||||||
accept_license: "true",
|
|
||||||
});
|
|
||||||
const output = await executeScriptInContainer(state, "alpine");
|
|
||||||
expect(output.exitCode).toBe(1);
|
|
||||||
expect(output.stdout).toEqual([
|
|
||||||
"\u001b[0;1mInstalling vscode-cli!",
|
|
||||||
"Failed to install vscode-cli:", // TODO: manually test error log
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("runs with curl", async () => {
|
|
||||||
const state = await runTerraformApply(import.meta.dir, {
|
|
||||||
agent_id: "foo",
|
|
||||||
accept_license: "true",
|
|
||||||
});
|
|
||||||
const output = await executeScriptInContainer(state, "alpine/curl");
|
|
||||||
expect(output.exitCode).toBe(0);
|
|
||||||
expect(output.stdout).toEqual([
|
|
||||||
"\u001b[0;1mInstalling vscode-cli!",
|
|
||||||
"🥳 vscode-cli has been installed.",
|
|
||||||
"",
|
|
||||||
"👷 Running /tmp/vscode-cli/bin/code serve-web --port 13338 --without-connection-token --accept-server-license-terms in the background...",
|
|
||||||
"Check logs at /tmp/vscode-web.log!",
|
|
||||||
]);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -4,7 +4,7 @@ terraform {
|
|||||||
required_providers {
|
required_providers {
|
||||||
coder = {
|
coder = {
|
||||||
source = "coder/coder"
|
source = "coder/coder"
|
||||||
version = ">= 0.12"
|
version = ">= 0.17"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -20,6 +20,18 @@ variable "port" {
|
|||||||
default = 13338
|
default = 13338
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "display_name" {
|
||||||
|
type = string
|
||||||
|
description = "The display name for the VS Code Web application."
|
||||||
|
default = "VS Code Web"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "slug" {
|
||||||
|
type = string
|
||||||
|
description = "The slug for the VS Code Web application."
|
||||||
|
default = "vscode-web"
|
||||||
|
}
|
||||||
|
|
||||||
variable "folder" {
|
variable "folder" {
|
||||||
type = string
|
type = string
|
||||||
description = "The folder to open in vscode-web."
|
description = "The folder to open in vscode-web."
|
||||||
@@ -41,15 +53,21 @@ variable "log_path" {
|
|||||||
default = "/tmp/vscode-web.log"
|
default = "/tmp/vscode-web.log"
|
||||||
}
|
}
|
||||||
|
|
||||||
variable "install_dir" {
|
variable "install_prefix" {
|
||||||
type = string
|
type = string
|
||||||
description = "The directory to install VS Code CLI"
|
description = "The prefix to install vscode-web to."
|
||||||
default = "/tmp/vscode-cli"
|
default = "/tmp/vscode-web"
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "extensions" {
|
||||||
|
type = list(string)
|
||||||
|
description = "A list of extensions to install."
|
||||||
|
default = []
|
||||||
}
|
}
|
||||||
|
|
||||||
variable "accept_license" {
|
variable "accept_license" {
|
||||||
type = bool
|
type = bool
|
||||||
description = "Accept the VS Code license. https://code.visualstudio.com/license"
|
description = "Accept the VS Code Server license. https://code.visualstudio.com/license/server"
|
||||||
default = false
|
default = false
|
||||||
validation {
|
validation {
|
||||||
condition = var.accept_license == true
|
condition = var.accept_license == true
|
||||||
@@ -57,6 +75,28 @@ variable "accept_license" {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
variable "telemetry_level" {
|
||||||
|
type = string
|
||||||
|
description = "Set the telemetry level for VS Code Web."
|
||||||
|
default = "error"
|
||||||
|
validation {
|
||||||
|
condition = var.telemetry_level == "off" || var.telemetry_level == "crash" || var.telemetry_level == "error" || var.telemetry_level == "all"
|
||||||
|
error_message = "Incorrect value. Please set either 'off', 'crash', 'error', or 'all'."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "order" {
|
||||||
|
type = number
|
||||||
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
||||||
|
default = null
|
||||||
|
}
|
||||||
|
|
||||||
|
variable "settings" {
|
||||||
|
type = map(string)
|
||||||
|
description = "A map of settings to apply to VS Code web."
|
||||||
|
default = {}
|
||||||
|
}
|
||||||
|
|
||||||
resource "coder_script" "vscode-web" {
|
resource "coder_script" "vscode-web" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
display_name = "VS Code Web"
|
display_name = "VS Code Web"
|
||||||
@@ -64,19 +104,24 @@ resource "coder_script" "vscode-web" {
|
|||||||
script = templatefile("${path.module}/run.sh", {
|
script = templatefile("${path.module}/run.sh", {
|
||||||
PORT : var.port,
|
PORT : var.port,
|
||||||
LOG_PATH : var.log_path,
|
LOG_PATH : var.log_path,
|
||||||
INSTALL_DIR : var.install_dir,
|
INSTALL_PREFIX : var.install_prefix,
|
||||||
|
EXTENSIONS : join(",", var.extensions),
|
||||||
|
TELEMETRY_LEVEL : var.telemetry_level,
|
||||||
|
// This is necessary otherwise the quotes are stripped!
|
||||||
|
SETTINGS : replace(jsonencode(var.settings), "\"", "\\\""),
|
||||||
})
|
})
|
||||||
run_on_start = true
|
run_on_start = true
|
||||||
}
|
}
|
||||||
|
|
||||||
resource "coder_app" "vscode-web" {
|
resource "coder_app" "vscode-web" {
|
||||||
agent_id = var.agent_id
|
agent_id = var.agent_id
|
||||||
slug = "vscode-web"
|
slug = var.slug
|
||||||
display_name = "VS Code Web"
|
display_name = var.display_name
|
||||||
url = var.folder == "" ? "http://localhost:${var.port}" : "http://localhost:${var.port}?folder=${var.folder}"
|
url = var.folder == "" ? "http://localhost:${var.port}" : "http://localhost:${var.port}?folder=${var.folder}"
|
||||||
icon = "/icon/code.svg"
|
icon = "/icon/code.svg"
|
||||||
subdomain = true
|
subdomain = true
|
||||||
share = var.share
|
share = var.share
|
||||||
|
order = var.order
|
||||||
|
|
||||||
healthcheck {
|
healthcheck {
|
||||||
url = "http://localhost:${var.port}/healthz"
|
url = "http://localhost:${var.port}/healthz"
|
||||||
|
|||||||
55
vscode-web/run.sh
Normal file → Executable file
55
vscode-web/run.sh
Normal file → Executable file
@@ -1,21 +1,56 @@
|
|||||||
#!/usr/bin/env sh
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
BOLD='\033[0;1m'
|
BOLD='\033[0;1m'
|
||||||
|
EXTENSIONS=("${EXTENSIONS}")
|
||||||
|
|
||||||
# Create install directory if it doesn't exist
|
# Create install prefix
|
||||||
mkdir -p ${INSTALL_DIR}
|
mkdir -p ${INSTALL_PREFIX}
|
||||||
|
|
||||||
printf "$${BOLD}Installing vscode-cli!\n"
|
printf "$${BOLD}Installing Microsoft Visual Studio Code Server!\n"
|
||||||
|
|
||||||
# Download and extract code-cli tarball
|
# Download and extract vscode-server
|
||||||
output=$(curl -Lk 'https://code.visualstudio.com/sha/download?build=stable&os=cli-alpine-x64' --output vscode_cli.tar.gz && tar -xf vscode_cli.tar.gz -C ${INSTALL_DIR} && rm vscode_cli.tar.gz)
|
ARCH=$(uname -m)
|
||||||
|
case "$ARCH" in
|
||||||
|
x86_64) ARCH="x64" ;;
|
||||||
|
aarch64) ARCH="arm64" ;;
|
||||||
|
*)
|
||||||
|
echo "Unsupported architecture"
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
HASH=$(curl -fsSL https://update.code.visualstudio.com/api/commits/stable/server-linux-$ARCH-web | cut -d '"' -f 2)
|
||||||
|
output=$(curl -fsSL https://vscode.download.prss.microsoft.com/dbazure/download/stable/$HASH/vscode-server-linux-$ARCH-web.tar.gz | tar -xz -C ${INSTALL_PREFIX} --strip-components 1)
|
||||||
|
|
||||||
if [ $? -ne 0 ]; then
|
if [ $? -ne 0 ]; then
|
||||||
echo "Failed to install vscode-cli: $output"
|
echo "Failed to install Microsoft Visual Studio Code Server: $output"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
printf "🥳 vscode-cli has been installed.\n\n"
|
printf "$${BOLD}Microsoft Visual Studio Code Server has been installed.\n"
|
||||||
|
|
||||||
echo "👷 Running ${INSTALL_DIR}/bin/code serve-web --port ${PORT} --without-connection-token --accept-server-license-terms in the background..."
|
VSCODE_SERVER="${INSTALL_PREFIX}/bin/code-server"
|
||||||
|
|
||||||
|
# Install each extension...
|
||||||
|
IFS=',' read -r -a EXTENSIONLIST <<< "$${EXTENSIONS}"
|
||||||
|
for extension in "$${EXTENSIONLIST[@]}"; do
|
||||||
|
if [ -z "$extension" ]; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
printf "🧩 Installing extension $${CODE}$extension$${RESET}...\n"
|
||||||
|
output=$($VSCODE_SERVER --install-extension "$extension" --force)
|
||||||
|
if [ $? -ne 0 ]; then
|
||||||
|
echo "Failed to install extension: $extension: $output"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Check if the settings file exists...
|
||||||
|
if [ ! -f ~/.vscode-server/data/Machine/settings.json ]; then
|
||||||
|
echo "⚙️ Creating settings file..."
|
||||||
|
mkdir -p ~/.vscode-server/data/Machine
|
||||||
|
echo "${SETTINGS}" > ~/.vscode-server/data/Machine/settings.json
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "👷 Running ${INSTALL_PREFIX}/bin/code-server serve-local --port ${PORT} --host 127.0.0.1 --accept-server-license-terms serve-local --without-connection-token --telemetry-level ${TELEMETRY_LEVEL} in the background..."
|
||||||
echo "Check logs at ${LOG_PATH}!"
|
echo "Check logs at ${LOG_PATH}!"
|
||||||
${INSTALL_DIR}/code serve-web --port ${PORT} --without-connection-token --accept-server-license-terms > ${LOG_PATH} 2>&1 &
|
"${INSTALL_PREFIX}/bin/code-server" serve-local --port "${PORT}" --host 127.0.0.1 --accept-server-license-terms serve-local --without-connection-token --telemetry-level "${TELEMETRY_LEVEL}" > "${LOG_PATH}" 2>&1 &
|
||||||
|
|||||||
Reference in New Issue
Block a user