Add documentation for DevStack integration

Make a separate page for DevStack integration 
for skyline-apiserver instead of readme.

Change-Id: I5f82e7c9ba1d5999b22922080ab93e4dae1f879e
This commit is contained in:
Dmitriy Chubinidze
2025-05-08 11:31:57 +00:00
parent 59d6e4e496
commit 7c059f2ec9
5 changed files with 55 additions and 29 deletions

View File

@@ -212,11 +212,11 @@ Install & Run
make build
Devstack Integration
DevStack Integration
--------------------
`Fast integration with Devstack to build an
environment. <./devstack/README.rst>`__
`Fast integration with DevStack to build an
environment. <https://docs.openstack.org/skyline-apiserver/latest/install/integration-with-devstack.html>`_
Kolla Ansible Deployment
------------------------

View File

@@ -1,27 +1,5 @@
============================
Enabling Skyline in Devstack
============================
======================================
Enabling Skyline APIServer in Devstack
======================================
.. note::
Ubuntu 20.04 (Focal Fossa) is the most tested, and will probably go the smoothest.
1. Download DevStack::
git clone https://github.com/openstack-dev/devstack.git
cd devstack
2. Add this repo as an external repository in ``local.conf`` file::
> cat local.conf
[[local|localrc]]
enable_plugin skyline-apiserver https://opendev.org/openstack/skyline-apiserver
To use stable branches, make sure devstack is on that branch, and specify
the branch name to enable_plugin, for example::
enable_plugin skyline-apiserver https://opendev.org/openstack/skyline-apiserver master
3. Run ``stack.sh``
4. Visit the skyline UI with 9999 port
Instructions for enabling Skyline APIServer on DevStack can be found `here <https://docs.openstack.org/skyline-apiserver/latest/install/integration-with-devstack.html>`_.

View File

@@ -4,6 +4,12 @@ Installation Guide
This section describes how to install and configure the skyline-apiserver.
.. warning::
Horizon and Skyline both default to using the same network ports. Running
both services at the same time without reconfiguring ports will result in
a conflict, causing one or both services to fail.
System Requirements
===================

View File

@@ -12,3 +12,4 @@ Skyline APIServer on Ubuntu 20.04 LTS and RHEL/CentOS.
docker-install-ubuntu
verify-install
source-install-rhel
integration-with-devstack

View File

@@ -0,0 +1,41 @@
.. _integration-with-devstack:
Integration with DevStack
~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
Ubuntu 20.04 (Focal Fossa) is the most tested and typically offers
the smoothest experience. Ubuntu 22.04, 24.04, and Rocky Linux 9 are
also supported, but may require additional testing or adjustments.
#. Download DevStack:
.. code-block:: console
# git clone https://opendev.org/openstack/devstack
# cd devstack
#. Add this repo as an external repository in ``local.conf`` file:
.. code-block:: console
# cat local.conf
[[local|localrc]]
enable_plugin skyline-apiserver https://opendev.org/openstack/skyline-apiserver
#. To use stable branches, make sure devstack is on that branch, and specify
the branch name to enable_plugin, for example:
.. code-block:: console
enable_plugin skyline-apiserver https://opendev.org/openstack/skyline-apiserver master
#. Run ``stack.sh``:
.. code-block:: console
# ./stack.sh
#. Visit the skyline UI with 9999 port