Skip to content

bank-vaults/vault-operator

Vault Operator

GitHub Workflow Status OpenSSF Scorecard OpenSSF Best Practices Artifact Hub

Kubernetes operator for Hashicorp Vault.

Documentation

The official documentation for the operator is available at https://bank-vaults.dev.

Version compatibility matrix

Please see VERSIONS.md for version compatibility.

Development

For an optimal developer experience, it is recommended to install Nix and direnv.

Alternatively, install Go on your computer then run make deps to install the rest of the dependencies.

Make sure Docker is installed with Compose and Buildx.

Fetch required tools:

make deps

Run project dependencies:

make up

Run the operator:

make run

Run the test suite:

make test
make test-acceptance

Run linters:

make lint # pass -j option to run them in parallel

Some linter violations can automatically be fixed:

make fmt

Build artifacts locally:

make artifacts

Once you are done, you can tear down project dependencies:

make down

License

The project is licensed under the Apache 2.0 License.