Go to file
Tobias Trabelsi 2c9d1794a5
All checks were successful
continuous-integration/drone/push Build is passing
added Artifact Hub link
2022-10-29 21:32:09 +02:00
.github/workflows release on push to main branch 2022-10-03 19:17:16 +02:00
charts/bitwarden-crd-operator fixed kube version typo 2022-10-25 22:04:40 +02:00
.dockerignore wip 2022-09-04 23:21:33 +02:00
.drone.yml drone release pipeline 2022-10-03 17:59:46 +02:00
.gitignore wrapping bitwarden cli to login and get an item 2022-09-12 23:03:28 +02:00
bitwarden-crd-operator.py free-key-value-definition (#1) 2022-10-03 14:00:11 +00:00
CODE_OF_CONDUCT.md wrapping bitwarden cli to login and get an item 2022-09-12 23:03:28 +02:00
Dockerfile silence pip warning 2022-09-14 22:58:48 +02:00
example.yaml free-key-value-definition (#1) 2022-10-03 14:00:11 +00:00
LICENSE wrapping bitwarden cli to login and get an item 2022-09-12 23:03:28 +02:00
pyvenv.cfg wip 2022-09-04 23:21:33 +02:00
README.md added Artifact Hub link 2022-10-29 21:32:09 +02:00
requirements.txt Removed no longer needed dependency 2022-10-03 21:06:50 +00:00

Bitwarden CRD Operator

Build Status Artifact Hub

Bitwarden CRD Operator is a kubernetes Operator based on kopf. The goal is to create kubernetes native secret objects from bitwarden.

DISCLAIMER:
This project is still very work in progress :)

Getting started

You will need a ClientID and ClientSecret (where to get these) as well as your password. Expose these to the operator as described in this example:

env:
  - name: BW_HOST
    value: "https://bitwarden.your.tld.org"
  - name: BW_CLIENTID
    value: "user.your-client-id"
  - name: BW_CLIENTSECRET
    value: "YoUrCliEntSecRet"
  - name: BW_PASSWORD
    value: "YourSuperSecurePassword"

you can also create a secret manually with these information and reference the existing secret like this in the values.yaml:

externalConfigSecret:
  enabled: true
  name: "my-existing-secret"

the helm template will use all environment variables from this secret, so make sure to prepare this secret with the key value pairs as described above.

BW_HOST can be omitted if you are using the Bitwarden SaaS offering.

After that it is a basic helm deployment:

helm repo add bitwarden-operator https://lerentis.github.io/bitwarden-crd-operator
helm repo update 
kubectl create namespace bw-operator
helm upgrade --install --namespace bw-operator -f values.yaml bw-operator bitwarden-operator/bitwarden-crd-operator

And you are set to create your first secret using this operator. For that you need to add a CRD Object like this to your cluster:

---
apiVersion: "lerentis.uploadfilter24.eu/v1beta2"
kind: BitwardenSecret
metadata:
  name: name-of-your-management-object
spec:
  content:
    - element:
        secretName: nameOfTheFieldInBitwarden # for example username
        secretRef: nameOfTheKeyInTheSecretToBeCreated 
    - element:
        secretName: nameOfAnotherFieldInBitwarden # for example password
        secretRef: nameOfAnotherKeyInTheSecretToBeCreated 
  id: "A Secret ID from bitwarden"
  name: "Name of the secret to be created"
  namespace: "Namespace of the secret to be created"

The ID can be extracted from the browser when you open a item the ID is in the URL. The resulting secret looks something like this:

apiVersion: v1
data:
  nameOfTheKeyInTheSecretToBeCreated: "base64 encoded value of TheFieldInBitwarden"
  nameOfAnotherKeyInTheSecretToBeCreated: "base64 encoded value of AnotherFieldInBitwarden"
kind: Secret
metadata:
  annotations:
    managed: bitwarden-secrets.lerentis.uploadfilter24.eu
    managedObject: bw-operator/test
  name: name-of-your-management-object
  namespace: default
type: Opaque

Short Term Roadmap

  • support more types
  • offer option to use a existing secret in helm chart
  • host chart on gh pages
  • write release pipeline
  • maybe extend spec to offer modification of keys as well