diff --git a/README.rst b/README.rst index 8aa8b75..c6eb851 100644 --- a/README.rst +++ b/README.rst @@ -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. `_ Kolla Ansible Deployment ------------------------ diff --git a/devstack/README.rst b/devstack/README.rst index a04b16c..a9fd756 100644 --- a/devstack/README.rst +++ b/devstack/README.rst @@ -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 `_. diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index e9ddee1..518f1ca 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -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 =================== diff --git a/doc/source/install/installing-guide.rst b/doc/source/install/installing-guide.rst index d1e3b49..8acf700 100644 --- a/doc/source/install/installing-guide.rst +++ b/doc/source/install/installing-guide.rst @@ -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 diff --git a/doc/source/install/integration-with-devstack.rst b/doc/source/install/integration-with-devstack.rst new file mode 100644 index 0000000..c5058fd --- /dev/null +++ b/doc/source/install/integration-with-devstack.rst @@ -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