|
| 1 | +apiVersion: apiextensions.k8s.io/v1 |
| 2 | +kind: CustomResourceDefinition |
| 3 | +metadata: |
| 4 | + name: keycloakbackups.keycloak.org |
| 5 | +spec: |
| 6 | + group: keycloak.org |
| 7 | + names: |
| 8 | + kind: KeycloakBackup |
| 9 | + listKind: KeycloakBackupList |
| 10 | + plural: keycloakbackups |
| 11 | + singular: keycloakbackup |
| 12 | + scope: Namespaced |
| 13 | + versions: |
| 14 | + - name: v1alpha1 |
| 15 | + schema: |
| 16 | + openAPIV3Schema: |
| 17 | + description: KeycloakBackup is the Schema for the keycloakbackups API. |
| 18 | + properties: |
| 19 | + apiVersion: |
| 20 | + description: 'APIVersion defines the versioned schema of this representation |
| 21 | + of an object. Servers should convert recognized schemas to the latest |
| 22 | + internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' |
| 23 | + type: string |
| 24 | + kind: |
| 25 | + description: 'Kind is a string value representing the REST resource this |
| 26 | + object represents. Servers may infer this from the endpoint the client |
| 27 | + submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' |
| 28 | + type: string |
| 29 | + metadata: |
| 30 | + type: object |
| 31 | + spec: |
| 32 | + description: KeycloakBackupSpec defines the desired state of KeycloakBackup. |
| 33 | + properties: |
| 34 | + aws: |
| 35 | + description: If provided, an automatic database backup will be created |
| 36 | + on AWS S3 instead of a local Persistent Volume. If this property |
| 37 | + is not provided - a local Persistent Volume backup will be chosen. |
| 38 | + properties: |
| 39 | + credentialsSecretName: |
| 40 | + description: "Provides a secret name used for connecting to AWS |
| 41 | + S3 Service. The secret needs to be in the following form: \n |
| 42 | + \ apiVersion: v1 kind: Secret metadata: name: |
| 43 | + <Secret name> type: Opaque stringData: AWS_S3_BUCKET_NAME: |
| 44 | + <S3 Bucket Name> AWS_ACCESS_KEY_ID: <AWS Access Key ID> |
| 45 | + \ AWS_SECRET_ACCESS_KEY: <AWS Secret Key> \n For more information, |
| 46 | + please refer to the Operator documentation." |
| 47 | + type: string |
| 48 | + encryptionKeySecretName: |
| 49 | + description: "If provided, the database backup will be encrypted. |
| 50 | + Provides a secret name used for encrypting database data. The |
| 51 | + secret needs to be in the following form: \n apiVersion: |
| 52 | + v1 kind: Secret metadata: name: <Secret name> |
| 53 | + \ type: Opaque stringData: GPG_PUBLIC_KEY: <GPG |
| 54 | + Public Key> GPG_TRUST_MODEL: <GPG Trust Model> GPG_RECIPIENT: |
| 55 | + <GPG Recipient> \n For more information, please refer to the |
| 56 | + Operator documentation." |
| 57 | + type: string |
| 58 | + schedule: |
| 59 | + description: If specified, it will be used as a schedule for creating |
| 60 | + a CronJob. |
| 61 | + type: string |
| 62 | + type: object |
| 63 | + instanceSelector: |
| 64 | + description: Selector for looking up Keycloak Custom Resources. |
| 65 | + properties: |
| 66 | + matchExpressions: |
| 67 | + description: matchExpressions is a list of label selector requirements. |
| 68 | + The requirements are ANDed. |
| 69 | + items: |
| 70 | + description: A label selector requirement is a selector that |
| 71 | + contains values, a key, and an operator that relates the key |
| 72 | + and values. |
| 73 | + properties: |
| 74 | + key: |
| 75 | + description: key is the label key that the selector applies |
| 76 | + to. |
| 77 | + type: string |
| 78 | + operator: |
| 79 | + description: operator represents a key's relationship to |
| 80 | + a set of values. Valid operators are In, NotIn, Exists |
| 81 | + and DoesNotExist. |
| 82 | + type: string |
| 83 | + values: |
| 84 | + description: values is an array of string values. If the |
| 85 | + operator is In or NotIn, the values array must be non-empty. |
| 86 | + If the operator is Exists or DoesNotExist, the values |
| 87 | + array must be empty. This array is replaced during a strategic |
| 88 | + merge patch. |
| 89 | + items: |
| 90 | + type: string |
| 91 | + type: array |
| 92 | + required: |
| 93 | + - key |
| 94 | + - operator |
| 95 | + type: object |
| 96 | + type: array |
| 97 | + matchLabels: |
| 98 | + additionalProperties: |
| 99 | + type: string |
| 100 | + description: matchLabels is a map of {key,value} pairs. A single |
| 101 | + {key,value} in the matchLabels map is equivalent to an element |
| 102 | + of matchExpressions, whose key field is "key", the operator |
| 103 | + is "In", and the values array contains only "value". The requirements |
| 104 | + are ANDed. |
| 105 | + type: object |
| 106 | + type: object |
| 107 | + restore: |
| 108 | + description: "Controls automatic restore behavior. Currently not implemented. |
| 109 | + \n In the future this will be used to trigger automatic restore |
| 110 | + for a given KeycloakBackup. Each backup will correspond to a single |
| 111 | + snapshot of the database (stored either in a Persistent Volume or |
| 112 | + AWS). If a user wants to restore it, all he/she needs to do is to |
| 113 | + change this flag to true. Potentially, it will be possible to restore |
| 114 | + a single backup multiple times." |
| 115 | + type: boolean |
| 116 | + storageClassName: |
| 117 | + description: Name of the StorageClass for Postgresql Backup Persistent |
| 118 | + Volume Claim |
| 119 | + type: string |
| 120 | + type: object |
| 121 | + status: |
| 122 | + description: KeycloakBackupStatus defines the observed state of KeycloakBackup. |
| 123 | + properties: |
| 124 | + message: |
| 125 | + description: Human-readable message indicating details about current |
| 126 | + operator phase or error. |
| 127 | + type: string |
| 128 | + phase: |
| 129 | + description: Current phase of the operator. |
| 130 | + type: string |
| 131 | + ready: |
| 132 | + description: True if all resources are in a ready state and all work |
| 133 | + is done. |
| 134 | + type: boolean |
| 135 | + secondaryResources: |
| 136 | + additionalProperties: |
| 137 | + items: |
| 138 | + type: string |
| 139 | + type: array |
| 140 | + description: 'A map of all the secondary resources types and names |
| 141 | + created for this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2" |
| 142 | + ]' |
| 143 | + type: object |
| 144 | + required: |
| 145 | + - message |
| 146 | + - phase |
| 147 | + - ready |
| 148 | + type: object |
| 149 | + type: object |
| 150 | + served: true |
| 151 | + storage: true |
| 152 | + subresources: |
| 153 | + status: {} |
0 commit comments