[ARVADOS] updated: 1.1.4-492-g43d3cb886
Git user
git at public.curoverse.com
Mon Jun 25 14:57:12 EDT 2018
Summary of changes:
.../arvados-on-kubernetes-GKE.html.textile.liquid | 62 +++++++++++++++
...ados-on-kubernetes-minikube.html.textile.liquid | 34 ++++++++
.../arvados-on-kubernetes.html.textile.liquid | 91 ++--------------------
doc/install/index.html.textile.liquid | 16 ++--
4 files changed, 111 insertions(+), 92 deletions(-)
create mode 100644 doc/install/arvados-on-kubernetes-GKE.html.textile.liquid
create mode 100644 doc/install/arvados-on-kubernetes-minikube.html.textile.liquid
via 43d3cb886e29f48ca6bb5f701172e7606709631f (commit)
from 478e18103e2b50d409160373d3cdfeed45b1c360 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 43d3cb886e29f48ca6bb5f701172e7606709631f
Author: Ward Vandewege <wvandewege at veritasgenetics.com>
Date: Mon Jun 25 14:56:44 2018 -0400
A series of documentation improvements based on review feedback.
refs #13650
Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <wvandewege at veritasgenetics.com>
diff --git a/doc/install/arvados-on-kubernetes-GKE.html.textile.liquid b/doc/install/arvados-on-kubernetes-GKE.html.textile.liquid
new file mode 100644
index 000000000..88b2d5730
--- /dev/null
+++ b/doc/install/arvados-on-kubernetes-GKE.html.textile.liquid
@@ -0,0 +1,62 @@
+---
+layout: default
+navsection: installguide
+title: Arvados on Kubernetes - Google Kubernetes Engine
+...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+This page documents the setup of the prerequisites to run the "Arvados on Kubernetes":/install/arvados-on-kubernetes.html @Helm@ chart on @Google Kubernetes Engine@ (GKE).
+
+h3. Install tooling
+
+Install @gcloud@:
+
+* Follow the instructions at "https://cloud.google.com/sdk/downloads":https://cloud.google.com/sdk/downloads
+
+Install @kubectl@:
+
+<pre>
+$ gcloud components install kubectl
+</pre>
+
+Install @helm@:
+
+* Follow the instructions at "https://docs.helm.sh/using_helm/#installing-helm":https://docs.helm.sh/using_helm/#installing-helm
+
+h3. Boot the GKE cluster
+
+This can be done via the "cloud console":https://console.cloud.google.com/kubernetes/ or via the command line:
+
+<pre>
+$ gcloud container clusters create <CLUSTERNAME> --zone us-central1-a --machine-type n1-standard-2 --cluster-version 1.10
+</pre>
+
+It takes a few minutes for the cluster to be initialized.
+
+h3. Reserve a static IP
+
+Reserve a "static IP":https://console.cloud.google.com/networking/addresses in GCE. Make sure the IP is in the same region as your GKE cluster, and is of the "Regional" type.
+
+h3. Connect to the GKE cluster.
+
+Via the web:
+* Click the "Connect" button next to your "GKE cluster"https://console.cloud.google.com/kubernetes/.
+* Execute the "Command-line access" command on your development machine.
+
+Alternatively, use this command:
+
+<pre>
+$ gcloud container clusters get-credentials <CLUSTERNAME> --zone us-central1-a --project <YOUR-PROJECT>
+</pre>
+
+Test the connection:
+
+<pre>
+$ kubectl get nodes
+</pre>
+
+Now proceed to the "Initialize helm on the Kubernetes cluster":/install/arvados-on-kubernetes.html#helm section.
diff --git a/doc/install/arvados-on-kubernetes-minikube.html.textile.liquid b/doc/install/arvados-on-kubernetes-minikube.html.textile.liquid
new file mode 100644
index 000000000..132b443df
--- /dev/null
+++ b/doc/install/arvados-on-kubernetes-minikube.html.textile.liquid
@@ -0,0 +1,34 @@
+---
+layout: default
+navsection: installguide
+title: Arvados on Kubernetes - Minikube
+...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+This page documents the setup of the prerequisites to run the "Arvados on Kubernetes":/install/arvados-on-kubernetes.html @Helm@ chart on @Minikube at .
+
+h3. Install tooling
+
+Install @kubectl@:
+
+* Follow the instructions at "https://kubernetes.io/docs/tasks/tools/install-kubectl/":https://kubernetes.io/docs/tasks/tools/install-kubectl/
+
+Install @helm@:
+
+* Follow the instructions at "https://docs.helm.sh/using_helm/#installing-helm":https://docs.helm.sh/using_helm/#installing-helm
+
+h3. Install Minikube
+
+Follow the instructions at "https://kubernetes.io/docs/setup/minikube/":https://kubernetes.io/docs/setup/minikube/
+
+Test the connection:
+
+<pre>
+$ kubectl get nodes
+</pre>
+
+Now proceed to the "Initialize helm on the Kubernetes cluster":/install/arvados-on-kubernetes.html#helm section.
diff --git a/doc/install/arvados-on-kubernetes.html.textile.liquid b/doc/install/arvados-on-kubernetes.html.textile.liquid
index 581e14097..716b2b935 100644
--- a/doc/install/arvados-on-kubernetes.html.textile.liquid
+++ b/doc/install/arvados-on-kubernetes.html.textile.liquid
@@ -18,11 +18,11 @@ This Helm chart does not retain any state after it is deleted. An Arvados cluste
h2. Requirements
* Kubernetes 1.10+ cluster with at least 3 nodes, 2 or more cores per node
-* `kubectl` and `helm` installed locally, and able to connect to your Kubernetes cluster
+* @kubectl@ and @helm@ installed locally, and able to connect to your Kubernetes cluster
-If that does not describe your environment, please see the "GKE":#GKE or "Minikube":#Minikube sections below to get set up with Kubernetes.
+If you do not have a Kubernetes cluster already set up, you can use "Google Kubernetes Engine":/install/arvados-on-kubernetes-GKE.html for multi-node development and testing, "Minikube":/install/arvados-on-kubernetes-minikube.html for single node development and testing or "another Kubernetes solution":https://kubernetes.io/docs/setup/pick-right-solution/.
-h2(#helm). Install helm on the Kubernetes cluster
+h2(#helm). Initialize helm on the Kubernetes cluster
If you already have helm running on the Kubernetes cluster, proceed directly to "Start the Arvados cluster":#Start below.
@@ -33,7 +33,7 @@ $ kubectl create clusterrolebinding tiller-cluster-rule --clusterrole=cluster-ad
$ kubectl patch deploy --namespace kube-system tiller-deploy -p '{"spec":{"template":{"spec":{"serviceAccount":"tiller"}}}}'
</pre>
-Test `helm` by running
+Test @helm@ by running
<pre>
$ helm ls
@@ -51,8 +51,7 @@ $ cd arvados-kubernetes/charts/arvados
$ ./cert-gen.sh <IP ADDRESS>
</pre>
-The `values.yaml` file contains a number of variables that can be modified.
-Specifically, you probably want to modify the values for
+The @values.yaml@ file contains a number of variables that can be modified. At a minimum, review and/or modify the values for
<pre>
adminUserEmail
@@ -78,7 +77,7 @@ After a few minutes, you can access Arvados Workbench at the IP address specifie
* https://<IP ADDRESS>
-with the username and password specified in the `values.yaml` file.
+with the username and password specified in the @values.yaml@ file.
Alternatively, use the Arvados cli tools or SDKs:
@@ -98,7 +97,7 @@ $ arv user current
h2. Reload
-If you make changes to the Helm chart (e.g. to `values.yaml`), you can reload Arvados with
+If you make changes to the Helm chart (e.g. to @values.yaml@), you can reload Arvados with
<pre>
$ helm upgrade arvados .
@@ -113,79 +112,3 @@ This Helm chart does not retain any state after it is deleted. An Arvados cluste
<pre>
$ helm del arvados --purge
</pre>
-
-h2(#GKE). GKE
-
-h3. Install tooling
-
-Install `gcloud`:
-
-* Follow the instructions at "https://cloud.google.com/sdk/downloads":https://cloud.google.com/sdk/downloads
-
-Install `kubectl`:
-
-<pre>
-$ gcloud components install kubectl
-</pre>
-
-Install `helm`:
-
-* Follow the instructions at "https://docs.helm.sh/using_helm/#installing-helm":https://docs.helm.sh/using_helm/#installing-helm
-
-h3. Boot the GKE cluster
-
-This can be done via the "cloud console":https://console.cloud.google.com/kubernetes/ or via the command line:
-
-<pre>
-$ gcloud container clusters create <CLUSTERNAME> --zone us-central1-a --machine-type n1-standard-2 --cluster-version 1.10.2-gke.3
-</pre>
-
-It takes a few minutes for the cluster to be initialized.
-
-h3. Reserve a static IP
-
-Reserve a "static IP":https://console.cloud.google.com/networking/addresses in GCE. Make sure the IP is in the same region as your GKE cluster, and is of the "Regional" type.
-
-h3. Connect to the GKE cluster.
-
-Via the web:
-* Click the "Connect" button next to your "GKE cluster"https://console.cloud.google.com/kubernetes/.
-* Execute the "Command-line access" command on your development machine.
-
-Alternatively, use this command:
-
-<pre>
-$ gcloud container clusters get-credentials <CLUSTERNAME> --zone us-central1-a --project <YOUR-PROJECT>
-</pre>
-
-Test the connection:
-
-<pre>
-$ kubectl get nodes
-</pre>
-
-Now proceed to the "Install helm on the Kubernetes cluster":#helm section.
-
-h2(#Minikube). Minikube
-
-h3. Install tooling
-
-Install `kubectl`:
-
-* Follow the instructions at "https://kubernetes.io/docs/tasks/tools/install-kubectl/":https://kubernetes.io/docs/tasks/tools/install-kubectl/
-
-Install `helm`:
-
-* Follow the instructions at "https://docs.helm.sh/using_helm/#installing-helm":https://docs.helm.sh/using_helm/#installing-helm
-
-h3. Install Minikube
-
-Follow the instructions at "https://kubernetes.io/docs/setup/minikube/":https://kubernetes.io/docs/setup/minikube/
-
-Test the connection:
-
-<pre>
-$ kubectl get nodes
-</pre>
-
-Now proceed to the "Install helm on the Kubernetes cluster":#helm section.
diff --git a/doc/install/index.html.textile.liquid b/doc/install/index.html.textile.liquid
index f0b4901ab..4956b1182 100644
--- a/doc/install/index.html.textile.liquid
+++ b/doc/install/index.html.textile.liquid
@@ -16,14 +16,14 @@ Arvados components can be installed and configured in a number of different ways
<div class="offset1">
table(table table-bordered table-condensed).
||||\6=. _Appropriate for_|
-||_Ease of installation_|_Multiuser/Networked_|_Demo_|_Workflow Development_|_Workflow QA/QC_|_Large Scale Production_|_Arvados Software Development_|_Arvados Software Development Testing_|
-|"Arvados-in-a-box":arvbox.html (arvbox)|Easy|no|yes|no|no|no|yes|yes|
-|"Arvados on Kubernetes":arvados-on-kubernetes.html|Easy ^1^|yes|yes|no ^2^|no ^2^|no ^2^|no|yes|
-|"Manual installation":install-manual-prerequisites.html|Complex|yes|yes|yes|yes|yes|no|no|
-|"Cloud demo":https://cloud.curoverse.com by Curoverse|N/A ^3^|yes|yes|no|no|no|no|no|
-|"Cluster Operation Subscription":https://curoverse.com/products by Curoverse|N/A ^3^|yes|yes|yes|yes|yes|no|no|
+||_Ease of installation_|_Multiuser/Networked_|_Workflow Development_|_Workflow Testing_|_Large Scale Production_|_Developing Arvados_|_Arvados Software Development Testing_|
+|"Arvados-in-a-box":arvbox.html (arvbox)|Easy|no|no|no|no|yes|yes|
+|"Arvados on Kubernetes":arvados-on-kubernetes.html|Easy ^1^|yes|no ^2^|no ^2^|no ^2^|no|yes|
+|"Manual installation":install-manual-prerequisites.html|Complex|yes|yes|yes|yes|no|no|
+|"Cloud demo":https://cloud.curoverse.com by Veritas Genetics|N/A ^3^|yes|no|no|no|no|no|
+|"Cluster Operation Subscription":https://curoverse.com/products by Veritas Genetics|N/A ^3^|yes|yes|yes|yes|yes|yes|
</div>
* ^1^ Assumes a Kubernetes cluster is available
-* ^2^ While Arvados on Kubernetes is not yet ready for production use, it is being developed toward that goal
-* ^3^ No installation necessary, Curoverse run and managed
+* ^2^ Arvados on Kubernetes is under dvelopment and not yet ready for production use
+* ^3^ No installation necessary, Veritas Genetics run and managed
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list