added install-guide documentation

Closes-Bug: #1606949
Change-Id: I293b65d7bf8dc78f164d0b118754f9a268fb498c
This commit is contained in:
tikitavi 2016-11-14 19:35:54 +03:00 committed by Andrey Pavlov
parent 35b5f89646
commit ea9a9d5b11
12 changed files with 558 additions and 0 deletions

View File

@ -0,0 +1,301 @@
# 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.
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
# extensions =
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Installation Guide for ec2-api Service'
bug_tag = u'install-guide'
copyright = u'2016, OpenStack contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# A few variables have to be set for the log-a-bug feature.
# giturl: The location of conf.py on Git. Must be set manually.
# gitsha: The SHA checksum of the bug description. Automatically extracted
# from git log.
# bug_tag: Tag for categorizing the bug. Must be set manually.
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/ec2-api/tree/install-guide/source' # noqa
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl,
"bug_project": "ec2-api"}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["endpoints-creation.rst"]
# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = []
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# So that we can enable "log-a-bug" links from each output HTML page, this
# variable must be set to a format that includes year, month, day, hours and
# minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_domain_indices = True
# If false, no index is generated.
html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'install-guide'
# If true, publish source files
html_copy_source = False
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'InstallGuide.tex', u'Install Guide',
u'OpenStack contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'installguide', u'Install Guide',
[u'OpenStack contributors'], 1)
]
# If true, show URL addresses after external links.
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'InstallGuide', u'Install Guide',
u'OpenStack contributors', 'InstallGuide',
'This guide shows OpenStack end users how to install '
'an OpenStack cloud.', 'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']
# -- Options for PDF output --------------------------------------------------
pdf_documents = [
('index', u'InstallGuide', u'Install Guide',
u'OpenStack contributors')
]

View File

@ -0,0 +1,34 @@
.. _credentials-creation:
Creating the service credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The service credentials are created automatically by the install.sh. To create
them manually, complete these steps:
#. Source the ``admin`` credentials to gain access to
admin-only CLI commands:
.. code-block:: console
$ . admin-openrc
#. To create the service credentials, complete these steps:
* Create the ``ec2api`` user:
.. code-block:: console
$ openstack user create --domain default --password-prompt ec2api
* Add the ``admin`` role to the ``ec2api`` user:
.. code-block:: console
$ openstack role add --project service --user ec2api admin
* Create the ec2api service entities:
.. code-block:: console
$ openstack service create --name ec2-api --description "ec2api" ec2api

View File

@ -0,0 +1,38 @@
.. _database-creation:
Creating the database
~~~~~~~~~~~~~~~~~~~~~
The database is created automatically by the install.sh.
To create the database manually, complete these steps:
* Use the database access client to connect to the database
server as the ``root`` user:
.. code-block:: console
$ mysql -u root -p
* Create the ``ec2api`` database:
.. code-block:: mysql
CREATE DATABASE ec2api;
* Grant proper access to the ``ec2api`` database:
.. code-block:: mysql
GRANT ALL PRIVILEGES ON ec2api.* TO 'ec2api'@'localhost' \
IDENTIFIED BY 'EC2-API_DBPASS';
GRANT ALL PRIVILEGES ON ec2api.* TO 'ec2api'@'%' \
IDENTIFIED BY 'EC2-API_DBPASS';
Replace ``EC2-API_DBPASS`` with a suitable password.
* Exit the database access client.
.. code-block:: mysql
exit;

View File

@ -0,0 +1,10 @@
Create the ec2api service API endpoints:
.. code-block:: console
$ openstack endpoint create --region RegionOne \
ec2api public http://controller:XXXX/vY/%\(tenant_id\)s
$ openstack endpoint create --region RegionOne \
ec2api internal http://controller:XXXX/vY/%\(tenant_id\)s
$ openstack endpoint create --region RegionOne \
ec2api admin http://controller:XXXX/vY/%\(tenant_id\)s

View File

@ -0,0 +1,15 @@
=========================
EC2-API service overview
=========================
The ec2-api service provides Amazon EC2 API support.
The ec2-api service consists of the following components:
``ec2-api`` service
Accepts and responds to end user EC2 and VPC API calls.
``ec2-api-metadata`` service
Provides the OpenStack Metadata API to servers. The metadata is used to
configure the running servers.

View File

@ -0,0 +1,14 @@
=====================
EC2-API service
=====================
.. toctree::
:maxdepth: 2
get-started.rst
install.rst
verify.rst
next-steps.rst
This chapter assumes a working setup of OpenStack following the
`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.

View File

@ -0,0 +1,64 @@
.. _install-ubuntu:
Installation on existing OpenStack deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes how to install and configure the ec2-api
service for Ubuntu (LTS).
Install and configure components
--------------------------------
Install the packages:
.. code-block:: console
# apt-get update
# git clone https://github.com/openstack/ec2-api.git
# cd ec2-api
Run install.sh
The EC2 API service gets installed on port 8788 by default. It can be changed
before the installation in install.sh script.
The services afterwards can be started as binaries:
::
/usr/bin/ec2-api
/usr/bin/ec2-api-metadata
or set up as Linux services.
.. include:: endpoints-creation.rst
Configuring OpenStack for EC2 API metadata service
--------------------------------------------------
To configure OpenStack for EC2 API metadata service:
for Nova-network add:
.. code-block:: console
# [DEFAULT]
# metadata_port = 8789
# [neutron]
# service_metadata_proxy = True
to ``/etc/nova.conf``
then restart nova-metadata (can be run as part of nova-api service) and
nova-network services.
for Neutron add:
.. code-block:: console
# [DEFAULT]
# nova_metadata_port = 8789
to ``/etc/neutron/metadata_agent.ini``
then restart neutron-metadata service.

View File

@ -0,0 +1,24 @@
.. _install:
Install and configure
~~~~~~~~~~~~~~~~~~~~~
This section describes how to install and configure the ec2-api service on the
controller node.
This section assumes that you already have a working OpenStack environment with
at least the following components installed: Compute, Networking, Block Storage,
Identity, Image.
.. toctree::
:maxdepth: 2
install-ubuntu.rst
Additional steps:
.. toctree::
:maxdepth: 2
database-creation.rst
credentials-creation.rst

View File

@ -0,0 +1,8 @@
.. _next-steps:
Next steps
~~~~~~~~~~
Your OpenStack environment now includes the ec2-api service.
To add more services, see the additional documentation on installing OpenStack.

View File

@ -0,0 +1,46 @@
.. _verify:
Verify operation
~~~~~~~~~~~~~~~~
Verify operation of the ec2-api service.
.. note::
Perform these commands on the controller node.
#. Source the ``admin`` project credentials to gain access to
admin-only CLI commands:
.. code-block:: console
$ . admin-openrc
#. List service components to verify successful launch and registration
of each process:
.. code-block:: console
$ openstack service list
#. Download aws cli from Amazon. Create configuration file for aws cli in your
home directory ``~/.aws/config``:
.. code-block:: console
[default]
aws_access_key_id = 1b013f18d5ed47ae8ed0fbb8debc036b
aws_secret_access_key = 9bbc6f270ffd4dfdbe0e896947f41df3
region = RegionOne
Change the aws_access_key_id and aws_secret_acces_key above to the values
appropriate for your cloud (can be obtained by
**"keystone ec2-credentials-list"** command).
#. Run aws cli commands using new EC2 API endpoint URL (can be obtained from
keystone with the new port 8788) like this:
.. code-block:: console
aws --endpoint-url http://10.0.2.15:8788 ec2 describe-images

View File

@ -12,3 +12,4 @@ python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
openstackdocstheme>=1.5.0 # Apache-2.0

View File

@ -53,3 +53,6 @@ max-complexity=25
[hacking]
import_exceptions = ec2api.i18n
[testenv:install-guide]
commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html