fixed readme in charts folder for artifacthub
This commit is contained in:
parent
884476606c
commit
2611231c8a
@ -4,9 +4,14 @@
|
||||
|
||||
Bitwarden CRD Operator is a kubernetes Operator based on [kopf](https://github.com/nolar/kopf/). The goal is to create kubernetes native secret objects from bitwarden.
|
||||
|
||||
<p align="center">
|
||||
<img src="https://github.com/Lerentis/bitwarden-crd-operator/blob/main/logo.png?raw=true" alt="Bitwarden CRD Operator Logo" width="200"/>
|
||||
</p>
|
||||
|
||||
> DISCLAIMER:
|
||||
> This project is still very work in progress :)
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
You will need a `ClientID` and `ClientSecret` ([where to get these](https://bitwarden.com/help/personal-api-key/)) as well as your password.
|
||||
@ -51,7 +56,7 @@ And you are set to create your first secret using this operator. For that you ne
|
||||
|
||||
```yaml
|
||||
---
|
||||
apiVersion: "lerentis.uploadfilter24.eu/v1beta3"
|
||||
apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
|
||||
kind: BitwardenSecret
|
||||
metadata:
|
||||
name: name-of-your-management-object
|
||||
@ -60,9 +65,11 @@ spec:
|
||||
- element:
|
||||
secretName: nameOfTheFieldInBitwarden # for example username
|
||||
secretRef: nameOfTheKeyInTheSecretToBeCreated
|
||||
secretScope: login # for custom entries on bitwarden use 'fields'
|
||||
- element:
|
||||
secretName: nameOfAnotherFieldInBitwarden # for example password
|
||||
secretRef: nameOfAnotherKeyInTheSecretToBeCreated
|
||||
secretScope: login # for custom entries on bitwarden use 'fields'
|
||||
id: "A Secret ID from bitwarden"
|
||||
name: "Name of the secret to be created"
|
||||
namespace: "Namespace of the secret to be created"
|
||||
@ -91,7 +98,7 @@ For managing registry credentials, or pull secrets, you can create another kind
|
||||
|
||||
```yaml
|
||||
---
|
||||
apiVersion: "lerentis.uploadfilter24.eu/v1beta3"
|
||||
apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
|
||||
kind: RegistryCredential
|
||||
metadata:
|
||||
name: name-of-your-management-object
|
||||
@ -120,10 +127,46 @@ metadata:
|
||||
type: dockerconfigjson
|
||||
```
|
||||
|
||||
## Short Term Roadmap
|
||||
## BitwardenTemplate
|
||||
|
||||
- [ ] support more types
|
||||
- [x] offer option to use a existing secret in helm chart
|
||||
- [x] host chart on gh pages
|
||||
- [x] write release pipeline
|
||||
- [x] maybe extend spec to offer modification of keys as well
|
||||
One of the more freely defined types that can be used with this operator you can just pass a whole template:
|
||||
|
||||
```yaml
|
||||
---
|
||||
apiVersion: "lerentis.uploadfilter24.eu/v1beta4"
|
||||
kind: BitwardenTemplate
|
||||
metadata:
|
||||
name: name-of-your-management-object
|
||||
spec:
|
||||
filename: "Key of the secret to be created"
|
||||
name: "Name of the secret to be created"
|
||||
namespace: "Namespace of the secret to be created"
|
||||
template: |
|
||||
---
|
||||
api:
|
||||
enabled: True
|
||||
key: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields", "name of a field in bitwarden") }}
|
||||
allowCrossOrigin: false
|
||||
apps:
|
||||
"some.app.identifier:some_version":
|
||||
pubkey: {{ bitwarden_lookup("A Secret ID from bitwarden", "login or fields", "name of a field in bitwarden") }}
|
||||
enabled: true
|
||||
```
|
||||
|
||||
This will result in something like the following object:
|
||||
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
data:
|
||||
Key of the secret to be created: "base64 encoded and rendered template with secrets injected directly from bitwarden"
|
||||
kind: Secret
|
||||
metadata:
|
||||
annotations:
|
||||
managed: bitwarden-template.lerentis.uploadfilter24.eu
|
||||
managedObject: namespace/name-of-your-management-object
|
||||
name: Name of the secret to be created
|
||||
namespace: Namespace of the secret to be created
|
||||
type: Opaque
|
||||
```
|
||||
|
||||
please note that the rendering engine for this template is jinja2, with an addition of a custom `bitwarden_lookup` function, so there are more possibilities to inject here.
|
||||
|
Loading…
Reference in New Issue
Block a user