]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
DNM: Add newbie-friendly updates to Helm start doc 18886/head
authorBlaine Gardner <blaine.gardner@suse.com>
Sat, 11 Nov 2017 00:29:56 +0000 (17:29 -0700)
committerBlaine Gardner <blaine.gardner@suse.com>
Sat, 11 Nov 2017 00:29:56 +0000 (17:29 -0700)
doc/start/kube-helm.rst

index 829dc82716fc480097972e315c4b7856af00824a..798a55c276f2f324eb49a4f63c8a93b35fcfadb3 100644 (file)
@@ -13,14 +13,19 @@ Current limitations
    in your Ceph cluster and create its secret in Kubernetes
  - ceph-mgr can only run with 1 replica
 
-Install and start helm
+Install and start Helm
 ======================
 
 Helm can be installed by following these instructions_.
 
-Once installed, run::
+Helm finds the Kubernetes cluster by reading from the local Kubernetes config file; make sure this is downloaded and accessible to the ``helm`` client.
+
+A Tiller server must be configured and running for your Kubernetes cluster, and the local Helm client must be connected to it. It may be helpful to look at the Helm documentation for init_. To run Tiller locally and connect Helm to it, run::
 
     $ helm init
+
+The ceph-helm project uses a local Helm repo by default to store charts. To start a local Helm repo server, run::
+
     $ helm serve &
     $ helm repo add local http://localhost:8879/charts
 
@@ -35,7 +40,7 @@ Add ceph-helm to Helm local repos
 Configure your Ceph cluster
 ===========================
 
-Create a ``~/ceph-overrides.yaml`` that will contain your Ceph configuration::
+Create a ``ceph-overrides.yaml`` that will contain your Ceph configuration. This file may exist anywhere, but for this docuiment will be assumed to reside in the user's home directory.::
 
     $ cat ~/ceph-overrides.yaml
     network:
@@ -60,6 +65,13 @@ Create a ``~/ceph-overrides.yaml`` that will contain your Ceph configuration::
 .. note:: The ``ceph-helm/ceph/ceph/values.yaml`` file contains the full
           list of option that can be set
 
+Create the Ceph cluster namespace
+==================================
+
+By default, ceph-helm components assume they are to be run in the ``ceph`` Kubernetes namespace. To create the namespace, run::
+
+    $ kubectl create namespace ceph
+
 Configure RBAC permissions
 ==========================
 
@@ -342,3 +354,4 @@ For instance, to access the cluster-tail-log, one can run::
 
 .. _ceph-helm: https://github.com/ceph/ceph-helm/
 .. _instructions: https://github.com/kubernetes/helm/blob/master/docs/install.md
+.. _init: https://github.com/kubernetes/helm/blob/master/docs/helm/helm_init.md