Update the installation documentation

Add configurable policy files.

Change-Id: Ib4395b58dccf94aa18a88b66c9ee3e1e33df9787
This commit is contained in:
root 2023-11-01 11:32:18 +08:00
parent 1e4f72ca2b
commit a27c6daea6
6 changed files with 46 additions and 0 deletions

View File

@ -104,6 +104,10 @@ Skyline 像九色鹿一样,轻巧、优雅,而又能力强大,为 OpenStac
``LISTEN_ADDRESS`` 默认为 ``0.0.0.0:9999``
如果需要修改某个 service 的 policy 规则,则在以下命令中添加 ``-v /etc/skyline/policy:/etc/skyline/policy``
将对应的 policy yaml 文件重命名为 ``<service_name>_policy.yaml``, 并放其在 ``/etc/skyline/policy`` 文件夹下
.. code:: bash
docker run -d --name skyline --restart=always -v /etc/skyline/skyline.yaml:/etc/skyline/skyline.yaml -v /tmp/skyline:/tmp --net=host 99cloud/skyline:latest
@ -177,6 +181,10 @@ Skyline 像九色鹿一样,轻巧、优雅,而又能力强大,为 OpenStac
``LISTEN_ADDRESS`` 默认为 ``0.0.0.0:9999``
如果需要修改某个 service 的 policy 规则,则在以下命令中添加 ``-v /etc/skyline/policy:/etc/skyline/policy``
将对应的 policy yaml 文件重命名为 ``<service_name>_policy.yaml``, 并放其在 ``/etc/skyline/policy`` 文件夹下
.. code:: bash
docker run -d --name skyline --restart=always -v /etc/skyline/skyline.yaml:/etc/skyline/skyline.yaml --net=host 99cloud/skyline:latest

View File

@ -103,6 +103,10 @@ Deployment with Sqlite
``LISTEN_ADDRESS`` defaults to ``0.0.0.0:9999``
If you need to modify the policy rules of a service, add ``-v /etc/skyline/policy:/etc/skyline/policy`` in the following command
Rename the service policy yaml file to ``<service_name>_policy.yaml``, and place it in ``/etc/skyline/policy`` folder
.. code:: bash
docker run -d --name skyline --restart=always -v /var/log/skyline:/var/log/skyline -v /etc/skyline/skyline.yaml:/etc/skyline/skyline.yaml -v /tmp/skyline:/tmp --net=host 99cloud/skyline:latest

View File

@ -12,11 +12,14 @@ file ``skyline.yaml.sample`` in ``etc`` directory.
default:
access_token_expire: 3600
access_token_renew: 1800
cafile: ''
cors_allow_origins: []
database_url: sqlite:////tmp/skyline.db
debug: false
log_dir: ./log
log_file: skyline.log
policy_file_path: /etc/skyline/policy
policy_file_suffix: policy.yaml
prometheus_basic_auth_password: ''
prometheus_basic_auth_user: ''
prometheus_enable_basic_auth: false
@ -44,8 +47,10 @@ file ``skyline.yaml.sample`` in ``etc`` directory.
container: zun
container-infra: magnum
database: trove
dns: designate
identity: keystone
image: glance
instance-ha: masakari
key-manager: barbican
load-balancer: octavia
network: neutron

View File

@ -102,6 +102,17 @@ We will install the Skyline APIServer service from docker image.
$ sudo mkdir -p /etc/skyline /var/log/skyline /var/lib/skyline /var/log/nginx
.. note::
Modify policy rules of services
.. code-block:: console
$ sudo mkdir -p /etc/skyline/policy
Rename the service policy yaml file to ``<service_name>_policy.yaml``,
and place it in ``/etc/skyline/policy`` folder.
#. Set all value from :ref:`configuration-settings` into the configuration file
``/etc/skyline/skyline.yaml``
@ -186,6 +197,11 @@ Finalize installation
If you want to enable ssl, add ``-e SSL_CERTFILE=<ssl-certfile> -e SSL_KEYFILE=<ssl-keyfile>``
in run command. Default does not enable ssl.
.. note::
If you need to modify the policy rules of services,
add ``-v /etc/skyline/policy:/etc/skyline/policy`` in run command.
API Doc
---------

View File

@ -114,6 +114,17 @@ We will install the Skyline APIServer service from source code.
$ sudo mkdir -p /etc/skyline /var/log/skyline
.. note::
Modify policy rules of services
.. code-block:: console
$ sudo mkdir -p /etc/skyline/policy
Rename the service policy yaml file to ``<service_name>_policy.yaml``,
and place it in ``/etc/skyline/policy`` folder.
#. Copy the configuration file to the configuration folder ``/etc/skyline``
.. code-block:: console

View File

@ -7,6 +7,8 @@ default:
debug: false
log_dir: ./log
log_file: skyline.log
policy_file_path: /etc/skyline/policy
policy_file_suffix: policy.yaml
prometheus_basic_auth_password: ''
prometheus_basic_auth_user: ''
prometheus_enable_basic_auth: false