Fix documentation and example for additionalDomains

docs/solr-cloud/solr-cloud-crd.md

@@ -118,7 +118,7 @@ Under `SolrCloud.Spec.solrAddressability`:
   Currently available options are [`Ingress`](https://kubernetes.io/docs/concepts/services-networking/ingress/) and [`ExternalDNS`](https://github.com/kubernetes-sigs/external-dns).
   The goal is to support more methods in the future, such as LoadBalanced Services.
   - **`domainName`** - (Required) The primary domain name to open your cloud endpoints on. If `useExternalAddress` is set to `true`, then this is the domain that will be used in Solr Node names.
-  - **`additionalDomainNames`** - You can choose to listen on additional domains for each endpoint, however Solr will not register itself under these names.
+  - **`additionalDomains`** - You can choose to listen on additional domains for each endpoint, however Solr will not register itself under these names.
   - **`useExternalAddress`** - Use the external address to advertise the SolrNode. If a domain name is required for the chosen external `method`, then the one provided in `domainName` will be used.
   - **`hideCommon`** - Do not externally expose the common service (one endpoint for all solr nodes).
   - **`hideNodes`** - Do not externally expose each node. (This cannot be set to `true` if the cloud is running across multiple kubernetes clusters)

example/test_solrcloud_addressability.yaml

@@ -28,7 +28,7 @@ spec:
       method: Ingress
       useExternalAddress: false
       domainName: "kube.example.com"
-      additionalDomainNames:
+      additionalDomains:
         - "another.kube.example.com"
         - "another.kube.other.com"
       nodePortOverride: 80

helm/solr/Chart.yaml

@@ -47,6 +47,13 @@ annotations:
           url: https://github.com/apache/solr-operator/issues/379
         - name: Github PR
           url: https://github.com/apache/solr-operator/pull/380
+    - kind: fixed
+      description: Fixed Helm chart value "addressability.external.additionalDomains", will be renamed to "additionalDomainNames" in v0.6.0
+      links:
+        - name: Github Issue
+          url: https://github.com/apache/solr-operator/issues/412
+        - name: Github PR
+          url: https://github.com/apache/solr-operator/pull/415
   artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/recommendations: |
     - url: https://artifacthub.io/packages/helm/apache-solr/solr-operator

helm/solr/README.md

@@ -142,7 +142,7 @@ External addressability is disabled by default.
 | addressability.kubeDomain | string | | The cluster domain the Kubernetes is addressed under. Overrides the `global.clusterDomain` option. |
 | addressability.external.method | string | | The method by which Solr should be made addressable outside of the Kubernetes cluster. Either `Ingress` or `ExternalDNS` |
 | addressability.external.domainName | string | | The base domain name that Solr nodes should be addressed under. |
-| addressability.external.additionalDomainNames | []string | | Additional base domain names that Solr nodes should be addressed under. These are not used to advertise Solr locations, just the `domainName` is. |
+| addressability.external.additionalDomains | []string | | Additional base domain names that Solr nodes should be addressed under. These are not used to advertise Solr locations, just the `domainName` is. |
 | addressability.external.useExternalAddress | boolean | `false` | Make the official hostname of the SolrCloud nodes the external address. This cannot be used when `hideNodes` is set to `true` or `ingressTLSTerminationSecret` is set to `true`. |
 | addressability.external.hideNodes | boolean | `false` | Do not make the individual Solr nodes addressable outside of the Kubernetes cluster. |
 | addressability.external.hideCommon | boolean | `false` | Do not make the load-balanced common Solr endpoint addressable outside of the Kubernetes cluster. |

helm/solr/values.yaml

@@ -80,7 +80,7 @@ addressability:
   external: {}
     # method: "Ingress"
     # domainName: "example.com"
-    # additionalDomainNames: []
+    # additionalDomains: []
     # useExternalAddress: false
     # hideNodes: false
     # hideCommon: false