README
¶
Topicus KeyHub Vault Operator
Manage Kubernetes Secrets with Topicus KeyHub and the KeyHubSecret
resource.
Documentation
The documentation can be found here.
Getting started
You will need Golang version 1.21 or higher.
Run the operator locally. Make sure you are connecting to your local minikube cluster!
make run
By default the operator will look for a keyhub-vault-operator-secret
in the default
namespace.
Run the tests
make test
Development
- Install minikube or something similar
- Install Operator SDK
Git pre-commit hook to check Conventional Commits
Use conventional commits, even if you skip this optional pre-commit hook.
- Install
pre-commit
- Install
pre-commit
script (more info):pre-commit install --hook-type commit-msg
Install
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: keyhub-vault-operator
resources:
- ssh://github.com/topicuskeyhub/keyhub-vault-operator//config/default?ref=main
Release
- Manually run the
Release
workflow (branchmain
) from Github Actions.
The Release
workflow will do the following:
- Update
images['controller'].newTag
inconfig/manager/kustomization.yaml
with the full semver (prefixed with a 'v'), e.g.v0.1.0
. The semver is based on conventional commits and the latest git tag. - Create and push the release tag, e.g.
v0.1.0
. - Create a GitHub release with a changelog based on the (conventional) commits since the last release.
- The build workflow will run on the tag to publish te build.
Documentation
¶
There is no documentation for this package.
Directories
¶
Path | Synopsis |
---|---|
v1alpha1
Package v1alpha1 contains API Schema definitions for the keyhub v1alpha1 API group +kubebuilder:object:generate=true +groupName=keyhub.topicus.nl
|
Package v1alpha1 contains API Schema definitions for the keyhub v1alpha1 API group +kubebuilder:object:generate=true +groupName=keyhub.topicus.nl |
Click to show internal directories.
Click to hide internal directories.