From 39c4dd0669efd5bc2ab1b93c8925e8e25ca7fe86 Mon Sep 17 00:00:00 2001 From: tengqm Date: Tue, 25 Jul 2017 21:59:45 -0400 Subject: [PATCH] Add an installation doc A quick doc for installation Change-Id: I04702a3b665de506f9b3422ce8217537e8f6378d --- doc/source/index.rst | 1 + doc/source/install/index.rst | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 doc/source/install/index.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 39e1953f..2cd3d310 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,7 @@ Contents: .. toctree:: :maxdepth: 2 + install/index cli/index diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 00000000..23fcacea --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,36 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +.. _guide-install: + +============ +Installation +============ + +If you are installing senlinclient from an OpenStack distribution, follow the +guide provided by the vendor. + +If you prefer installing senlinclient from source repo, you can do it by +first get senlinclient code from OpenStack git repository. + +:: + + $ cd /opt/stack + $ git clone https://git.openstack.org/openstack/python-senlinclient.git + +Then execute the following command + +:: + + $ cd python-senlinclient + $ sudo python setup.py install