|
| 1 | +/* |
| 2 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +you may not use this file except in compliance with the License. |
| 4 | +You may obtain a copy of the License at |
| 5 | +
|
| 6 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +
|
| 8 | +Unless required by applicable law or agreed to in writing, software |
| 9 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +See the License for the specific language governing permissions and |
| 12 | +limitations under the License. |
| 13 | +*/ |
| 14 | + |
| 15 | +package v1beta1 |
| 16 | + |
| 17 | +// DEPRECATED TYPES |
| 18 | +// These types are local mirrors of the old rabbitmq-cluster-operator types, |
| 19 | +// kept only for backward compatibility with existing CRs during migration. |
| 20 | +// They will be removed in a future release once all CRs have been migrated |
| 21 | +// to use the new explicit fields in RabbitMqSpecCore. |
| 22 | + |
| 23 | +import ( |
| 24 | + appsv1 "k8s.io/api/apps/v1" |
| 25 | + corev1 "k8s.io/api/core/v1" |
| 26 | + "k8s.io/apimachinery/pkg/api/resource" |
| 27 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 28 | +) |
| 29 | + |
| 30 | +// DeprecatedEmbeddedLabelsAnnotations is an embedded subset of the fields included in |
| 31 | +// k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. Only labels and annotations are included. |
| 32 | +type DeprecatedEmbeddedLabelsAnnotations struct { |
| 33 | + // Map of string keys and values that can be used to organize and categorize (scope and select) objects. |
| 34 | + // +optional |
| 35 | + Labels map[string]string `json:"labels,omitempty"` |
| 36 | + // Annotations is an unstructured key value map stored with a resource. |
| 37 | + // +optional |
| 38 | + Annotations map[string]string `json:"annotations,omitempty"` |
| 39 | +} |
| 40 | + |
| 41 | +// DeprecatedStatefulSetOverride mirrors the old rabbitmq-cluster-operator StatefulSet type. |
| 42 | +// Used for webhook validation of the override.statefulSet JSON field. |
| 43 | +type DeprecatedStatefulSetOverride struct { |
| 44 | + // +optional |
| 45 | + *DeprecatedEmbeddedLabelsAnnotations `json:"metadata,omitempty"` |
| 46 | + // +optional |
| 47 | + Spec *DeprecatedStatefulSetSpec `json:"spec,omitempty"` |
| 48 | +} |
| 49 | + |
| 50 | +// DeprecatedStatefulSetSpec mirrors a subset of the old rabbitmq-cluster-operator StatefulSetSpec type. |
| 51 | +type DeprecatedStatefulSetSpec struct { |
| 52 | + // +optional |
| 53 | + Replicas *int32 `json:"replicas,omitempty"` |
| 54 | + // +optional |
| 55 | + Selector *metav1.LabelSelector `json:"selector,omitempty"` |
| 56 | + // +optional |
| 57 | + Template *DeprecatedPodTemplateSpec `json:"template,omitempty"` |
| 58 | + // +optional |
| 59 | + VolumeClaimTemplates []corev1.PersistentVolumeClaim `json:"volumeClaimTemplates,omitempty"` |
| 60 | + // +optional |
| 61 | + ServiceName string `json:"serviceName,omitempty"` |
| 62 | + // +optional |
| 63 | + PodManagementPolicy appsv1.PodManagementPolicyType `json:"podManagementPolicy,omitempty"` |
| 64 | + // +optional |
| 65 | + UpdateStrategy *appsv1.StatefulSetUpdateStrategy `json:"updateStrategy,omitempty"` |
| 66 | + // +optional |
| 67 | + MinReadySeconds int32 `json:"minReadySeconds,omitempty"` |
| 68 | + // +optional |
| 69 | + PersistentVolumeClaimRetentionPolicy *appsv1.StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistentVolumeClaimRetentionPolicy,omitempty"` |
| 70 | +} |
| 71 | + |
| 72 | +// DeprecatedPodTemplateSpec mirrors the old rabbitmq-cluster-operator PodTemplateSpec type. |
| 73 | +type DeprecatedPodTemplateSpec struct { |
| 74 | + // +optional |
| 75 | + *DeprecatedEmbeddedObjectMeta `json:"metadata,omitempty"` |
| 76 | + // +optional |
| 77 | + Spec *corev1.PodSpec `json:"spec,omitempty"` |
| 78 | +} |
| 79 | + |
| 80 | +// DeprecatedEmbeddedObjectMeta mirrors the old rabbitmq-cluster-operator EmbeddedObjectMeta type. |
| 81 | +type DeprecatedEmbeddedObjectMeta struct { |
| 82 | + // +optional |
| 83 | + Name string `json:"name,omitempty"` |
| 84 | + // +optional |
| 85 | + Namespace string `json:"namespace,omitempty"` |
| 86 | + // +optional |
| 87 | + Labels map[string]string `json:"labels,omitempty"` |
| 88 | + // +optional |
| 89 | + Annotations map[string]string `json:"annotations,omitempty"` |
| 90 | +} |
| 91 | + |
| 92 | +// DeprecatedRabbitMQServiceSpec mirrors the old top-level service configuration. |
| 93 | +// DEPRECATED: Use Override.Service instead. |
| 94 | +type DeprecatedRabbitMQServiceSpec struct { |
| 95 | + // +kubebuilder:default:="ClusterIP" |
| 96 | + // +kubebuilder:validation:Enum=ClusterIP;LoadBalancer;NodePort |
| 97 | + // Type of Service to create for the cluster. Must be one of: ClusterIP, LoadBalancer, NodePort. |
| 98 | + // For more info see https://pkg.go.dev/k8s.io/api/core/v1#ServiceType |
| 99 | + // +optional |
| 100 | + Type corev1.ServiceType `json:"type,omitempty"` |
| 101 | + // Annotations to add to the Service. |
| 102 | + // +optional |
| 103 | + Annotations map[string]string `json:"annotations,omitempty"` |
| 104 | + // +optional |
| 105 | + Labels map[string]string `json:"labels,omitempty"` |
| 106 | + // +kubebuilder:validation:Enum=SingleStack;PreferDualStack;RequireDualStack |
| 107 | + // IPFamilyPolicy represents the dual-stack-ness requested or required by a Service |
| 108 | + // See also: https://pkg.go.dev/k8s.io/api/core/v1#IPFamilyPolicy |
| 109 | + // +optional |
| 110 | + IPFamilyPolicy *corev1.IPFamilyPolicy `json:"ipFamilyPolicy,omitempty"` |
| 111 | +} |
| 112 | + |
| 113 | +// DeprecatedPersistenceSpec mirrors the old rabbitmq-cluster-operator RabbitmqClusterPersistenceSpec type. |
| 114 | +type DeprecatedPersistenceSpec struct { |
| 115 | + // The name of the StorageClass to claim a PersistentVolume from. |
| 116 | + StorageClassName *string `json:"storageClassName,omitempty"` |
| 117 | + // The requested size of the persistent volume attached to each Pod in the RabbitmqCluster. |
| 118 | + // The format of this field matches that defined by kubernetes/apimachinery. |
| 119 | + // See https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity for more info on the format of this field. |
| 120 | + // +kubebuilder:default:="10Gi" |
| 121 | + Storage *resource.Quantity `json:"storage,omitempty"` |
| 122 | +} |
| 123 | + |
| 124 | +// DeprecatedRabbitmqConfigSpec mirrors the old rabbitmq-cluster-operator RabbitmqClusterConfigurationSpec type. |
| 125 | +type DeprecatedRabbitmqConfigSpec struct { |
| 126 | + // List of plugins to enable in addition to essential plugins: rabbitmq_management, |
| 127 | + // rabbitmq_prometheus, and rabbitmq_peer_discovery_k8s. |
| 128 | + // +optional |
| 129 | + // +kubebuilder:validation:MaxItems=100 |
| 130 | + AdditionalPlugins []RabbitMQPlugin `json:"additionalPlugins,omitempty"` |
| 131 | + // Modify to add to the rabbitmq.conf file in addition to default configurations set by the operator. |
| 132 | + // Modifying this property on an existing RabbitmqCluster will trigger a StatefulSet rolling restart |
| 133 | + // and will cause rabbitmq downtime. |
| 134 | + // For more information on this config, see https://www.rabbitmq.com/configure.html#config-file |
| 135 | + // +optional |
| 136 | + // +kubebuilder:validation:MaxLength=100000 |
| 137 | + AdditionalConfig string `json:"additionalConfig,omitempty"` |
| 138 | + // Specify any rabbitmq advanced.config configurations to apply to the cluster. |
| 139 | + // For more information on advanced config, see https://www.rabbitmq.com/configure.html#advanced-config-file |
| 140 | + // +optional |
| 141 | + // +kubebuilder:validation:MaxLength=100000 |
| 142 | + AdvancedConfig string `json:"advancedConfig,omitempty"` |
| 143 | + // Modify to add to the rabbitmq-env.conf file. Modifying this property on an existing |
| 144 | + // RabbitmqCluster will trigger a StatefulSet rolling restart and will cause rabbitmq downtime. |
| 145 | + // For more information on env config, see https://www.rabbitmq.com/man/rabbitmq-env.conf.5.html |
| 146 | + // +optional |
| 147 | + // +kubebuilder:validation:MaxLength=100000 |
| 148 | + EnvConfig string `json:"envConfig,omitempty"` |
| 149 | + // Erlang Inet configuration to apply to the Erlang VM running rabbit. |
| 150 | + // See also: https://www.erlang.org/doc/apps/erts/inet_cfg.html |
| 151 | + // +optional |
| 152 | + // +kubebuilder:validation:MaxLength=2000 |
| 153 | + ErlangInetConfig string `json:"erlangInetConfig,omitempty"` |
| 154 | +} |
| 155 | + |
| 156 | +// DeprecatedSecretBackendSpec mirrors the old rabbitmq-cluster-operator SecretBackend type. |
| 157 | +type DeprecatedSecretBackendSpec struct { |
| 158 | + // +optional |
| 159 | + ExternalSecret *corev1.LocalObjectReference `json:"externalSecret,omitempty"` |
| 160 | + // +optional |
| 161 | + Vault *DeprecatedVaultSpec `json:"vault,omitempty"` |
| 162 | +} |
| 163 | + |
| 164 | +// DeprecatedVaultSpec mirrors the old rabbitmq-cluster-operator VaultSpec type. |
| 165 | +// VaultSpec will add Vault annotations (see https://www.vaultproject.io/docs/platform/k8s/injector/annotations) |
| 166 | +// to RabbitMQ Pods. It requires a Vault Agent Sidecar Injector |
| 167 | +// (https://www.vaultproject.io/docs/platform/k8s/injector) to be installed in the K8s cluster. |
| 168 | +type DeprecatedVaultSpec struct { |
| 169 | + // Role in Vault. |
| 170 | + // If vault.defaultUserPath is set, this role must have capability to read the pre-created default user |
| 171 | + // credential in Vault. |
| 172 | + // If vault.tls is set, this role must have capability to create and update certificates in the Vault PKI |
| 173 | + // engine for the domains "<namespace>" and "<namespace>.svc". |
| 174 | + // +optional |
| 175 | + Role string `json:"role,omitempty"` |
| 176 | + // Vault annotations that override the Vault annotations set by the cluster-operator. |
| 177 | + // For a list of valid Vault annotations, see |
| 178 | + // https://www.vaultproject.io/docs/platform/k8s/injector/annotations |
| 179 | + // +optional |
| 180 | + Annotations map[string]string `json:"annotations,omitempty"` |
| 181 | + // Path in Vault to access a KV (Key-Value) secret with the fields username and password |
| 182 | + // for the default user. For example "secret/data/rabbitmq/config". |
| 183 | + // +optional |
| 184 | + DefaultUserPath string `json:"defaultUserPath,omitempty"` |
| 185 | + // Sidecar container that updates the default user's password in RabbitMQ when it changes in Vault. |
| 186 | + // Additionally, it updates /var/lib/rabbitmq/.rabbitmqadmin.conf (used by rabbitmqadmin CLI). |
| 187 | + // Set to empty string to disable the sidecar container. |
| 188 | + // +optional |
| 189 | + DefaultUserUpdaterImage string `json:"defaultUserUpdaterImage,omitempty"` |
| 190 | + // +optional |
| 191 | + TLS *DeprecatedVaultTLSSpec `json:"tls,omitempty"` |
| 192 | +} |
| 193 | + |
| 194 | +// DeprecatedVaultTLSSpec mirrors the old rabbitmq-cluster-operator VaultSpec TLS fields. |
| 195 | +type DeprecatedVaultTLSSpec struct { |
| 196 | + // Path in Vault PKI engine. For example "pki/issue/hashicorp-com". Required. |
| 197 | + // +optional |
| 198 | + PkiIssuerPath string `json:"pkiIssuerPath,omitempty"` |
| 199 | + // Specifies an optional path to retrieve the root CA from vault. |
| 200 | + // Useful if certificates are issued by an intermediate CA. |
| 201 | + // +optional |
| 202 | + PkiRootPath string `json:"pkiRootPath,omitempty"` |
| 203 | + // Specifies the requested Subject Alternative Names (SANs), in a comma-delimited list. |
| 204 | + // These will be appended to the SANs added by the cluster-operator. |
| 205 | + // +optional |
| 206 | + AltNames string `json:"altNames,omitempty"` |
| 207 | + // Specifies the requested certificate Common Name (CN). |
| 208 | + // Defaults to <serviceName>.<namespace>.svc if not provided. |
| 209 | + // +optional |
| 210 | + CommonName string `json:"commonName,omitempty"` |
| 211 | + // Specifies the requested IP Subject Alternative Names, in a comma-delimited list. |
| 212 | + // +optional |
| 213 | + IpSans string `json:"ipSans,omitempty"` |
| 214 | +} |
![openshift-merge-bot[bot]](https://avatars.githubusercontent.com/in/412865?v=4&size=40){kind=avatar}
0 commit comments