Skip to content

feat: support optional installation of vault enterprise binary #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DevelopmentCats merged 2 commits into from
Dec 8, 2025
Merged

feat: support optional installation of vault enterprise binary #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0c7dee
feat(vault-cli): add enterprise parameter
rowansmithau Dec 5, 2025
83da1b8
version bump
rowansmithau Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions registry/coder/modules/vault-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installs the [Vault](https://www.vaultproject.io/) CLI and optionally configures
```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.0.0"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
}
Expand All @@ -34,7 +34,7 @@ If you have a Vault token, you can provide it to automatically configure authent
```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.0.0"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
vault_token = var.vault_token # Optional
Expand All @@ -50,7 +50,7 @@ Install the Vault CLI without any authentication:
```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.0.0"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
}
Expand All @@ -61,7 +61,7 @@ module "vault_cli" {
```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.0.0"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
vault_cli_version = "1.15.0"
Expand All @@ -73,7 +73,7 @@ module "vault_cli" {
```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.0.0"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
install_dir = "/home/coder/bin"
Expand All @@ -87,14 +87,28 @@ For Vault Enterprise users who need to specify a namespace:
```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.0.0"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
vault_token = var.vault_token
vault_namespace = "admin/my-namespace"
}
```

### Vault Enterprise Binary

Install the Vault Enterprise binary. This is required if using SAML authentication to Vault:

```tf
module "vault_cli" {
source = "registry.coder.com/coder/vault-cli/coder"
version = "1.1.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
enterprise = true
}
```

## Related Modules

For more advanced authentication methods, see:
Expand Down
7 changes: 7 additions & 0 deletions registry/coder/modules/vault-cli/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ variable "vault_namespace" {
default = null
}

variable "enterprise" {
type = bool
description = "Whether to install the enterprise version of the Vault CLI. Required if using SAML authentication to Vault."
default = false
}

data "coder_workspace" "me" {}

resource "coder_script" "vault_cli" {
Expand All @@ -59,6 +65,7 @@ resource "coder_script" "vault_cli" {
VAULT_TOKEN = var.vault_token
INSTALL_DIR = var.install_dir
VAULT_CLI_VERSION = var.vault_cli_version
ENTERPRISE = var.enterprise
})
run_on_start = true
start_blocks_login = true
Expand Down
11 changes: 11 additions & 0 deletions registry/coder/modules/vault-cli/main.tftest.hcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,14 @@ run "test_vault_cli_with_token_and_namespace" {
error_message = "VAULT_NAMESPACE should match the provided vault_namespace"
}
}

run "test_vault_cli_enterprise" {
variables {
enterprise = true
}

assert {
condition = resource.coder_script.vault_cli.display_name == "Vault CLI"
error_message = "Display name should be 'Vault CLI'"
}
}
14 changes: 12 additions & 2 deletions registry/coder/modules/vault-cli/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ VAULT_ADDR=${VAULT_ADDR}
VAULT_TOKEN=${VAULT_TOKEN}
INSTALL_DIR=${INSTALL_DIR}
VAULT_CLI_VERSION=${VAULT_CLI_VERSION}
ENTERPRISE=${ENTERPRISE}

# Fetch URL content. If dest is provided, write to file; otherwise output to stdout.
# Usage: fetch <url> [dest]
Expand Down Expand Up @@ -75,9 +76,18 @@ install() {

# Fetch release information from HashiCorp API
if [ "$${VAULT_CLI_VERSION}" = "latest" ]; then
API_URL="https://api.releases.hashicorp.com/v1/releases/vault/latest"
if [ "$${ENTERPRISE}" = "true" ]; then
API_URL="https://api.releases.hashicorp.com/v1/releases/vault/latest?license_class=enterprise"
else
API_URL="https://api.releases.hashicorp.com/v1/releases/vault/latest"
fi
else
API_URL="https://api.releases.hashicorp.com/v1/releases/vault/$${VAULT_CLI_VERSION}"
# For specific version, append +ent suffix for enterprise
if [ "$${ENTERPRISE}" = "true" ]; then
API_URL="https://api.releases.hashicorp.com/v1/releases/vault/$${VAULT_CLI_VERSION}+ent"
else
API_URL="https://api.releases.hashicorp.com/v1/releases/vault/$${VAULT_CLI_VERSION}"
fi
fi

API_RESPONSE=$(fetch "$${API_URL}")
Expand Down
Loading