Docs: Touch up getting started documentation
This is to fix up a slight rendering issue with getting started documentation related to double code block syntax. Change-Id: I4b6777f77d148113e5a798aeb3daa520d05c1f0e
This commit is contained in:
parent
87d7f94134
commit
eeff5c7d24
1
AUTHORS
1
AUTHORS
|
@ -9,5 +9,6 @@ Mark Burnett <mark.m.burnett@gmail.com>
|
||||||
Mike Kochetov <mike.nycmoma@gmail.com>
|
Mike Kochetov <mike.nycmoma@gmail.com>
|
||||||
Pete Birley <pete@port.direct>
|
Pete Birley <pete@port.direct>
|
||||||
Scott Hussey <sh8121@att.com>
|
Scott Hussey <sh8121@att.com>
|
||||||
|
Stacey Fletcher <staceylynnfletcher@gmail.com>
|
||||||
Tin Lam <tin@irrational.io>
|
Tin Lam <tin@irrational.io>
|
||||||
portdirect <pete@port.direct>
|
portdirect <pete@port.direct>
|
||||||
|
|
|
@ -8,14 +8,14 @@ Pre-requisites
|
||||||
|
|
||||||
To install tox run::
|
To install tox run::
|
||||||
|
|
||||||
$ sudo apt-get install tox
|
$ [sudo] apt-get install tox
|
||||||
|
|
||||||
* PostgreSQL
|
* PostgreSQL
|
||||||
|
|
||||||
Deckhand only supports PostgreSQL. Install it by running::
|
Deckhand only supports PostgreSQL. Install it by running::
|
||||||
|
|
||||||
$ sudo apt-get update
|
$ [sudo] apt-get update
|
||||||
$ sudo apt-get install postgresql postgresql-contrib
|
$ [sudo] apt-get install postgresql postgresql-contrib
|
||||||
|
|
||||||
Quickstart
|
Quickstart
|
||||||
----------
|
----------
|
||||||
|
@ -39,19 +39,17 @@ Move the sample configuration file into a desired directory
|
||||||
|
|
||||||
Set the database string in the configuration file to ``sqlite://``
|
Set the database string in the configuration file to ``sqlite://``
|
||||||
|
|
||||||
::
|
.. code-block:: ini
|
||||||
|
|
||||||
.. code-block:: ini
|
[database]
|
||||||
|
|
||||||
[database]
|
#
|
||||||
|
# From oslo.db
|
||||||
|
#
|
||||||
|
|
||||||
#
|
# The SQLAlchemy connection string to use to connect to the database.
|
||||||
# From oslo.db
|
# (string value)
|
||||||
#
|
connection = sqlite://
|
||||||
|
|
||||||
# The SQLAlchemy connection string to use to connect to the database.
|
|
||||||
# (string value)
|
|
||||||
connection = sqlite://
|
|
||||||
|
|
||||||
Finally, run Deckhand via Docker::
|
Finally, run Deckhand via Docker::
|
||||||
|
|
||||||
|
@ -88,8 +86,6 @@ Substitute the connection information (which can be retrieved by running
|
||||||
``export | grep PIFPAF_POSTGRESQL_URL``) into the config file inside
|
``export | grep PIFPAF_POSTGRESQL_URL``) into the config file inside
|
||||||
``etc/deckhand/deckhand.conf.sample``::
|
``etc/deckhand/deckhand.conf.sample``::
|
||||||
|
|
||||||
.. code-block:: ini
|
|
||||||
|
|
||||||
[database]
|
[database]
|
||||||
|
|
||||||
#
|
#
|
||||||
|
@ -158,8 +154,6 @@ Retrieve the environment variable which contains connection information::
|
||||||
Substitute the connection information into the config file in
|
Substitute the connection information into the config file in
|
||||||
``${OS_DECKHAND_CONFIG_DIR}``::
|
``${OS_DECKHAND_CONFIG_DIR}``::
|
||||||
|
|
||||||
.. code-block:: ini
|
|
||||||
|
|
||||||
[database]
|
[database]
|
||||||
|
|
||||||
#
|
#
|
||||||
|
@ -172,7 +166,8 @@ Substitute the connection information into the config file in
|
||||||
|
|
||||||
Finally, run Deckhand::
|
Finally, run Deckhand::
|
||||||
|
|
||||||
$ uwsgi --ini wsgi.ini
|
$ chmod +x entrypoint.sh
|
||||||
|
$ ./entrypoint.sh
|
||||||
|
|
||||||
To kill the ephemeral DB afterward::
|
To kill the ephemeral DB afterward::
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue