fix CRD and updated docs
This commit is contained in:
		
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								README.md
									
									
									
									
									
								
							| @@ -56,7 +56,7 @@ And you are set to create your first secret using this operator. For that you ne | |||||||
|  |  | ||||||
| ```yaml | ```yaml | ||||||
| --- | --- | ||||||
| apiVersion: "lerentis.uploadfilter24.eu/v1beta4" | apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | ||||||
| kind: BitwardenSecret | kind: BitwardenSecret | ||||||
| metadata: | metadata: | ||||||
|   name: name-of-your-management-object |   name: name-of-your-management-object | ||||||
| @@ -73,6 +73,8 @@ spec: | |||||||
|   id: "A Secret ID from bitwarden" |   id: "A Secret ID from bitwarden" | ||||||
|   name: "Name of the secret to be created" |   name: "Name of the secret to be created" | ||||||
|   namespace: "Namespace of the secret to be created" |   namespace: "Namespace of the secret to be created" | ||||||
|  |   labels: # Optional | ||||||
|  |     key: value | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| 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: | 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: | ||||||
| @@ -87,6 +89,8 @@ metadata: | |||||||
|   annotations: |   annotations: | ||||||
|     managed: bitwarden-secrets.lerentis.uploadfilter24.eu |     managed: bitwarden-secrets.lerentis.uploadfilter24.eu | ||||||
|     managedObject: bw-operator/test |     managedObject: bw-operator/test | ||||||
|  |   labels: | ||||||
|  |     key: value | ||||||
|   name: name-of-your-management-object |   name: name-of-your-management-object | ||||||
|   namespace: default |   namespace: default | ||||||
| type: Opaque | type: Opaque | ||||||
| @@ -98,7 +102,7 @@ For managing registry credentials, or pull secrets, you can create another kind | |||||||
|  |  | ||||||
| ```yaml | ```yaml | ||||||
| --- | --- | ||||||
| apiVersion: "lerentis.uploadfilter24.eu/v1beta4" | apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | ||||||
| kind: RegistryCredential | kind: RegistryCredential | ||||||
| metadata: | metadata: | ||||||
|   name: name-of-your-management-object |   name: name-of-your-management-object | ||||||
| @@ -109,6 +113,8 @@ spec: | |||||||
|   id: "A Secret ID from bitwarden" |   id: "A Secret ID from bitwarden" | ||||||
|   name: "Name of the secret to be created" |   name: "Name of the secret to be created" | ||||||
|   namespace: "Namespace of the secret to be created" |   namespace: "Namespace of the secret to be created" | ||||||
|  |   labels: # Optional | ||||||
|  |     key: value | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| The resulting secret looks something like this: | The resulting secret looks something like this: | ||||||
| @@ -122,6 +128,8 @@ metadata: | |||||||
|   annotations: |   annotations: | ||||||
|     managed: bitwarden-secrets.lerentis.uploadfilter24.eu |     managed: bitwarden-secrets.lerentis.uploadfilter24.eu | ||||||
|     managedObject: bw-operator/test |     managedObject: bw-operator/test | ||||||
|  |   labels: | ||||||
|  |     key: value | ||||||
|   name: name-of-your-management-object |   name: name-of-your-management-object | ||||||
|   namespace: default |   namespace: default | ||||||
| type: dockerconfigjson | type: dockerconfigjson | ||||||
| @@ -133,7 +141,7 @@ One of the more freely defined types that can be used with this operator you can | |||||||
|  |  | ||||||
| ```yaml | ```yaml | ||||||
| --- | --- | ||||||
| apiVersion: "lerentis.uploadfilter24.eu/v1beta4" | apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | ||||||
| kind: BitwardenTemplate | kind: BitwardenTemplate | ||||||
| metadata: | metadata: | ||||||
|   name: name-of-your-management-object |   name: name-of-your-management-object | ||||||
| @@ -141,6 +149,8 @@ spec: | |||||||
|   filename: "Key of the secret to be created" |   filename: "Key of the secret to be created" | ||||||
|   name: "Name of the secret to be created" |   name: "Name of the secret to be created" | ||||||
|   namespace: "Namespace of the secret to be created" |   namespace: "Namespace of the secret to be created" | ||||||
|  |   labels: # Optional | ||||||
|  |     key: value | ||||||
|   template: | |   template: | | ||||||
|     --- |     --- | ||||||
|     api: |     api: | ||||||
| @@ -164,6 +174,8 @@ metadata: | |||||||
|   annotations: |   annotations: | ||||||
|     managed: bitwarden-template.lerentis.uploadfilter24.eu |     managed: bitwarden-template.lerentis.uploadfilter24.eu | ||||||
|     managedObject: namespace/name-of-your-management-object |     managedObject: namespace/name-of-your-management-object | ||||||
|  |   labels: | ||||||
|  |     key: value | ||||||
|   name: Name of the secret to be created |   name: Name of the secret to be created | ||||||
|   namespace: Namespace of the secret to be created |   namespace: Namespace of the secret to be created | ||||||
| type: Opaque | type: Opaque | ||||||
|   | |||||||
| @@ -14,8 +14,9 @@ spec: | |||||||
|       - bws |       - bws | ||||||
|   versions: |   versions: | ||||||
|     - name: v1beta4 |     - name: v1beta4 | ||||||
|       served: false |       served: true | ||||||
|       storage: true |       storage: false | ||||||
|  |       deprecated: true | ||||||
|       schema: |       schema: | ||||||
|         openAPIV3Schema: |         openAPIV3Schema: | ||||||
|           type: object |           type: object | ||||||
| @@ -82,21 +83,8 @@ spec: | |||||||
|                 name: |                 name: | ||||||
|                   type: string |                   type: string | ||||||
|                 labels: |                 labels: | ||||||
|                   type: array |  | ||||||
|                   items: |  | ||||||
|                   type: object |                   type: object | ||||||
|                     properties: |  | ||||||
|                       json: |  | ||||||
|                   x-kubernetes-preserve-unknown-fields: true |                   x-kubernetes-preserve-unknown-fields: true | ||||||
|                         type: object |  | ||||||
|                         properties: |  | ||||||
|                           spec: |  | ||||||
|                             type: object |  | ||||||
|                             properties: |  | ||||||
|                               foo: |  | ||||||
|                                 type: string |  | ||||||
|                               bar: |  | ||||||
|                                 type: string |  | ||||||
|               required: |               required: | ||||||
|                 - id |                 - id | ||||||
|                 - namespace |                 - namespace | ||||||
|   | |||||||
| @@ -14,8 +14,9 @@ spec: | |||||||
|       - bwt |       - bwt | ||||||
|   versions: |   versions: | ||||||
|     - name: v1beta4 |     - name: v1beta4 | ||||||
|       served: false |       served: true | ||||||
|       storage: true |       storage: false | ||||||
|  |       deprecated: true | ||||||
|       schema: |       schema: | ||||||
|         openAPIV3Schema: |         openAPIV3Schema: | ||||||
|           type: object |           type: object | ||||||
| @@ -55,21 +56,8 @@ spec: | |||||||
|                 name: |                 name: | ||||||
|                   type: string |                   type: string | ||||||
|                 labels: |                 labels: | ||||||
|                   type: array |  | ||||||
|                   items: |  | ||||||
|                   type: object |                   type: object | ||||||
|                     properties: |  | ||||||
|                       json: |  | ||||||
|                   x-kubernetes-preserve-unknown-fields: true |                   x-kubernetes-preserve-unknown-fields: true | ||||||
|                         type: object |  | ||||||
|                         properties: |  | ||||||
|                           spec: |  | ||||||
|                             type: object |  | ||||||
|                             properties: |  | ||||||
|                               foo: |  | ||||||
|                                 type: string |  | ||||||
|                               bar: |  | ||||||
|                                 type: string |  | ||||||
|               required: |               required: | ||||||
|                 - filename |                 - filename | ||||||
|                 - template |                 - template | ||||||
|   | |||||||
| @@ -14,8 +14,9 @@ spec: | |||||||
|       - rgc |       - rgc | ||||||
|   versions: |   versions: | ||||||
|     - name: v1beta4 |     - name: v1beta4 | ||||||
|       served: false |       served: true | ||||||
|       storage: true |       storage: false | ||||||
|  |       deprecated: true | ||||||
|       schema: |       schema: | ||||||
|         openAPIV3Schema: |         openAPIV3Schema: | ||||||
|           type: object |           type: object | ||||||
| @@ -65,21 +66,8 @@ spec: | |||||||
|                 name: |                 name: | ||||||
|                   type: string |                   type: string | ||||||
|                 labels: |                 labels: | ||||||
|                   type: array |  | ||||||
|                   items: |  | ||||||
|                   type: object |                   type: object | ||||||
|                     properties: |  | ||||||
|                       json: |  | ||||||
|                   x-kubernetes-preserve-unknown-fields: true |                   x-kubernetes-preserve-unknown-fields: true | ||||||
|                         type: object |  | ||||||
|                         properties: |  | ||||||
|                           spec: |  | ||||||
|                             type: object |  | ||||||
|                             properties: |  | ||||||
|                               foo: |  | ||||||
|                                 type: string |  | ||||||
|                               bar: |  | ||||||
|                                 type: string |  | ||||||
|               required: |               required: | ||||||
|                 - id |                 - id | ||||||
|                 - namespace |                 - namespace | ||||||
|   | |||||||
| @@ -17,7 +17,8 @@ spec: | |||||||
|   name: "test-secret" |   name: "test-secret" | ||||||
|   namespace: "default" |   namespace: "default" | ||||||
|   labels: |   labels: | ||||||
|     - key: value |     key: value | ||||||
|  |     app: example-app | ||||||
| --- | --- | ||||||
| apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | ||||||
| kind: BitwardenSecret | kind: BitwardenSecret | ||||||
| @@ -32,5 +33,3 @@ spec: | |||||||
|   id: "466fc4b0-ffca-4444-8d88-b59d4de3d928" |   id: "466fc4b0-ffca-4444-8d88-b59d4de3d928" | ||||||
|   name: "test-scope" |   name: "test-scope" | ||||||
|   namespace: "default" |   namespace: "default" | ||||||
|   labels: |  | ||||||
|     - key: value |  | ||||||
| @@ -1,5 +1,5 @@ | |||||||
| --- | --- | ||||||
| apiVersion: "lerentis.uploadfilter24.eu/v1beta4" | apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | ||||||
| kind: RegistryCredential | kind: RegistryCredential | ||||||
| metadata: | metadata: | ||||||
|   name: test |   name: test | ||||||
| @@ -10,3 +10,6 @@ spec: | |||||||
|   id: "3b249ec7-9ce7-440a-9558-f34f3ab10680" |   id: "3b249ec7-9ce7-440a-9558-f34f3ab10680" | ||||||
|   name: "test-regcred" |   name: "test-regcred" | ||||||
|   namespace: "default" |   namespace: "default" | ||||||
|  |   labels: | ||||||
|  |     namespace: default | ||||||
|  |     tenant: example-team | ||||||
| @@ -1,5 +1,5 @@ | |||||||
| --- | --- | ||||||
| apiVersion: "lerentis.uploadfilter24.eu/v1beta4" | apiVersion: "lerentis.uploadfilter24.eu/v1beta5" | ||||||
| kind: BitwardenTemplate | kind: BitwardenTemplate | ||||||
| metadata: | metadata: | ||||||
|   name: test |   name: test | ||||||
| @@ -7,6 +7,9 @@ spec: | |||||||
|   filename: "config.yaml" |   filename: "config.yaml" | ||||||
|   name: "test-template" |   name: "test-template" | ||||||
|   namespace: "default" |   namespace: "default" | ||||||
|  |   labels: | ||||||
|  |     key: value | ||||||
|  |     app: example-app | ||||||
|   template: | |   template: | | ||||||
|     --- |     --- | ||||||
|     api: |     api: | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user