Merge "Add the describe of uWSGI to run Gnocchi API"

openstack · Sep 28, 2021 · b73ae4e · b73ae4e
2 parents acb3cba + 2e09c65
commit b73ae4e
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 3 deletions.
diff --git a/doc/source/install/install-base-obs.rst b/doc/source/install/install-base-obs.rst
@@ -32,6 +32,22 @@ Install Gnocchi
       Depending on your environment size, consider installing Gnocchi
       separately as it makes extensive use of the cpu.
 
+#. Install the uWSGI packages. The following method uses operating system
+   provided packages. Another alternative would be to use pip(or pip3,
+   depending on the distribution); using pip is not described in this doc:
+
+   .. code-block:: console
+
+      # zypper install uwsgi-plugin-python3 uwsgi
+
+   .. note::
+
+      Since the provided gnocchi-api wraps around uwsgi, you need to
+      make sure that uWSGI is installed if you want to use gnocchi-api
+      to run Gnocchi API.
+      As Gnocchi API tier runs using WSGI, it can also alternatively
+      be run using Apache httpd and mod_wsgi, or any other HTTP daemon.
+
 .. include:: install-gnocchi.inc
 
 Finalize Gnocchi installation

diff --git a/doc/source/install/install-base-rdo.rst b/doc/source/install/install-base-rdo.rst
@@ -32,6 +32,22 @@ Install Gnocchi
       Depending on your environment size, consider installing Gnocchi
       separately as it makes extensive use of the cpu.
 
+#. Install the uWSGI packages. The following method uses operating system
+   provided packages. Another alternative would be to use pip(or pip3,
+   depending on the distribution); using pip is not described in this doc:
+
+   .. code-block:: console
+
+      # yum install uwsgi-plugin-common uwsgi-plugin-python3 uwsgi
+
+   .. note::
+
+      Since the provided gnocchi-api wraps around uwsgi, you need to
+      make sure that uWSGI is installed if you want to use gnocchi-api
+      to run Gnocchi API.
+      As Gnocchi API tier runs using WSGI, it can also alternatively
+      be run using Apache httpd and mod_wsgi, or any other HTTP daemon.
+
 .. include:: install-gnocchi.inc
 
 Finalize Gnocchi installation

diff --git a/doc/source/install/install-base-ubuntu.rst b/doc/source/install/install-base-ubuntu.rst
@@ -31,6 +31,22 @@ Install Gnocchi
       Depending on your environment size, consider installing Gnocchi
       separately as it makes extensive use of the cpu.
 
+#. Install the uWSGI packages. The following method uses operating system
+   provided packages. Another alternative would be to use pip(or pip3,
+   depending on the distribution); using pip is not described in this doc:
+
+   .. code-block:: console
+
+      # apt-get install uwsgi-plugin-python3 uwsgi
+
+   .. note::
+
+      Since the provided gnocchi-api wraps around uwsgi, you need to
+      make sure that uWSGI is installed if you want to use gnocchi-api
+      to run Gnocchi API.
+      As Gnocchi API tier runs using WSGI, it can also alternatively
+      be run using Apache httpd and mod_wsgi, or any other HTTP daemon.
+
 .. include:: install-gnocchi.inc
 
 Finalize Gnocchi installation

diff --git a/doc/source/install/install-gnocchi.inc b/doc/source/install/install-gnocchi.inc
@@ -1,4 +1,4 @@
-2. Create the database for Gnocchi's indexer:
+3. Create the database for Gnocchi's indexer:
 
    * Use the database access client to connect to the database
      server as the ``root`` user:
@@ -26,14 +26,16 @@
 
    * Exit the database access client.
 
-3. Edit the ``/etc/gnocchi/gnocchi.conf`` file and add Keystone options:
+4. Edit the ``/etc/gnocchi/gnocchi.conf`` file and add Keystone options:
 
    * In the ``[api]`` section, configure gnocchi to use keystone:
 
      .. code-block:: ini
 
         [api]
         auth_mode = keystone
+        port = 8041
+        uwsgi_mode = http-socket
 
    * In the ``[keystone_authtoken]`` section, configure keystone
      authentication:
@@ -78,7 +80,7 @@
         file_basepath = /var/lib/gnocchi
         driver = file
 
-4. Initialize Gnocchi:
+5. Initialize Gnocchi:
 
    .. code-block:: console