Skip to content

Commit

Permalink
docs/vault-k8s: update the service annotation (#15965)
Browse files Browse the repository at this point in the history
The injector's `service` annotation is really the vault address to
use, and not just the name of the service.

Also change a couple mentions of "controller" to "injector".
  • Loading branch information
temp authored and tvoran committed Jun 14, 2022
1 parent f8a9c78 commit 5132ebc
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions website/content/docs/platform/k8s/injector/annotations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ them, optional commands to run, etc.
Agent configuration file and templates can be found.

- `vault.hashicorp.com/agent-image` - name of the Vault docker image to use. This
value overrides the default image configured in the controller and is usually
value overrides the default image configured in the injector and is usually
not needed. Defaults to `hashicorp/vault:1.9.2`.

- `vault.hashicorp.com/agent-init-first` - configures the pod to run the Vault Agent
Expand Down Expand Up @@ -245,9 +245,10 @@ etc.
- `vault.hashicorp.com/role` - configures the Vault role used by the Vault Agent
auto-auth method. Required when `vault.hashicorp.com/agent-configmap` is not set.

- `vault.hashicorp.com/service` - name of the Vault service to use. This value
overrides the default service configured in the controller and is usually not
needed.
- `vault.hashicorp.com/service` - configures the Vault address for the injected
Vault Agent to use. This value overrides the default Vault address configured
in the injector, and may either be the address of a Vault service within the
same Kubernetes cluster as the injector, or an external Vault URL.

- `vault.hashicorp.com/tls-secret` - name of the Kubernetes secret containing TLS
Client and CA certificates and keys. This is mounted to `/vault/tls`.
Expand Down

0 comments on commit 5132ebc

Please sign in to comment.