diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 9 | ||||
| -rw-r--r-- | doc/source/admin/mariadb-backup-and-restore.rst | 4 | ||||
| -rw-r--r-- | doc/source/admin/password-rotation.rst | 2 | ||||
| -rw-r--r-- | doc/source/admin/production-architecture-guide.rst | 10 | ||||
| -rw-r--r-- | doc/source/reference/databases/mariadb-guide.rst | 2 | ||||
| -rw-r--r-- | doc/source/user/quickstart.rst | 2 |
6 files changed, 16 insertions, 13 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index da3f3abff..cd53b9f22 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,12 +1,5 @@ -# The order of packages is significant, because pip processes them in the order -# of appearance. Changing the order has an impact on the overall integration -# process, which may cause wedges in the gate later. -# Order matters to the pip dependency resolver, so sorting this file -# changes how packages are installed. New dependencies should be -# added in alphabetical order, however, some dependencies may need to -# be installed in a specific order. openstackdocstheme>=2.2.1 # Apache-2.0 reno>=3.1.0 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD -whereto>=0.3.0 # Apache-2.0 +whereto>=0.5.0 # Apache-2.0 diff --git a/doc/source/admin/mariadb-backup-and-restore.rst b/doc/source/admin/mariadb-backup-and-restore.rst index aef6394a5..596b7f952 100644 --- a/doc/source/admin/mariadb-backup-and-restore.rst +++ b/doc/source/admin/mariadb-backup-and-restore.rst @@ -41,11 +41,11 @@ Backup Procedure To perform a full backup, run the following command: -``kolla-ansible mariadb_backup -i INVENTORY`` +``kolla-ansible mariadb-backup -i INVENTORY`` Or to perform an incremental backup: -``kolla-ansible mariadb_backup -i INVENTORY --incremental`` +``kolla-ansible mariadb-backup -i INVENTORY --incremental`` Kolla doesn't currently manage the scheduling of these backups, so you'll need to configure an appropriate scheduler (i.e cron) to run these commands diff --git a/doc/source/admin/password-rotation.rst b/doc/source/admin/password-rotation.rst index fe5b5bdb0..e5cfd0261 100644 --- a/doc/source/admin/password-rotation.rst +++ b/doc/source/admin/password-rotation.rst @@ -142,7 +142,7 @@ manually. .. code:: bash - mysql --batch -uroot -p + mariadb --batch -uroot -p #. Check the current state of the ``root`` user: diff --git a/doc/source/admin/production-architecture-guide.rst b/doc/source/admin/production-architecture-guide.rst index d1da7eaad..ced3571fa 100644 --- a/doc/source/admin/production-architecture-guide.rst +++ b/doc/source/admin/production-architecture-guide.rst @@ -14,6 +14,8 @@ Node types and services running on them A basic Kolla inventory consists of several types of nodes, known in Ansible as ``groups``. +* Deployment - Host from which you're running kolla-ansible CLI + * Control - Cloud controller nodes which host control services like APIs and databases. This group should have odd number of nodes for quorum. @@ -29,6 +31,14 @@ A basic Kolla inventory consists of several types of nodes, known in Ansible as * Monitoring - Monitor nodes which host monitoring services. +.. warning:: + + All hosts should be hardened and access to them should be limited, + because Ansible can leak administrative passwords and other secrets to + system log. The same leaked passwords can be observed in OpenSearch if + you're pushing your system logs there. + + Network configuration ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/databases/mariadb-guide.rst b/doc/source/reference/databases/mariadb-guide.rst index e34e4bf0a..c4a40740e 100644 --- a/doc/source/reference/databases/mariadb-guide.rst +++ b/doc/source/reference/databases/mariadb-guide.rst @@ -22,7 +22,7 @@ an independent Galera cluster. This section explains how to configure multiple database shards. Currently, only one shard is accessible via the HAProxy load balancer and supported -by the ``kolla-ansible mariadb_backup`` command. This will be improved +by the ``kolla-ansible mariadb-backup`` command. This will be improved in future by using ProxySQL, allowing load balanced access to all shards. Deployment diff --git a/doc/source/user/quickstart.rst b/doc/source/user/quickstart.rst index b4d855367..f02401fc2 100644 --- a/doc/source/user/quickstart.rst +++ b/doc/source/user/quickstart.rst @@ -261,7 +261,7 @@ There are a few options that are required to deploy Kolla Ansible: * Virtual environment It is recommended to use a virtual environment to execute tasks on the remote - hosts. This is covered + hosts. This is covered in :kolla-ansible-doc:`Virtual Environments <user/virtual-environments.html>`. Deployment |