Operator to sync Devolutions Server Credential Entry - Username / Password entries as Kubernetes Secrets
This operator uses the defined custom resource DvlsSecret which manages its own Kubernetes Secret and will keep itself up to date at a defined interval (every minute by default). The Docker image can be found here.
The following Environment Variables can be used to configure the operator :
DEVO_OPERATOR_DVLS_BASEURI(required) - DVLS instance base URIDEVO_OPERATOR_DVLS_APPID(required) - DVLS Application IDDEVO_OPERATOR_DVLS_APPSECRET(required) - DVLS Application SecretDEVO_OPERATOR_REQUEUE_DURATION(optional) - Entry/Secret resync interval (default 60s). Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
A sample of the custom resource can be found here.
The entry ID can be fetched by going in the entry properties, Advanced -> Session ID.
We recommend creating an Application ID specifically to be used with the Operator that has minimal access to a vault that only contains the secrets to be synchronized.
Only Credential Entry - Username / Password entries are supported at the moment. The following entry data is available per secret :
- entry name
- username
- password
Since this operator uses Kubernetes Secrets, it is recommended that you follow best practices surrounding secrets, especially encryption at rest.
You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).
An Helm Chart is available to simplify installation, just add our helm chart repository, create a values.yaml from the default values as a baseline and update values as necessary. Run helm install and add your values.yaml.
The following values should be updated from your values.yaml
- controllerManager.manager.env.devoOperatorDvlsBaseuri
- controllerManager.manager.env.devoOperatorDvlsAppid
- instanceSecret.secret
helm repo add devolutions-helm-charts https://devolutions.github.io/helm-charts
helm repo update
helm install dvls-kubernetes-operator devolutions-helm-charts/dvls-kubernetes-operator --values values.yaml- Install Instances of Custom Resources:
kubectl apply -f config/samples/- Build and push your image to the location specified by
IMG:
make docker-build docker-push IMG=<some-registry>/dvls-kubernetes-operator:tag- Deploy the controller to the cluster with the image specified by
IMG:
make deploy IMG=<some-registry>/dvls-kubernetes-operator:tagTo delete the CRDs from the cluster:
make uninstallUnDeploy the controller to the cluster:
make undeployThis project aims to follow the Kubernetes Operator pattern
It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
- Install the CRDs into the cluster:
make install- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make runNOTE: You can also run this in one step by running: make install run
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifestsNOTE: Run make --help for more information on all potential make targets
More information can be found via the Kubebuilder Documentation
Copyright 2023.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.