From ddaccd868cbfa6656a62754c4f5fc88fe0682f43 Mon Sep 17 00:00:00 2001 From: Houston Putman Date: Wed, 9 Mar 2022 12:35:59 -0500 Subject: [PATCH 1/2] Fix documentation and example for additionalDomains --- docs/solr-cloud/solr-cloud-crd.md | 2 +- example/test_solrcloud_addressability.yaml | 2 +- helm/solr/README.md | 2 +- helm/solr/values.yaml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/solr-cloud/solr-cloud-crd.md b/docs/solr-cloud/solr-cloud-crd.md index 2e28f36b..3c8892d9 100644 --- a/docs/solr-cloud/solr-cloud-crd.md +++ b/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) diff --git a/example/test_solrcloud_addressability.yaml b/example/test_solrcloud_addressability.yaml index 51193b6e..24251fd9 100644 --- a/example/test_solrcloud_addressability.yaml +++ b/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 diff --git a/helm/solr/README.md b/helm/solr/README.md index 7b0256ff..74a30bde 100644 --- a/helm/solr/README.md +++ b/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. | diff --git a/helm/solr/values.yaml b/helm/solr/values.yaml index 464f47ac..4664fa20 100644 --- a/helm/solr/values.yaml +++ b/helm/solr/values.yaml @@ -80,7 +80,7 @@ addressability: external: {} # method: "Ingress" # domainName: "example.com" - # additionalDomainNames: [] + # additionalDomains: [] # useExternalAddress: false # hideNodes: false # hideCommon: false From 4c1cbf78ee8cdda228e8020b6c1a2c7b826f2f8b Mon Sep 17 00:00:00 2001 From: Houston Putman Date: Wed, 9 Mar 2022 13:13:11 -0500 Subject: [PATCH 2/2] Add changelog entry --- helm/solr/Chart.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/helm/solr/Chart.yaml b/helm/solr/Chart.yaml index c26a1a0b..afea21e5 100644 --- a/helm/solr/Chart.yaml +++ b/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