Skip to content

Commit 348b7b0

Browse files
seunghun1eeseunghun1ee
committed
Update docs Q2 2024
1 parent 0c5ff09 commit 348b7b0

File tree

5 files changed

+173
-16
lines changed

5 files changed

+173
-16
lines changed

‎source/access_to_services.rst

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
.. include:: vars.rst
2+
3+
==================
4+
Access to Services
5+
==================
6+
7+
Openstack Services
8+
==================
9+
10+
Accessing to Horizon
11+
--------------------
12+
13+
The OpenStack web UI is available at: |horizon_url|
14+
15+
This site is accessible |horizon_access|.
16+
17+
Accessing the OpenStack CLI
18+
---------------------------
19+
20+
A simple way to get started with accessing the OpenStack command-line
21+
interface.
22+
23+
This can be done from |public_api_access_host| (for example), or any machine
24+
that has access to |public_vip|:
25+
26+
.. code-block:: console
27+
28+
openstack# python3 -m venv openstack-venv
29+
openstack# source openstack-venv/bin/activate
30+
openstack# pip install -U pip
31+
openstack# pip install python-openstackclient
32+
openstack# source <project>-openrc.sh
33+
34+
The `<project>-openrc.sh` file can be downloaded from the OpenStack Dashboard
35+
(Horizon):
36+
37+
.. image:: _static/openrc.png
38+
:alt: Downloading an openrc file from Horizon
39+
:class: no-scaled-link
40+
:width: 200
41+
42+
Now it should be possible to run OpenStack commands:
43+
44+
.. code-block:: console
45+
46+
openstack# openstack server list
47+
48+
Accessing Deployed Instances
49+
----------------------------
50+
51+
The external network of OpenStack, called |public_network|, connects to the
52+
subnet |public_subnet|. This network is accessible |floating_ip_access|.
53+
54+
Any OpenStack instance can make outgoing connections to this network, via a
55+
router that connects the internal network of the project to the
56+
|public_network| network.
57+
58+
To enable incoming connections (e.g. SSH), a floating IP is required. A
59+
floating IP is allocated and associated via OpenStack. Security groups must be
60+
set to permit the kind of connectivity required (i.e. to define the ports that
61+
must be opened).
62+
63+
Monitoring Services
64+
===================
65+
66+
Access to Opensearch Dashboard
67+
------------------------------
68+
69+
OpenStack control plane logs are aggregated from all servers by Fluentd and
70+
stored in OpenSearch. The control plane logs can be accessed from
71+
OpenSearch using Opensearch Dashboard, which is available at the following URL:
72+
|opensearch_dashboard_url|
73+
74+
To log in, use the ``opensearch`` user. The password is auto-generated by
75+
Kolla-Ansible and can be extracted from the encrypted passwords file
76+
(|kolla_passwords|):
77+
78+
.. code-block:: console
79+
:substitutions:
80+
81+
kayobe# ansible-vault view ${KAYOBE_CONFIG_PATH}/kolla/passwords.yml --vault-password-file |vault_password_file_path| | grep ^opensearch
82+
83+
Access to Grafana
84+
-----------------
85+
86+
Control plane metrics can be visualised in Grafana dashboards. Grafana can be
87+
found at the following address: |grafana_url|
88+
89+
To log in, use the |grafana_username| user. The password is auto-generated by
90+
Kolla-Ansible and can be extracted from the encrypted passwords file
91+
(|kolla_passwords|):
92+
93+
.. code-block:: console
94+
:substitutions:
95+
96+
kayobe# ansible-vault view ${KAYOBE_CONFIG_PATH}/kolla/passwords.yml --vault-password-file |vault_password_file_path| | grep ^grafana_admin_password
97+
98+
.. _prometheus-alertmanager:
99+
100+
Access to Prometheus Alertmanager
101+
---------------------------------
102+
103+
Control plane alerts can be visualised and managed in Alertmanager, which can
104+
be found at the following address: |alertmanager_url|
105+
106+
To log in, use the ``admin`` user. The password is auto-generated by
107+
Kolla-Ansible and can be extracted from the encrypted passwords file
108+
(|kolla_passwords|):
109+
110+
.. code-block:: console
111+
:substitutions:
112+
113+
kayobe# ansible-vault view ${KAYOBE_CONFIG_PATH}/kolla/passwords.yml --vault-password-file |vault_password_file_path| | grep ^prometheus_alertmanager_password
114+
115+
116+
.. ifconfig:: deployment['wazuh']
117+
118+
Access to Wazuh Manager
119+
-----------------------
120+
121+
To access the Wazuh Manager dashboard, navigate to the ip address
122+
of |wazuh_manager_name| (|wazuh_manager_url|).
123+
124+
You can login to the dashboard with the username ``admin``. The
125+
password for ``admin`` is defined in the secret
126+
``opendistro_admin_password`` which can be found within
127+
``etc/kayobe/inventory/group_vars/wazuh-manager/wazuh-secrets.yml``.
128+
129+
.. note:: Use ``ansible-vault`` to view Wazuh secrets:
130+
:substitutions:
131+
132+
``ansible-vault view --vault-password-file |vault_password_file_path| $KAYOBE_CONFIG_PATH/inventory/group_vars/wazuh-manager/wazuh-secrets.yml``

‎source/index.rst

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,10 @@ Contents
1818
:maxdepth: 2
1919

2020
introduction
21-
working_with_openstack
21+
overview_of_system
2222
working_with_kayobe
23+
access_to_services
2324
physical_network
24-
hardware_inventory_management
25-
ceph_storage
26-
managing_users_and_projects
27-
operations_and_monitoring
28-
wazuh
29-
customising_deployment
30-
gpus_in_openstack
31-
baremetal_management
32-
rally_and_tempest
3325

3426
Indices and search
3527
==================

‎source/overview_of_system.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. include:: vars.rst
2+
3+
==================
4+
Overview of System
5+
==================
6+
7+
.. Overview of the client's System should be included here.
8+
9+
Ansible Control Host
10+
====================
11+
12+
Seed
13+
====
14+
15+
Overcloud
16+
=========
17+
18+
Controllers
19+
-----------
20+
21+
Hypervisors
22+
-----------
23+
24+
Storages
25+
--------
26+
27+
Monitors
28+
--------

‎source/vars.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
.. |kayobe_source_url| replace:: https://github.com/acme-openstack/kayobe.git
2626
.. |kayobe_source_version| replace:: ``acme/yoga``
2727
.. |keystone_public_url| replace:: https://openstack.acme.example:5000
28-
.. |opensearch_dashboards_url| replace:: https://openstack.acme.example:5601
28+
.. |opensearch_dashboard_url| replace:: https://openstack.acme.example:5601
2929
.. |kolla_passwords| replace:: https://github.com/acme-openstack/kayobe-config/blob/acme/yoga/etc/kayobe/kolla/passwords.yml
3030
.. |monitoring_host| replace:: ``mon0``
3131
.. |network_name| replace:: admin-vxlan

‎source/working_with_kayobe.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ Making a Kayobe Checkout
3737
A Kayobe checkout is made on the Ansible control host.
3838

3939
A Kayobe development environment can easily be set up using a script called
40-
``beokay``, for example. This command will need the ``KAYOBE_VAULT_PASSWORD``
41-
environment variable to be set when secrets are encrypted with Ansible Vault.
42-
See the next section for details.
40+
``beokay``, for example.
4341

4442
.. code-block:: console
4543
:substitutions:
@@ -51,7 +49,8 @@ See the next section for details.
5149
--kayobe-repo |kayobe_source_url| \
5250
--kayobe-branch |kayobe_source_version| \
5351
--kayobe-config-repo |kayobe_config_source_url| \
54-
--kayobe-config-branch |kayobe_config_source_version|
52+
--kayobe-config-branch |kayobe_config_source_version| \
53+
--vault-password-file |vault_password_file_path|
5554
5655
After making the checkout, source the virtualenv and Kayobe config environment variables:
5756

@@ -93,6 +92,13 @@ a command such as:
9392
9493
kayobe# export KAYOBE_VAULT_PASSWORD=$(cat |vault_password_file_path|)
9594
95+
Or using ``env-vars.sh`` created from ``beokay`` if you used it.
96+
97+
.. code-block:: console
98+
:substitutions:
99+
100+
kayobe# source |base_path|/env-vars.sh
101+
96102
Verifying Changes Before Applying
97103
---------------------------------
98104

@@ -182,7 +188,6 @@ To use a specific environment with Kayobe, make sure to source its environment
182188
variables:
183189

184190
.. code-block:: console
185-
:substitutions:
186191
187192
kayobe# source src/kayobe-config/kayobe-env --environment <env-name>
188193

0 commit comments

Comments
 (0)