README
¶
Vault Operator
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.
Directories
¶
Path | Synopsis |
---|---|
examples
Module
|
|
pkg
|
|
apis/vault/v1alpha1
Package v1alpha1 contains API Schema definitions for the vault.banzaicloud.com v1alpha1 API group
|
Package v1alpha1 contains API Schema definitions for the vault.banzaicloud.com v1alpha1 API group |
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
client/clientset/versioned/typed/vault/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
client/clientset/versioned/typed/vault/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
Click to show internal directories.
Click to hide internal directories.