Merge "[docs] Documentation about using Glare Artifact Repository"

devstack/README.rst

@@ -18,6 +18,16 @@ Enabling in Devstack
 
      enable_service murano-cfapi
 
+#. If you want to use Glare Artifact Repository as a strorage for packages,
+   add the following line to ``local.conf``:
+
+   .. code-block:: ini
+
+      enable_service g-glare
+
+   For more information on how to use Glare Artifact Repository,
+   see :ref:`glare_usage`.
+
 #. (Optional) To import Murano packages when DevStack is up, define an ordered
    list of packages FQDNs in ``local.conf``. Make sure to list all package
    dependencies. These packages will by default be imported from the murano-apps

doc/source/draft/admin-guide/deploy_murano/devstack.rst

@@ -31,6 +31,16 @@ with murano, proceed with the following steps:
 
       enable_service murano-cfapi
 
+#. If you want to use Glare Artifact Repository as a strorage for packages,
+   add the following line to ``local.conf``:
+
+   .. code-block:: ini
+
+      enable_service g-glare
+
+   For more information on how to use Glare Artifact Repository,
+   see :ref:`glare_usage`.
+
 #. (Optional) To import murano packages when DevStack is up, define an ordered
    list of FQDN packages in ``local.conf``. Verify that you list all package
    dependencies. These packages will be imported from the ``murano-apps``

doc/source/draft/admin-guide/using_glare.rst

@@ -0,0 +1,133 @@
+.. _glare_usage:
+
+
+===================================
+Using Glare as a storage for packages
+===================================
+
+DevStack installation
+---------------------
+
+#. Enable Glare service in DevStack
+
+   To enable the Glare service in DevStack, edit the ``local.conf`` file:
+
+   .. code-block:: console
+
+      $ cat local.conf
+      [[local|localrc]]
+      enable_service g-glare
+
+#. Run DevStack:
+
+   .. code-block:: console
+
+      $ ./stack.sh
+
+   **Result** Glare service is installed with DevStack.
+   You can find logs in ``g-glare`` screen session.
+
+#. Install the ``muranoartifact`` plug-in from ``murano/contrib``
+
+   .. code-block:: console
+
+      $ cd $DEST/murano/contrib/glance/
+      $ sudo pip install -e .
+
+#. Restart ``Glare``
+
+#. Set Glare as packages service in murano-engine. For this,
+   edit the ``[engine]`` section in the ``murano.conf`` file.
+   By default, ``murano.conf`` is located in the ``/etc/murano`` directory
+
+   .. code-block:: ini
+
+      [engine]
+
+      packages_service = glare
+
+#. Restart ``murano-engine``
+
+   .. note:: You also can use ``glance`` as a value of the
+             ``packages_service`` option for the same behaviour
+
+#. Enable Glare in ``murano-dashboard``. For this, add the following line
+   to the ``local_settins.py`` file
+
+   .. code-block:: python
+
+      MURANO_USE_GLARE = True
+
+   By default, the ``local_settings.py`` file is located in
+   ``$DEST/horizon/openstack_dashboard/local/``.
+
+#. Restart the ``apache2`` service.
+   Now ``murano-dashboard`` will retrieve packages from Glare.
+
+#. Log in to Dashboard and navigate to :menuselection:`Murano > Manage > Packages`
+   to view the empty list of packages.
+   Alternatively, use the :command:`murano` command.
+
+#. Use :option:`--murano-packages-service` option to specify backend,
+   used by :command:`murano` command. Set it to ``glare`` for using ``Glare``
+
+   .. note:: You also can use ``glance`` as value
+             of :option:`--murano-packages-service` option or environment variable
+             :option:`MURANO_PACKAGES_SERVICE` for same behaviour
+
+   + View list of packages:
+
+     .. code-block:: console
+
+         $ source {DEVSTACK_SOURCE_DIR}/openrc admin admin
+         $ murano --murano-packages-service=glare  package-list
+
+         +----+------+-----+--------+--------+-----------+------+---------+
+         | ID | Name | FQN | Author | Active | Is Public | Type | Version |
+         +----+------+-----+--------+--------+-----------+------+---------+
+         +----+------+-----+--------+--------+-----------+------+---------+
+
+   + Importing ``Core library``
+
+     .. code-block:: console
+
+         $ cd $DEST/murano/meta/io.murano/
+         $ zip io.murano.zip -r *
+         $ murano --murano-packages-service=glare  package-import \
+             --is-public /opt/stack/murano/meta/io.murano/io.murano.zip
+
+         Importing package io.murano
+         +--------------------------------------+--------------+-----------+-----------+--------+-----------+---------+---------+
+         | ID                                   | Name         | FQN       | Author    | Active | Is Public | Type    | Version |
+         +--------------------------------------+--------------+-----------+-----------+--------+-----------+---------+---------+
+         | 91a9c78f-f23a-4c82-aeda-14c8cbef096a | Core library | io.murano | murano.io | True   |           | Library | 0.0.0   |
+         +--------------------------------------+--------------+-----------+-----------+--------+-----------+---------+---------+
+
+Set up Glare API entrypoint manually
+------------------------------------
+
+If you do not plan to get Glare service from keystone application catalog,
+specify where g-glare service is running.
+
+#. Specify Glare URL in ``murano.conf``.It is http://0.0.0.0:9494 by default
+   and can be changed by setting `bind_host` and `bind_port` options in
+   the ``glance-glare.conf`` file.
+
+   .. code-block:: ini
+
+      [glare]
+
+      url = http://<GLARE_API_URL>:<GLARE_API_PORT>
+
+#. Specify Glare URL in the Dashboard settings file:
+
+   .. code-block:: python
+
+      GLARE_API_URL = 'http://<GLARE_API>:<GLARE_API_PORT>'
+
+#. Set the ``GLARE_URL`` environment variable for python-muranoclient.
+   Alternatively, use the :option:`--glare-url` option in CLI.
+
+   .. code-block:: console
+
+      $ murano --murano-packages-service=glare --glare-url=http://0.0.0.0:9494  package-list

doc/source/draft/index.rst

@@ -74,6 +74,7 @@ Deploying Murano
    admin-guide/murano_agent
    admin-guide/policy_enf
    admin-guide/configure_cloud_foundry_service_broker
+   admin-guide/using_glare.rst
    admin-guide/admin_troubleshooting
 
 Developing Applications