From cb8f9b1807df76e2d2fa2751865cf56b02088f19 Mon Sep 17 00:00:00 2001 From: "zhang.lei" Date: Thu, 22 Feb 2018 02:57:28 +0000 Subject: [PATCH] Revise the code-block format of documentation Change-Id: If28db07bdd1bab3dc856a4a7675461a319618f32 --- doc/source/install/common_configure.rst | 120 +++++++++++------------- doc/source/install/install_agent.rst | 16 ++-- 2 files changed, 64 insertions(+), 72 deletions(-) diff --git a/doc/source/install/common_configure.rst b/doc/source/install/common_configure.rst index bbd1f655..b2fb4326 100644 --- a/doc/source/install/common_configure.rst +++ b/doc/source/install/common_configure.rst @@ -1,11 +1,9 @@ 2. Copy the configuration files to ``/etc/freezer/``: + .. code-block:: console -.. code-block:: bash - - sudo cp etc/freezer/freezer-api.conf.sample /etc/freezer/freezer-api.conf - sudo cp etc/freezer/freezer-paste.ini /etc/freezer/freezer-paste.ini - + sudo cp etc/freezer/freezer-api.conf.sample /etc/freezer/freezer-api.conf + sudo cp etc/freezer/freezer-paste.ini /etc/freezer/freezer-paste.ini 3. Edit the ``/etc/freezer/freezer-api.conf`` file and complete the following actions: @@ -35,25 +33,22 @@ retries=20 number_of_replicas = 1 - - Start elasticsearch ------------------- The currently supported db is Elasticsearch. In case you are using a dedicated - instance of the server, you'll need to start it. Depending on the OS flavor - it might be a: +instance of the server, you'll need to start it. Depending on the OS flavor +it might be: -.. code-block:: bash +.. code-block:: console - service elasticsearch start + # service elasticsearch start or, on systemd -.. code-block:: bash - - systemctl start elasticsearch +.. code-block:: console + # systemctl start elasticsearch Using freezer-manage -------------------- @@ -63,45 +58,46 @@ This information is contained in the `mapping`, or schema definition. Elasticsearch will use dynamic mapping to try to guess the field type from the basic datatypes available in JSON, but some field's properties have to be explicitly declared to tune the indexing engine. -To do that, use the freezer-manage command: -:: +To do that, use the :command:`freezer-manage` command: - freezer-manage db sync +.. code-block:: console + + # freezer-manage db sync You should have updated your configuration files before doing this step. freezer-manage has the following options: * To create the db mappings use the following command -.. code-block:: bash + .. code-block:: console - freezer-manage db sync + # freezer-manage db sync * To update the db mappings using the following command. Update means that you might have some mappings and you want to update it with a more recent ones -.. code-block:: bash + .. code-block:: console - freezer-manage db update + # freezer-manage db update * To remove the db mappings using the following command -.. code-block:: bash + .. code-block:: console - freezer-manage db remove + # freezer-manage db remove * To print the db mappings using the following command -.. code-block:: bash + .. code-block:: console - freezer-manage db show + # freezer-manage db show * To update your settings (number of replicas) all what you need to do is to change its value in the configuration file and then run the following command -.. code-block:: bash + .. code-block:: console - freezer-manage db update-settings + # freezer-manage db update-settings If you provided an invalid number of replicas that will cause problems later on, so it's highly recommended to make sure that you are using the correct number @@ -109,78 +105,76 @@ of replicas. For more info click here `Elasticsearch_Replicas_instructions - WSGIDaemonProcess freezer-api processes=2 threads=2 user=freezer display-name=%{GROUP} - WSGIProcessGroup freezer-api - WSGIApplicationGroup freezer-api - WSGIScriptAlias / /opt/stack/freezer_api/cmd/wsgi.py + + WSGIDaemonProcess freezer-api processes=2 threads=2 user=freezer display-name=%{GROUP} + WSGIProcessGroup freezer-api + WSGIApplicationGroup freezer-api + WSGIScriptAlias / /opt/stack/freezer_api/cmd/wsgi.py - = 2.4> - ErrorLogFormat "%M" - - ErrorLog /var/log/%APACHE_NAME%/freezer-api.log - LogLevel warn - CustomLog /var/log/freezer-api/freezer-api_access.log combined + = 2.4> + ErrorLogFormat "%M" + + ErrorLog /var/log/%APACHE_NAME%/freezer-api.log + LogLevel warn + CustomLog /var/log/freezer-api/freezer-api_access.log combined - - Options Indexes FollowSymLinks MultiViews - Require all granted - AllowOverride None - Order allow,deny - allow from all - LimitRequestBody 102400 - - + + Options Indexes FollowSymLinks MultiViews + Require all granted + AllowOverride None + Order allow,deny + allow from all + LimitRequestBody 102400 + + Install and configure freezer-scheduler/agent diff --git a/doc/source/install/install_agent.rst b/doc/source/install/install_agent.rst index 525cbd37..7ee21ba3 100644 --- a/doc/source/install/install_agent.rst +++ b/doc/source/install/install_agent.rst @@ -3,14 +3,14 @@ freezer-agent, on any node in the cloud or any vm inside the cloud. This section assumes that you already have a working OpenStack environment with at least the following components installed: -.. Keystone -.. Swift +- Keystone +- Swift .. code-block:: bash - git clone https://git.openstack.org/openstack/freezer.git - cd freezer - pip install ./ + git clone https://git.openstack.org/openstack/freezer.git + cd freezer + pip install ./ Configure the scheduler @@ -29,8 +29,8 @@ Configure the scheduler * In the ``[DEFAULT]`` section, configure database access: - The ``client_id`` has to be set to the hostname of the machine. It will be - used as an identifier for this node to fetch its scheduled backups + The ``client_id`` has to be set to the hostname of the machine. It will be + used as an identifier for this node to fetch its scheduled backups .. code-block:: ini @@ -39,10 +39,8 @@ Configure the scheduler client_id = hostname_of_machine jobs_dir = /etc/freezer/scheduler/conf.d - 3. Start ``freezer-scheduler`` - .. code-block:: console $ . admin-openrc