Browse Source

Fix use of variables

Change-Id: I686ad7180811cef2b1e5baea96062ec51e4fbf98
changes/56/316056/1
Spyros Trigazis 6 years ago
parent
commit
e9209c13ce
  1. 4
      {{cookiecutter.repo_name}}/install-guide/source/conf.py
  2. 8
      {{cookiecutter.repo_name}}/install-guide/source/get_started.rst
  3. 4
      {{cookiecutter.repo_name}}/install-guide/source/index.rst
  4. 24
      {{cookiecutter.repo_name}}/install-guide/source/install.rst
  5. 2
      {{cookiecutter.repo_name}}/install-guide/source/next-steps.rst
  6. 2
      {{cookiecutter.repo_name}}/install-guide/source/verify.rst

4
{{cookiecutter.repo_name}}/install-guide/source/conf.py

@ -55,7 +55,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Installation Guide for {{service}} Service'
project = u'Installation Guide for {{cookiecutter.service}} Service'
bug_tag = u'install-guide'
copyright = u'2016, OpenStack contributors'
@ -73,7 +73,7 @@ release = '0.1'
# 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/{{codename}}/tree/install-guide/source'
giturl = u'http://git.openstack.org/cgit/openstack/{{cookiecutter.codename}}/tree/install-guide/source'
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,

8
{{cookiecutter.repo_name}}/install-guide/source/get_started.rst

@ -1,10 +1,10 @@
=========================
{{service}} service overview
{{cookiecutter.service}} service overview
=========================
The {{service}} service provides...
The {{cookiecutter.service}} service provides...
The {{service}} service consists of the following components:
The {{cookiecutter.service}} service consists of the following components:
``{{codename}}-api`` service
``{{cookiecutter.codename}}-api`` service
Accepts and responds to end user compute API calls...

4
{{cookiecutter.repo_name}}/install-guide/source/index.rst

@ -1,5 +1,5 @@
=====================
{{service}} service
{{cookiecutter.service}} service
=====================
.. toctree::
@ -9,7 +9,7 @@
verify.rst
next-steps.rst
The {{service}} service ({{codename}}) provides...
The {{cookiecutter.service}} service ({{cookiecutter.codename}}) provides...
This chapter assumes a working setup of OpenStack following the base
Installation Guide.

24
{{cookiecutter.repo_name}}/install-guide/source/install.rst

@ -4,7 +4,7 @@ Install and configure
~~~~~~~~~~~~~~~~~~~~~
This section describes how to install and configure the
{{service}} service, code-named {{codename}}, on the controller node.
{{cookiecutter.service}} service, code-named {{cookiecutter.codename}}, on the controller node.
This section assumes that you already have a working OpenStack
environment with at least the following components installed:
@ -13,7 +13,7 @@ Compute, Image Service, Identity.
Prerequisites
-------------
Before you install and configure the {{service}} service, you must create a
Before you install and configure the {{cookiecutter.service}} service, you must create a
database, service credentials, and API endpoints.
#. To create the database, complete these steps:
@ -25,22 +25,22 @@ database, service credentials, and API endpoints.
$ mysql -u root -p
* Create the ``{{codename}}`` database:
* Create the ``{{cookiecutter.codename}}`` database:
.. code-block:: console
CREATE DATABASE {{codename}};
CREATE DATABASE {{cookiecutter.codename}};
* Grant proper access to the ``{{codename}}`` database:
* Grant proper access to the ``{{cookiecutter.codename}}`` database:
.. code-block:: console
GRANT ALL PRIVILEGES ON {{codename}}.* TO '{{codename}}'@'localhost' \
IDENTIFIED BY '{{codename|upper}}_DBPASS';
GRANT ALL PRIVILEGES ON {{codename}}.* TO '{{codename}}'@'%' \
IDENTIFIED BY '{{codename|upper}}_DBPASS';
GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'localhost' \
IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS';
GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'%' \
IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS';
Replace ``{{codename|upper}}_DBPASS`` with a suitable password.
Replace ``{{cookiecutter.codename|upper}}_DBPASS`` with a suitable password.
* Exit the database access client.
@ -53,11 +53,11 @@ database, service credentials, and API endpoints.
#. To create the service credentials, complete these steps:
* Create the ``{{codename}}`` user:
* Create the ``{{cookiecutter.codename}}`` user:
.. code-block:: console
$ openstack user create --domain default --password-prompt {{codename}}
$ openstack user create --domain default --password-prompt {{cookiecutter.codename}}
Install and configure components
--------------------------------

2
{{cookiecutter.repo_name}}/install-guide/source/next-steps.rst

@ -3,7 +3,7 @@
Next steps
~~~~~~~~~~
Your OpenStack environment now includes the {{codename}} service.
Your OpenStack environment now includes the {{cookiecutter.codename}} service.
To add additional services, see
docs.openstack.org/draft/install-guides/index.html .

2
{{cookiecutter.repo_name}}/install-guide/source/verify.rst

@ -3,4 +3,4 @@
Verify operation
~~~~~~~~~~~~~~~~
Verify operation of the {{service}} service.
Verify operation of the {{cookiecutter.service}} service.

Loading…
Cancel
Save