diff options
author | Joe Heck <heckj@mac.com> | 2012-03-14 19:03:59 -0700 |
---|---|---|
committer | Joe Heck <heckj@mac.com> | 2012-03-14 19:17:54 -0700 |
commit | 00a239278553fd357e56da35b559ec329dc9796a (patch) | |
tree | e526c051d10070a556dfea83adacfe1a32dfc2ef /doc | |
parent | 9a2010bfe81a386610a294d0b29c31e12db79773 (diff) | |
download | keystone-00a239278553fd357e56da35b559ec329dc9796a.tar.gz keystone-00a239278553fd357e56da35b559ec329dc9796a.tar.xz keystone-00a239278553fd357e56da35b559ec329dc9796a.zip |
Installing keystone docs
fixes bug 954217
Change-Id: Iba79d2d5bae836037d5b0e10169d9bbdba8603dc
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/index.rst | 5 | ||||
-rw-r--r-- | doc/source/installing.rst | 115 |
2 files changed, 118 insertions, 2 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 24e3d1ae..5b0d2ee7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,8 +29,8 @@ that you are already familiar with Keystone from an `end-user perspective`_. .. _`end-user perspective`: http://docs.openstack.org/ This documentation is generated by the Sphinx toolkit and lives in the source -tree. Additional documentation on Keystone and other components of OpenStack can -be found on the `OpenStack wiki`_. Also see the :doc:`community` page for +tree. Additional documentation on Keystone and other components of OpenStack +can be found on the `OpenStack wiki`_. Also see the :doc:`community` page for other ways to interact with the community. .. _`OpenStack wiki`: http://wiki.openstack.org @@ -42,6 +42,7 @@ Getting Started :maxdepth: 1 setup + installing configuration configuringservices community diff --git a/doc/source/installing.rst b/doc/source/installing.rst new file mode 100644 index 00000000..fe66205a --- /dev/null +++ b/doc/source/installing.rst @@ -0,0 +1,115 @@ +.. + Copyright 2012 OpenStack, LLC + Copyright 2012 Nebula, Inc + All Rights Reserved. + + 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. + +=================== +Installing Keystone +=================== + +This document describes how to install Keystone in order to use it. If you are +intending to develop on or with Keystone, please read :doc:`developing` and +:doc:`setup` + +Installing from Source +---------------------- + +The source install instructions specifically avoid using platform specific +packages, instead using the source for the code and the Python Package Index +(PyPi_). + +.. _PyPi: http://pypi.python.org/pypi + +Its expected that your system already has python_, pip_, and git_ available. + +.. _python: http://www.python.org +.. _pip: http://www.pip-installer.org/en/latest/installing.html +.. _git: http://git-scm.com/ + +Clone the keystone repository:: + + git clone http://github.com/openstack/keystone.git + cd keystone + +Install the dependencies to run keystone:: + + sudo pip install -r tools/pip-requires + +And at this point, you should have all the pieces you need to run keystone +installed on your system. The following commands should be available on the +commandline path: + +* ``keystone`` the keystone client, used to configure keystone +* ``keystone-manage`` used to bootstrap keystone data +* ``keystone-all`` used to run the keystone services + +You will find sample configuration files in ``etc/`` + +* keystone.conf +* logging.conf +* policy.json +* default_catalog.templates + +From here, refer to :doc:`configuration` to choose which backend drivers to +enable and use. Once configured, you should be able to run keystone by issueing +the command:: + + keystone-all + +which (by default) will show logging on the console from which it was started. +Once started, you can initialize data in keystone for use with the rest of +openstack, as described in :doc:`configuringservices`. + +An excellent reference implementation of setting up keystone is DEVSTACK_, +most commonly used for development and testing setup of not only Keystone, +but all of the core OpenStack projects. + +.. _DEVSTACK: http://devstack.org/ + +The script with the latest examples of intializing data in Keystone is a +bash script called keystone_data.sh_ + +.. _keystone_data.sh: https://github.com/openstack-dev/devstack/blob/master/files/keystone_data.sh + +Installing from packages: Ubuntu +-------------------------------- + +Ubuntu is providing packages for Keystone for Precise. To install keystone +on Ubuntu:: + + sudo apt-get install keystone + +In using Ubuntu's packages, the packages will set up a user account for +the Keystone service (`keystone`), and place default configurations in +``/etc/keystone``. The debian installer will also ask you about configuration +options for setting up and running Keystone. As of this writing, the defaults +for Keystone backends are all SQL based, stored locally in a sqlite. + +Once installed, you still need to initialize data in Keystone, which you can +find described in :doc:`configuringservices`. + +Installing from packages: Fedora +-------------------------------- + +Installing Keystone with Fedora 17 is documented at +http://fedoraproject.org/wiki/Getting_started_with_OpenStack_on_Fedora_17. + +To install the packages:: + + sudo yum install --enablerepo=updates-testing openstack-keystone + +Once installed, you can configure keystone based on the instructions at: + +http://fedoraproject.org/wiki/Getting_started_with_OpenStack_on_Fedora_17#Configuring_Keystone_for_authentication |