promoting version 6.2.12-1

RedisLabs · Sep 15, 2022 · dd73cb0 · dd73cb0
1 parent 60f623f
commit dd73cb0
Show file tree

Hide file tree

Showing 39 changed files with 3,412 additions and 3,656 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1 @@
-.idea
+*bundle.yaml
diff --git a/README.md b/README.md
diff --git a/bundle.yaml b/bundle.yaml
diff --git a/crds/README.md b/crds/README.md
@@ -0,0 +1,30 @@
+## CRD's Schema<br/>
+
+
+Purpose:
+The schema is meant to ease the use of CRDs by restricting the fields to defined types and providing relevant description.
+
+
+### Work Flow - How add a new field:
+* Not all steps are always required
+
+#### 1. Update Tags:
+In the files 
++ `pkg/apis/app/v1alpha1/redisenterprisedatabase_types.go`<br/>
++ `pkg/apis/app/v1alpha1/redisenterprisecluster_types.go`<br/>
+add tags on top of variables to mark allowed types (Enum)<br/>
+(see: https://book.kubebuilder.io/reference/markers/crd-validation.html).<br/>
+They will be used by the operator sdk when creating the scheme.<br/>
+**Default values** do not appear in the schema since the operator has its own default mechanism.
+
+
+#### 2 .Create the schema:
+1) Install operator-sdk version 0.17.2.<br/> 
+See: https://sdk.operatorframework.io/docs/installation/install-operator-sdk/#install-from-github-release
+2) Run `operator-sdk generate crds`
+
+#### 3. Update the schema:
+- Edit the current schema in all of the relevant CRD yamls with the new section that was generated<br/>
+- Note that fields which are k8s objects might be very long - e.g. `SideContainersSpec`
+in this case -<br/>it appears in the schema but with no description in the fields since it extends the schema and is not unique for Redis Enterprise. 
+
diff --git a/crds/rec_crd.yaml b/crds/rec_crd.yaml
@@ -172,18 +172,23 @@ spec:
               bootstrapperImageSpec:
                 description: Specification for Bootstrapper container image
                 properties:
+                  digestHash:
+                    description: 'The digest hash of the container image to pull.
+                      When specified, the container image is pulled according to the
+                      digest hash instead of the image tag. The versionTag field must
+                      also be specified with the image tag matching this digest hash.
+                      Note: This field is only supported for OLM deployments.'
+                    type: string
                   imagePullPolicy:
-                    description: PullPolicy describes a policy for if/when to pull a
-                      container image
+                    description: The image pull policy to be applied to the container
+                      image. One of Always, Never, IfNotPresent.
                     type: string
                   repository:
-                    description: Repository
+                    description: The repository (name) of the container image to be
+                      deployed.
                     type: string
                   versionTag:
-                    type: string
-                  digestHash:
-                    description: 'The digest hash of the image to pull. Version tag must be also specified with the corresponding version, will use the digest hash to pull the image if exists.
-                      Note: This is currently supported only for OLM.'
+                    description: The tag of the container image to be deployed.
                     type: string
                 type: object
               bootstrapperResources:
@@ -343,6 +348,17 @@ spec:
                 - dbFqdnSuffix
                 - method
                 type: object
+              services:
+                description: Redis-Enterprise-Operator services specifications.
+                properties:
+                  servicesAnnotations:
+                    additionalProperties:
+                      type: string
+                    description: Global additional annotations to set on service resources
+                      created by the operator.
+                      Note - The specified annotations will not override annotations that already exists and didn't originated from the operator.
+                    type: object
+                type: object
               license:
                 description: Redis Enterprise License
                 type: string
@@ -556,7 +572,12 @@ spec:
                     type: array
                 type: object
               podSecurityPolicyName:
-                description: Name of pod security policy to use on pods See https://kubernetes.io/docs/concepts/policy/pod-security-policy/
+                description: "DEPRECATED PodSecurityPolicy support is removed in Kubernetes
+                  v1.25 and the use of this field is invalid for use when running
+                  on Kubernetes v1.25+. Future versions of the RedisEnterpriseCluster
+                  API will remove support for this field altogether. For migration
+                  instructions, see https://kubernetes.io/docs/tasks/configure-pod-container/migrate-from-psp/
+                  \n Name of pod security policy to use on pods"                
                 type: string
               podStartingPolicy:
                 description: Mitigation setting for STS pods stuck in "ContainerCreating"
@@ -2999,18 +3020,23 @@ spec:
               redisEnterpriseImageSpec:
                 description: Specification for Redis Enterprise container image
                 properties:
+                  digestHash:
+                    description: 'The digest hash of the container image to pull.
+                      When specified, the container image is pulled according to the
+                      digest hash instead of the image tag. The versionTag field must
+                      also be specified with the image tag matching this digest hash.
+                      Note: This field is only supported for OLM deployments.'
+                    type: string
                   imagePullPolicy:
-                    description: PullPolicy describes a policy for if/when to pull a
-                      container image
+                    description: The image pull policy to be applied to the container
+                      image. One of Always, Never, IfNotPresent.
                     type: string
                   repository:
-                    description: Repository
+                    description: The repository (name) of the container image to be
+                      deployed.
                     type: string
                   versionTag:
-                    type: string
-                  digestHash:
-                    description: 'The digest hash of the image to pull. Version tag must be also specified with the corresponding version, will use the digest hash to pull the image if exists.
-                      Note: This is currently supported only for OLM.'
+                    description: The tag of the container image to be deployed.
                     type: string
                 type: object
               redisEnterpriseNodeResources:
@@ -3124,14 +3150,23 @@ spec:
               redisEnterpriseServicesRiggerImageSpec:
                 description: Specification for Services Rigger container image
                 properties:
+                  digestHash:
+                    description: 'The digest hash of the container image to pull.
+                      When specified, the container image is pulled according to the
+                      digest hash instead of the image tag. The versionTag field must
+                      also be specified with the image tag matching this digest hash.
+                      Note: This field is only supported for OLM deployments.'
+                    type: string
                   imagePullPolicy:
-                    description: PullPolicy describes a policy for if/when to pull a
-                      container image
+                    description: The image pull policy to be applied to the container
+                      image. One of Always, Never, IfNotPresent.
                     type: string
                   repository:
-                    description: Repository
+                    description: The repository (name) of the container image to be
+                      deployed.
                     type: string
                   versionTag:
+                    description: The tag of the container image to be deployed.
                     type: string
                 type: object
               redisEnterpriseServicesRiggerResources:
@@ -6258,7 +6293,10 @@ spec:
               uiAnnotations:
                 additionalProperties:
                   type: string
-                description: Annotations for Redis Enterprise UI service
+                description: Annotations for Redis Enterprise UI service.
+                  This annotations will override the overlapping global annotations set under spec.services.servicesAnnotations
+                  Note - The specified annotations will not override annotations that already exists and didn't originated from the operator
+                  except for the following reserved annotation name redis.io/last-keys.
                 type: object
               uiServiceType:
                 description: Type of service used to expose Redis Enterprise UI (https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
@@ -7070,14 +7108,23 @@ spec:
               bootstrapperImageSpec:
                 description: Specification for Bootstrapper container image
                 properties:
+                  digestHash:
+                    description: 'The digest hash of the container image to pull.
+                      When specified, the container image is pulled according to the
+                      digest hash instead of the image tag. The versionTag field must
+                      also be specified with the image tag matching this digest hash.
+                      Note: This field is only supported for OLM deployments.'
+                    type: string
                   imagePullPolicy:
-                    description: PullPolicy describes a policy for if/when to pull a
-                      container image
+                    description: The image pull policy to be applied to the container
+                      image. One of Always, Never, IfNotPresent.
                     type: string
                   repository:
-                    description: Repository
+                    description: The repository (name) of the container image to be
+                      deployed.
                     type: string
                   versionTag:
+                    description: The tag of the container image to be deployed.
                     type: string
                 type: object
               bootstrapperResources:
@@ -7236,6 +7283,17 @@ spec:
                 - dbFqdnSuffix
                 - method
                 type: object
+              services:
+                description: Redis-Enterprise-Operator services specifications.
+                properties:
+                  servicesAnnotations:
+                    additionalProperties:
+                      type: string
+                    description: Global additional annotations to set on service resources
+                      created by the operator.
+                      Note - The specified annotations will not override annotations that already exists and didn't originated from the operator.
+                    type: object
+                type: object
               license:
                 description: Redis Enterprise License
                 type: string
@@ -7449,7 +7507,12 @@ spec:
                     type: array
                 type: object
               podSecurityPolicyName:
-                description: Name of pod security policy to use on pods See https://kubernetes.io/docs/concepts/policy/pod-security-policy/
+                description: "DEPRECATED PodSecurityPolicy support is removed in Kubernetes
+                  v1.25 and the use of this field is invalid for use when running
+                  on Kubernetes v1.25+. Future versions of the RedisEnterpriseCluster
+                  API will remove support for this field altogether. For migration
+                  instructions, see https://kubernetes.io/docs/tasks/configure-pod-container/migrate-from-psp/
+                  \n Name of pod security policy to use on pods"
                 type: string
               podStartingPolicy:
                 description: Mitigation setting for STS pods stuck in "ContainerCreating"
@@ -9893,18 +9956,23 @@ spec:
               redisEnterpriseImageSpec:
                 description: Specification for Redis Enterprise container image
                 properties:
+                  digestHash:
+                    description: 'The digest hash of the container image to pull.
+                      When specified, the container image is pulled according to the
+                      digest hash instead of the image tag. The versionTag field must
+                      also be specified with the image tag matching this digest hash.
+                      Note: This field is only supported for OLM deployments.'
+                    type: string
                   imagePullPolicy:
-                    description: PullPolicy describes a policy for if/when to pull a
-                      container image
+                    description: The image pull policy to be applied to the container
+                      image. One of Always, Never, IfNotPresent.
                     type: string
                   repository:
-                    description: Repository
+                    description: The repository (name) of the container image to be
+                      deployed.
                     type: string
                   versionTag:
-                    type: string
-                  digestHash:
-                    description: 'The digest hash of the image to pull. Version tag must be also specified with the corresponding version, will use the digest hash to pull the image if exists.
-                      Note: This is currently supported only for OLM.'
+                    description: The tag of the container image to be deployed.
                     type: string
                 type: object
               redisEnterpriseNodeResources:
@@ -10018,18 +10086,23 @@ spec:
               redisEnterpriseServicesRiggerImageSpec:
                 description: Specification for Services Rigger container image
                 properties:
+                  digestHash:
+                    description: 'The digest hash of the container image to pull.
+                      When specified, the container image is pulled according to the
+                      digest hash instead of the image tag. The versionTag field must
+                      also be specified with the image tag matching this digest hash.
+                      Note: This field is only supported for OLM deployments.'
+                    type: string
                   imagePullPolicy:
-                    description: PullPolicy describes a policy for if/when to pull a
-                      container image
+                    description: The image pull policy to be applied to the container
+                      image. One of Always, Never, IfNotPresent.
                     type: string
                   repository:
-                    description: Repository
+                    description: The repository (name) of the container image to be
+                      deployed.
                     type: string
                   versionTag:
-                    type: string
-                  digestHash:
-                    description: 'The digest hash of the image to pull. Version tag must be also specified with the corresponding version, will use the digest hash to pull the image if exists.
-                      Note: This is currently supported only for OLM.'
+                    description: The tag of the container image to be deployed.
                     type: string
                 type: object
               redisEnterpriseServicesRiggerResources:
@@ -13156,7 +13229,10 @@ spec:
               uiAnnotations:
                 additionalProperties:
                   type: string
-                description: Annotations for Redis Enterprise UI service
+                description: Annotations for Redis Enterprise UI service.
+                  This annotations will override the overlapping global annotations set under spec.services.servicesAnnotations
+                  Note - The specified annotations will not override annotations that already exists and didn't originated from the operator
+                  except for the following reserved annotation name redis.io/last-keys.
                 type: object
               uiServiceType:
                 description: Type of service used to expose Redis Enterprise UI (https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)

diff --git a/crds/redb_crd.yaml b/crds/redb_crd.yaml
@@ -449,30 +449,39 @@ spec:
                 items:
                   properties:
                     clientKeySecret:
-                      description: Secret that defines what client key to use.  The
-                        secret needs 2 keys in it's map, "cert" that is the PEM encoded
-                        certificate and "key" that is the PEM encoded private key
+                      description: 'Secret that defines the client certificate and
+                        key used by the syncer in the target database cluster. The
+                        secret must have 2 keys in its map: "cert" which is the PEM
+                        encoded certificate, and "key" which is the PEM encoded private
+                        key.'
                       type: string
                     compression:
-                      description: GZIP Compression level (0-9) to use for replication
+                      description: GZIP compression level (0-6) to use for replication.
                       type: integer
                     replicaSourceName:
-                      description: Kubernetes resource name of type ReplicaSourceType
+                      description: The name of the resource from which the source
+                        database URI is derived. The type of resource must match the
+                        type specified in the ReplicaSourceType field.
                       type: string
                     replicaSourceType:
-                      description: Determines what Kuberetes resource ReplicaSourceName
-                        refers to SECRET - Get URI from secret named in ReplicaSourceName.  The
-                        secret will have a uri key that defines the complete, redis://
-                        URI REDB - Determine URI from Kubernetes REDB resource named
-                        in ReplicaSourceName
+                      description: The type of resource from which the source database
+                        URI is derived. If set to 'SECRET', the source database URI
+                        is derived from the secret named in the ReplicaSourceName
+                        field. The secret must have a key named 'uri' that defines
+                        the URI of the source database in the form of 'redis://...'.
+                        The type of secret (kubernetes, vault, ...) is determined
+                        by the secret mechanism used by the underlying REC object.
+                        If set to 'REDB', the source database URI is derived from
+                        the RedisEnterpriseDatabase resource named in the ReplicaSourceName
+                        field.
                       type: string
                     serverCertSecret:
-                      description: Secret that defines the Server's certificate.  The
-                        secret needs 1 key in it's map, "cert" that is the PEM encoded
-                        certificate
+                      description: 'Secret that defines the server certificate used
+                        by the proxy in the source database cluster. The secret must
+                        have 1 key in its map: "cert" which is the PEM encoded certificate.'
                       type: string
                     tlsSniName:
-                      description: TLS SNI Name to use
+                      description: TLS SNI name to use for the replication link.
                       type: string
                   required:
                   - replicaSourceName