Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update admin guide for Antelope release #52

Merged
merged 2 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/hardware_inventory_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ We can then provision and configure them:
:substitutions:

kayobe# kayobe overcloud provision --limit |hypervisor_hostname|
kayobe# kayobe overcloud host configure --limit |hypervisor_hostname| --kolla-limit |hypervisor_hostname|
kayobe# kayobe overcloud host configure --limit |hypervisor_hostname|
kayobe# kayobe overcloud service deploy --limit |hypervisor_hostname| --kolla-limit |hypervisor_hostname|

Replacing a Failing Hypervisor
Expand Down
2 changes: 1 addition & 1 deletion source/include/ceph_ansible.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Apply LVM configuration using Kayobe for the replaced device (here on ``storage-

.. code-block:: console

kayobe$ kayobe overcloud host configure -t lvm -kt none -l storage-0 -kl storage-0
kayobe$ kayobe overcloud host configure -t lvm -l storage-0

Before running Ceph-Ansible, also remove vestigial state directory
from ``/var/lib/ceph/osd`` for the purged OSD
Expand Down
44 changes: 21 additions & 23 deletions source/operations_and_monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@
Operations and Monitoring
=========================

Access to Kibana
================
Access to OpenSearch Dashboards
===============================

OpenStack control plane logs are aggregated from all servers by Fluentd and
stored in ElasticSearch. The control plane logs can be accessed from
ElasticSearch using Kibana, which is available at the following URL:
|kibana_url|
stored in OpenSearch. The control plane logs can be accessed from
OpenSearch using OpenSearch Dashboards, which is available at the following URL:
|opensearch_dashboards_url|

To log in, use the ``kibana`` user. The password is auto-generated by
To log in, use the ``opensearch`` user. The password is auto-generated by
Kolla-Ansible and can be extracted from the encrypted passwords file
(|kolla_passwords|):

.. code-block:: console
:substitutions:

kayobe# ansible-vault view ${KAYOBE_CONFIG_PATH}/kolla/passwords.yml --vault-password-file |vault_password_file_path| | grep ^kibana
kayobe# ansible-vault view ${KAYOBE_CONFIG_PATH}/kolla/passwords.yml --vault-password-file |vault_password_file_path| | grep ^opensearch_dashboards

Access to Grafana
=================
Expand Down Expand Up @@ -293,7 +293,7 @@ Monitoring
----------

* `Back up InfluxDB <https://docs.influxdata.com/influxdb/v1.8/administration/backup_and_restore/>`__
* `Back up ElasticSearch <https://www.elastic.co/guide/en/elasticsearch/reference/current/backup-cluster-data.html>`__
* `Back up OpenSearch <https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/>`__
* `Back up Prometheus <https://prometheus.io/docs/prometheus/latest/querying/api/#snapshot>`__

Seed
Expand All @@ -309,8 +309,8 @@ Ansible control host
Control Plane Monitoring
========================

The control plane has been configured to collect logs centrally using the EFK
stack (Elasticsearch, Fluentd and Kibana).
The control plane has been configured to collect logs centrally using the FOOD
stack (Fluentd, OpenSearch and OpenSearch Dashboards).

Telemetry monitoring of the control plane is performed by Prometheus. Metrics
are collected by Prometheus exporters, which are either running on all hosts
Expand Down Expand Up @@ -508,7 +508,8 @@ Overview
* Remove the node from maintenance mode in bifrost
* Bifrost should automatically power on the node via IPMI
* Check that all docker containers are running
* Check Kibana for any messages with log level ERROR or equivalent
* Check OpenSearch Dashboards for any messages with log level ERROR or
equivalent

Controllers
-----------
Expand Down Expand Up @@ -647,28 +648,25 @@ perform the following cleanup procedure regularly:
fi
done

Elasticsearch indexes retention
OpenSearch indexes retention
===============================

To enable and alter default rotation values for Elasticsearch Curator, edit
To alter default rotation values for OpenSearch, edit
``${KAYOBE_CONFIG_PATH}/kolla/globals.yml``:

.. code-block:: console

# Allow Elasticsearch Curator to apply a retention policy to logs
enable_elasticsearch_curator: true

# Duration after which index is closed
elasticsearch_curator_soft_retention_period_days: 90
# Duration after which index is closed (default 30)
opensearch_soft_retention_period_days: 90

# Duration after which index is deleted
elasticsearch_curator_hard_retention_period_days: 180
# Duration after which index is deleted (default 60)
opensearch_hard_retention_period_days: 180

Reconfigure Elasticsearch with new values:
Reconfigure Opensearch with new values:

.. code-block:: console

kayobe overcloud service reconfigure --kolla-tags elasticsearch
kayobe overcloud service reconfigure --kolla-tags opensearch

For more information see the `upstream documentation
<https://docs.openstack.org/kolla-ansible/latest/reference/logging-and-monitoring/central-logging-guide.html#curator>`__.
<https://docs.openstack.org/kolla-ansible/latest/reference/logging-and-monitoring/central-logging-guide.html#applying-log-retention-policies>`__.
2 changes: 1 addition & 1 deletion source/vars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
.. |kayobe_source_url| replace:: https://github.com/acme-openstack/kayobe.git
.. |kayobe_source_version| replace:: ``acme/yoga``
.. |keystone_public_url| replace:: https://openstack.acme.example:5000
.. |kibana_url| replace:: https://openstack.acme.example:5601
.. |opensearch_dashboards_url| replace:: https://openstack.acme.example:5601
.. |kolla_passwords| replace:: https://github.com/acme-openstack/kayobe-config/blob/acme/yoga/etc/kayobe/kolla/passwords.yml
.. |monitoring_host| replace:: ``mon0``
.. |network_name| replace:: admin-vxlan
Expand Down
Loading