Installs the Vault CLI and optionally configures token authentication. This module focuses on CLI installation and can be used standalone or as a base for other authentication methods.

module "vault_cli" {
  source     = "registry.coder.com/coder/vault-cli/coder"
  version    = "1.1.1"
  agent_id   = coder_agent.example.id
  vault_addr = "https://vault.example.com"
}

Prerequisites

The following tools are required in the workspace image:

HTTP client: curl, wget, or busybox (at least one)
Archive utility: unzip or busybox (at least one)
jq: Optional but recommended for reliable JSON parsing (falls back to sed if not available)

With Token Authentication

If you have a Vault token, you can provide it to automatically configure authentication:

module "vault_cli" {
  source      = "registry.coder.com/coder/vault-cli/coder"
  version     = "1.1.1"
  agent_id    = coder_agent.example.id
  vault_addr  = "https://vault.example.com"
  vault_token = var.vault_token # Optional
}

Examples

Basic Installation (CLI Only)

Install the Vault CLI without any authentication:

module "vault_cli" {
  source     = "registry.coder.com/coder/vault-cli/coder"
  version    = "1.1.1"
  agent_id   = coder_agent.example.id
  vault_addr = "https://vault.example.com"
}

With Specific Version

module "vault_cli" {
  source            = "registry.coder.com/coder/vault-cli/coder"
  version           = "1.1.1"
  agent_id          = coder_agent.example.id
  vault_addr        = "https://vault.example.com"
  vault_cli_version = "1.15.0"
}

Custom Installation Directory

module "vault_cli" {
  source      = "registry.coder.com/coder/vault-cli/coder"
  version     = "1.1.1"
  agent_id    = coder_agent.example.id
  vault_addr  = "https://vault.example.com"
  install_dir = "/home/coder/bin"
}

With Vault Enterprise Namespace

For Vault Enterprise users who need to specify a namespace:

module "vault_cli" {
  source          = "registry.coder.com/coder/vault-cli/coder"
  version         = "1.1.1"
  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:

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

For more advanced authentication methods, see:

vault-github - Authenticate with Vault using GitHub tokens
vault-jwt - Authenticate with Vault using OIDC/JWT

For simple token-based authentication, see:

vault-token - Authenticate with Vault using a token

README.md

Vault CLI