docs: Add source install guide

Add skyline console source install guide

Change-Id: I96e5f56c03637ee70da2f59c83af8a8b97a0e257
This commit is contained in:
yangsngshaoxue 2022-08-30 23:00:48 +08:00
parent 3527d175ef
commit a1cd7d8f55
2 changed files with 69 additions and 8 deletions

View File

@ -50,9 +50,8 @@ Setup Your Local Development Env
.. code:: shell
NODE_VERSION=erbium
nvm install --lts=$NODE_VERSION
nvm alias default lts/$NODE_VERSION
nvm install --lts=Erbium
nvm alias default lts/erbium
nvm use default
- Verify nodejs and npm versions
@ -90,6 +89,8 @@ You can also use the following commands:
- ``yarn run build``: Build packages and then you can hand over the
contents of the generated *dist* directory to the back end.
For more information about configuration, see :ref:`configuration-settings`.
Running tests
-------------

View File

@ -7,10 +7,42 @@ This section describes how to install and configure the Skyline Console
service. Before you begin, you must have a ready OpenStack environment. At
least it includes ``keystone, glance, nova, neutron and skyline-apiserver service``.
For more information about skyline-apiserver installation, refer to the
`OpenStack Skyline APIServer Guide
<https://docs.openstack.org/skyline-apiserver/latest/install/source-install-ubuntu.html>`__.
Prerequisites
-------------
#. Install system dependencies
.. code-block:: shell
sudo apt update
sudo apt install -y git python3-pip nginx make
sudo apt-get install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb
#. Install nvm ( version control system for nodejs )
.. code:: shell
wget -P /root/ --tries=10 --retry-connrefused --waitretry=60 --no-dns-cache --no-cache https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh
bash /root/install.sh
. /root/.nvm/nvm.sh
#. Install nodejs
.. code:: shell
nvm install --lts=Erbium
nvm alias default lts/erbium
nvm use default
#. Install yarn
.. code:: shell
npm install -g yarn
Install and configure components
--------------------------------
@ -19,12 +51,10 @@ We will install the Skyline Console service from source code.
#. Git clone the repository from OpenDev (GitHub)
.. code-block:: console
.. code-block:: shell
$ sudo apt update
$ sudo apt install -y git
$ cd ${HOME}
$ git clone https://opendev.org/openstack/skyline-console.git
cd ${HOME}
git clone https://opendev.org/openstack/skyline-console.git
.. note::
@ -33,5 +63,35 @@ We will install the Skyline Console service from source code.
`fatal: unable to access 'https://opendev.org/openstack/skyline-sonsole.git/': server
certificate verification failed. CAfile: none CRLfile: none`
#. Install skyline-console
.. code-block:: shell
cd ${HOME}/skyline-console
make package
sudo pip3 install --force-reinstall dist/skyline_console-*.whl
#. Ensure that skyline folders have been created
.. code-block:: shell
sudo mkdir -p /etc/skyline /var/log/skyline
.. note::
Ensure that skyline.yaml file is available in /etc/skyline folder.
For more information about skyline.yml, see :ref:`skyline-settings`.
#. Generate nginx configuration file
.. code-block:: shell
skyline-nginx-generator -o /etc/nginx/nginx.conf
Finalize installation
---------------------
#. Start nginx service
.. code-block:: shell
sudo systemctl start nginx.service