From c2525f4e5c77dfddc03f26fd51715cc2ae7bd983 Mon Sep 17 00:00:00 2001 From: vikram-bitnami Date: Wed, 9 Jun 2021 18:33:38 +0530 Subject: [PATCH] [bitnami/solr] Updated Solr README (#6612) * T39960 Updated Solr README * T39960 Updated Chart.yaml Co-authored-by: Vikram Vaswani --- bitnami/solr/Chart.yaml | 2 +- bitnami/solr/README.md | 38 +++++++++----------------------------- 2 files changed, 10 insertions(+), 30 deletions(-) diff --git a/bitnami/solr/Chart.yaml b/bitnami/solr/Chart.yaml index d2b94cf14..14083d77f 100644 --- a/bitnami/solr/Chart.yaml +++ b/bitnami/solr/Chart.yaml @@ -27,4 +27,4 @@ name: solr sources: - https://github.com/bitnami/bitnami-docker-solr - https://lucene.apache.org/solr/ -version: 0.3.3 +version: 0.3.4 diff --git a/bitnami/solr/README.md b/bitnami/solr/README.md index 01a462b50..c6ebeaf60 100644 --- a/bitnami/solr/README.md +++ b/bitnami/solr/README.md @@ -289,7 +289,7 @@ $ helm install my-release -f values.yaml bitnami/solr ## Configuration and installation details -### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/) +### [Rolling vs Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/) It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image. @@ -299,7 +299,7 @@ Bitnami will release a new chart updating its containers if a new version of the To modify the Solr version used in this chart you can specify a [valid image tag](https://hub.docker.com/r/bitnami/solr/tags/) using the `image.tag` parameter. For example, `image.tag=X.Y.Z`. This approach is also applicable to other images like exporters. -### Adding extra environment variables +### Add extra environment variables In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the `extraEnvVars` property. @@ -311,37 +311,17 @@ extraEnvVars: Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the `extraEnvVarsCM` or the `extraEnvVarsSecret` values. -### Sidecars and Init Containers +### Use Sidecars and Init Containers -If you have a need for additional containers to run within the same pod as Solr (e.g. an additional metrics or logging exporter), you can do so via the `sidecars` config parameter. Simply define your container according to the Kubernetes container spec. +If additional containers are needed in the same pod (such as additional metrics or logging exporters), they can be defined using the `sidecars` config parameter. Similarly, extra init containers can be added using the `initContainers` parameter. -```yaml -sidecars: -- name: your-image-name - image: your-image - imagePullPolicy: Always - ports: - - name: portname - containerPort: 1234 -``` +Refer to the chart documentation for more information on, and examples of, configuring and using [sidecars and init containers](https://docs.bitnami.com/kubernetes/infrastructure/solr/configuration/configure-sidecar-init-containers/). -Similarly, you can add extra init containers using the `initContainers` parameter. +### Set Pod affinity -```yaml -initContainers: -- name: your-image-name - image: your-image - imagePullPolicy: Always - ports: - - name: portname - containerPort: 1234 -``` +This chart allows you to set your custom affinity using the `XXX.affinity` parameter(s). Find more information about Pod affinity in the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity). -### Setting Pod's affinity - -This chart allows you to set your custom affinity using the `affinity` parameter. Find more information about Pod's affinity in the [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity). - -As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the [bitnami/common](https://github.com/bitnami/charts/tree/master/bitnami/common#affinities) chart. To do so, set the `podAffinityPreset`, `podAntiAffinityPreset`, or `nodeAffinityPreset` parameters. +As an alternative, you can use the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the [bitnami/common](https://github.com/bitnami/charts/tree/master/bitnami/common#affinities) chart. To do so, set the `XXX.podAffinityPreset`, `XXX.podAntiAffinityPreset`, or `XXX.nodeAffinityPreset` parameters. ## Persistence @@ -349,7 +329,7 @@ The [Bitnami Solr](https://github.com/bitnami/bitnami-docker-solr) image can per The chart mounts a [Persistent Volume](http://kubernetes.io/docs/user-guide/persistent-volumes/) at this location. The volume is created using dynamic volume provisioning. -### Adding extra volumes +### Add extra volumes The Bitnami Solr chart supports mounting extra volumes (either PVCs, secrets or configmaps) by using the `extraVolumes` and `extraVolumeMounts` property. This can be combined with advanced operations like adding extra init containers and sidecars.