Commit cdd8b932 authored by Matt Pryor's avatar Matt Pryor
Browse files

Fix typos in docs

parent bf2eea47

docs/kubernetes/configure-indexnode.md

+6 −6
Original line number Diff line number Diff line
@@ -27,8 +27,6 @@ be a list in which the following keys are required for each item: 
  * `name`: Used in the names of Kubernetes resources for the replica

  * `masterUrl`: The URL to replicate, including scheme, port and path, e.g. `https://esgf-index1.ceda.ac.uk/solr`



Other keys a



For example, the following configures two replicas, and will result in four Solr pods:



  * `master`
@@ -57,13 +55,15 @@ outside of the Kubernetes cluster for persistence or performance reasons, the ES 
can configure the `esg-search` application to use external Solr instances.



To do this, disable Solr and set the external URLs to use. For any replicas that are specified,

`esg-search` will be configured to use the replica directly using the `masterUrl`.

`esg-search` will be configured to use the `masterUrl` directly.



> **WARNING**

>

> If you want to use a Solr instance configured using `esgf-ansible` as an external index

> for publishing, you will need to configure the firewall on that host to expose the port

> `8984` where the master runs.

> If you want to use a Solr instance configured using `esgf-ansible` as an external Solr instance,

> you will need to configure the firewall on that host to expose the port  `8984` where the

> master listens.



Example configuration using external Solr instances:



```yaml

index:

docs/kubernetes/deploy.md

+8 −13
Original line number Diff line number Diff line
@@ -3,25 +3,19 @@ 
This project provides a [Helm chart](https://helm.sh/docs/topics/charts/) to deploy ESGF resources

on a [Kubernetes](https://kubernetes.io/) cluster.



The chart is in [deploy/kubernetes/chart](../deploy/kubernetes/chart/). Please look at the files to

understand exactly what resources are being created.

The chart is in [deploy/kubernetes/chart](../../deploy/kubernetes/chart/). Please look at the

files to understand exactly what resources are being created.



For a complete list of all the variables that are available, please look at the

[values.yaml for the chart](../deploy/kubernetes/chart/values.yaml). The defaults there have extensive

comments that explain how to use these variables. This document describes how to apply some common

configurations.

[values.yaml for the chart](../../deploy/kubernetes/chart/values.yaml). The defaults there have

extensive comments that explain how to use these variables. This documentation describes how to

apply some common configurations.



<!-- TOC depthFrom:2 -->



- [Installing/upgrading ESGF](#installingupgrading-esgf)

- [Local test installation with Minikube](#local-test-installation-with-minikube)

- [Configuring the installation](#configuring-the-installation)

    - [Setting the version](#setting-the-version)

    - [Configuring the available datasets](#configuring-the-available-datasets)

    - [Using existing THREDDS catalogs](#using-existing-thredds-catalogs)

    - [Improving pod startup time for large catalogs](#improving-pod-startup-time-for-large-catalogs)

    - [Configuring container resources](#configuring-container-resources)

    - [Enabling demand-based autoscaling](#enabling-demand-based-autoscaling)



<!-- /TOC -->
@@ -74,8 +68,9 @@ minikube addons enable ingress 
minikube ssh "curl -fsSL https://github.com/roocs/mini-esgf-data/tarball/master | sudo tar -xz --strip-components=1 -C / --wildcards */test_data"

```



Configure the chart to serve the test data (see [minikube-values.yaml](../deploy/kubernetes/minikube-values.yaml)),

using a `nip.io` domain pointing to the Minikube server:

Configure the chart to serve the test data (see

[minikube-values.yaml](../../deploy/kubernetes/minikube-values.yaml)), using a `nip.io`

domain pointing to the Minikube server:



```sh

helm install esgf ./deploy/kubernetes/chart/ \