From 20c0192036401058e158f8d92adf86bfcbc23a59 Mon Sep 17 00:00:00 2001 From: Tin Lam Date: Sun, 27 Aug 2017 01:46:44 -0500 Subject: [PATCH] Remove local/* reference from documentation This patch set removes the "local/CHART" references in the documentation and replaces it with a reference to a local path. This was already updated in gate script. Change-Id: I1753cb500cbe448a43ede85168d71596de4e08b8 Closes-Bug: #1711733 --- doc/source/install/developer/all-in-one.rst | 40 ++++++++++++--------- doc/source/install/multinode.rst | 38 ++++++++++---------- 2 files changed, 42 insertions(+), 36 deletions(-) diff --git a/doc/source/install/developer/all-in-one.rst b/doc/source/install/developer/all-in-one.rst index b6bb88bc42..acb6424d3a 100644 --- a/doc/source/install/developer/all-in-one.rst +++ b/doc/source/install/developer/all-in-one.rst @@ -173,17 +173,23 @@ configuration steps are necessary. Helm Install Examples --------------------- +To install a helm chart, use the general command: + +.. code-block:: shell + + helm install --name=${NAME} ${PATH_TO_CHART}/${NAME} --namespace=${NAMESPACE} + The below snippet will install the given chart name from the local repository using the default values. These services must be installed first, as the OpenStack services depend upon them. -:: +.. code-block:: shell - helm install --name=mariadb local/mariadb --namespace=openstack - helm install --name=memcached local/memcached --namespace=openstack - helm install --name=etcd-rabbitmq local/etcd --namespace=openstack - helm install --name=rabbitmq local/rabbitmq --namespace=openstack - helm install --name=ingress local/ingress --namespace=openstack + helm install --name=mariadb ./mariadb --namespace=openstack + helm install --name=memcached ./memcached --namespace=openstack + helm install --name=etcd-rabbitmq ./etcd --namespace=openstack + helm install --name=rabbitmq ./rabbitmq --namespace=openstack + helm install --name=ingress ./ingress --namespace=openstack Once the OpenStack infrastructure components are installed and running, the OpenStack services can be installed. In the below examples the default values @@ -191,18 +197,18 @@ that would be used in a production-like environment have been overridden with more sensible values for the All-in-One environment using the ``--values`` and ``--set`` options. -:: +.. code-block:: shell - helm install --name=keystone local/keystone --namespace=openstack - helm install --name=glance local/glance --namespace=openstack \ - --values=./tools/overrides/mvp/glance.yaml - helm install --name=nova local/nova --namespace=openstack \ - --values=./tools/overrides/mvp/nova.yaml \ - --set=conf.nova.libvirt.nova.conf.virt_type=qemu - helm install --name=neutron local/neutron \ - --namespace=openstack --values=./tools/overrides/mvp/neutron.yaml - helm install --name=horizon local/horizon --namespace=openstack \ - --set=network.enable_node_port=true + helm install --name=keystone ./keystone --namespace=openstack + helm install --name=glance ./glance --namespace=openstack \ + --values=./tools/overrides/mvp/glance.yaml + helm install --name=nova ./nova --namespace=openstack \ + --values=./tools/overrides/mvp/nova.yaml \ + --set=conf.nova.libvirt.nova.conf.virt_type=qemu + helm install --name=neutron ./neutron \ + --namespace=openstack --values=./tools/overrides/mvp/neutron.yaml + helm install --name=horizon ./horizon --namespace=openstack \ + --set=network.enable_node_port=true Once the install commands have been issued, executing the following will provide insight into the services' deployment status. diff --git a/doc/source/install/multinode.rst b/doc/source/install/multinode.rst index 82d7113c2c..767d7d1efa 100644 --- a/doc/source/install/multinode.rst +++ b/doc/source/install/multinode.rst @@ -326,15 +326,15 @@ Ceph Installation and Verification Install the first service, which is Ceph. If all instructions have been followed as mentioned above, this installation should go smoothly. Use -the following command to install Ceph: +the following command to install Ceph in the ``openstack-helm`` project folder: :: - helm install --namespace=ceph local/ceph --name=ceph \ - --set manifests_enabled.client_secrets=false \ - --set network.public=$osd_public_network \ - --set network.cluster=$osd_cluster_network \ - --set bootstrap.enabled=true + helm install --namespace=ceph ./ceph --name=ceph \ + --set manifests_enabled.client_secrets=false \ + --set network.public=$osd_public_network \ + --set network.cluster=$osd_cluster_network \ + --set bootstrap.enabled=true You may want to validate that Ceph is deployed successfully. For more information on this, please see the section entitled `Ceph @@ -351,7 +351,7 @@ deploy the client keyring and ``ceph.conf`` to the ``openstack`` namespace: :: - helm install --namespace=openstack local/ceph --name=ceph-openstack-config \ + helm install --namespace=openstack ./ceph --name=ceph-openstack-config \ --set manifests_enabled.storage_secrets=false \ --set manifests_enabled.deployment=false \ --set ceph.namespace=ceph \ @@ -365,7 +365,7 @@ To install MariaDB, issue the following command: :: - helm install --name=mariadb local/mariadb --namespace=openstack + helm install --name=mariadb ./mariadb --namespace=openstack Installation of Other Services ------------------------------ @@ -376,30 +376,30 @@ Now you can easily install the other services simply by going in order: :: - helm install --name=memcached local/memcached --namespace=openstack - helm install --name=etcd-rabbitmq local/etcd --namespace=openstack - helm install --name=rabbitmq local/rabbitmq --namespace=openstack - helm install --name=ingress local/ingress --namespace=openstack + helm install --name=memcached ./memcached --namespace=openstack + helm install --name=etcd-rabbitmq ./etcd --namespace=openstack + helm install --name=rabbitmq ./rabbitmq --namespace=openstack + helm install --name=ingress ./ingress --namespace=openstack **Install Keystone:** :: - helm install --namespace=openstack --name=keystone local/keystone \ + helm install --namespace=openstack --name=keystone ./keystone \ --set pod.replicas.api=2 **Install Horizon:** :: - helm install --namespace=openstack --name=horizon local/horizon \ + helm install --namespace=openstack --name=horizon ./horizon \ --set network.enable_node_port=true **Install Glance:** :: - helm install --namespace=openstack --name=glance local/glance \ + helm install --namespace=openstack --name=glance ./glance \ --set pod.replicas.api=2 \ --set pod.replicas.registry=2 @@ -407,20 +407,20 @@ Now you can easily install the other services simply by going in order: :: - helm install --namespace=openstack --name=heat local/heat + helm install --namespace=openstack --name=heat ./heat **Install Neutron:** :: - helm install --namespace=openstack --name=neutron local/neutron \ + helm install --namespace=openstack --name=neutron ./neutron \ --set pod.replicas.server=2 **Install Nova:** :: - helm install --namespace=openstack --name=nova local/nova \ + helm install --namespace=openstack --name=nova ./nova \ --set pod.replicas.api_metadata=2 \ --set pod.replicas.osapi=2 \ --set pod.replicas.conductor=2 \ @@ -432,7 +432,7 @@ Now you can easily install the other services simply by going in order: :: - helm install --namespace=openstack --name=cinder local/cinder \ + helm install --namespace=openstack --name=cinder ./cinder \ --set pod.replicas.api=2 Final Checks