Skip to content

Commit

Permalink
[DOCFIX] Add K8s docs pointer to public helm repo
Browse files Browse the repository at this point in the history
Helm charts are now published in a gs bucket.

pr-link: #11187
change-id: cid-1e626462b9d8f8d9fea5c2db2381983c82bb00df
  • Loading branch information
madanadit committed Mar 18, 2020
1 parent b7c5334 commit 51da13d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 19 deletions.
2 changes: 0 additions & 2 deletions docs/_config.yml
Expand Up @@ -17,8 +17,6 @@ ALLUXIO_CLIENT_JAR_PATH: /<PATH_TO_ALLUXIO>/client/alluxio-2.3.0-SNAPSHOT-client
# e.g. Javadoc: https://docs.alluxio.io/os/javadoc/{{site.ALLUXIO_MAJOR_VERSION}}/master/index.html
# e.g. REST API doc: https://docs.alluxio.io/os/restdoc/{{site.ALLUXIO_MAJOR_VERSION}}/master/index.html
ALLUXIO_MAJOR_VERSION: edge
# The version string must match the version of the K8s helm chart
ALLUXIO_HELM_VERSION_STRING: 0.5.2

# These attach the pages of different languages with different 'lang' attributes
defaults:
Expand Down
29 changes: 12 additions & 17 deletions docs/en/deploy/Running-Alluxio-On-Kubernetes.md
Expand Up @@ -73,7 +73,7 @@ spec:
capacity:
storage: 1Gi
accessModes:
- ReadWriteMany
- ReadWriteOnce
hostPath:
path: /tmp/alluxio-journal-0
```
Expand All @@ -92,20 +92,15 @@ There are other ways to create Persistent Volumes as documented [here](https://k

#### Prerequisites

You should have helm 2.X installed. You can install helm following instructions [here](https://v2.helm.sh/docs/using_helm/#install-helm).
A. Install Helm

A helm repo with the Alluxio helm chart must be available.
You should have helm 2.X installed.
You can install helm following instructions [here](https://v2.helm.sh/docs/using_helm/#install-helm).

B. A helm repo with the Alluxio helm chart must be available.

(Optional) To prepare a local helm repository:
```console
$ helm init
$ helm package helm-chart/alluxio/
$ mkdir -p helm-chart/charts/
$ cp alluxio-{{site.ALLUXIO_HELM_VERSION_STRING}}.tgz helm-chart/charts/
$ helm repo index helm-chart/charts/
$ helm serve --repo-path helm-chart/charts
$ helm repo add alluxio-local http://127.0.0.1:8879
$ helm repo update alluxio-local
$ helm repo add alluxio-charts https://alluxio-charts.storage.googleapis.com/openSource/{{site.ALLUXIO_VERSION_STRING}}
```

#### Configuration
Expand All @@ -120,7 +115,7 @@ properties:
To view the complete list of supported properties run the `helm inspect` command:
```console
$ helm inspect values alluxio-local/alluxio
$ helm inspect values alluxio-charts/alluxio
```

The remainder of this section describes various configuration options with examples.
Expand Down Expand Up @@ -343,7 +338,7 @@ tieredstore:

Once the configuration is finalized in a file named `config.yaml`, install as follows:
```console
helm install --name alluxio -f config.yaml alluxio-local/alluxio --version {{site.ALLUXIO_HELM_VERSION_STRING}}
$ helm install --name alluxio -f config.yaml alluxio-charts/alluxio
```

#### Uninstall
Expand All @@ -362,14 +357,14 @@ By default, the journal is not formatted when the master starts.
You can trigger the journal formatting by upgrading the existing helm deployment with `journal.format.runFormat=true`.
```console
# Use the same config.yaml and switch on journal formatting
$ helm upgrade alluxio -f config.yaml --set journal.format.runFormat=true alluxio-local/alluxio
$ helm upgrade alluxio -f config.yaml --set journal.format.runFormat=true alluxio-charts/alluxio
```

> Note: `helm upgrade` will re-create the master Pods.
Or you can trigger the journal formatting at deployment.
```console
$ helm install --name alluxio -f config.yaml --set journal.format.runFormat=true alluxio-local/alluxio
$ helm install --name alluxio -f config.yaml --set journal.format.runFormat=true alluxio-charts/alluxio
```

### Deploy Using `kubectl`
Expand Down Expand Up @@ -689,7 +684,7 @@ Then follow the steps to install Alluxio with helm [here]({{ '/en/deploy/Running

If Alluxio has already been deployed with helm and now you want to enable FUSE, you use `helm upgrade` to add the FUSE daemons.
```console
$ helm upgrade alluxio -f config.yaml --set fuse.enabled=true --set fuse.clientEnabled=true alluxio-local/alluxio
$ helm upgrade alluxio -f config.yaml --set fuse.enabled=true --set fuse.clientEnabled=true alluxio-charts/alluxio
```

## Troubleshooting
Expand Down

0 comments on commit 51da13d

Please sign in to comment.