openstack/openstack-ansible-ops
Code Issues Proposed changes

Add documentation for ELK to the renderred docs

Browse Source 
This includes docs for ELK setup to our renderred docs of the OPS repo
It should make them better readable/searchable.

Change-Id: Icc5521a59e388ccf15f94e494de81ff4a385e90c
This commit is contained in:
Dmitriy Rabotyagov 2024-04-22 19:17:33 +02:00
parent 67e30b08ca
commit 92f00c4486
6 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/assets/Elastic-Stack-Diagram.svg Symbolic link
View File

@ -0,0 +1 @@
../../../elk_metrics_7x/assets/Elastic-Stack-Diagram.svg

1
doc/source/assets/Elastic-dataflow.svg Symbolic link
View File

@ -0,0 +1 @@
../../../elk_metrics_7x/assets/Elastic-dataflow.svg

1
doc/source/assets/openstack-kibana-custom-dashboard.png Symbolic link
View File

@ -0,0 +1 @@
../../../elk_metrics_7x/assets/openstack-kibana-custom-dashboard.png

2
doc/source/elk_metrics.rst Normal file
View File

@ -0,0 +1,2 @@
.. include:: ../../elk_metrics_7x/README.rst

1
doc/source/index.rst
View File

@ -6,6 +6,7 @@ OpenStack-Ansible Operator Tooling
:maxdepth: 2 :maxdepth: 2
swift_storage_mount_drives swift_storage_mount_drives
elk_metrics
OpenStack-Ansible Diff Generator OpenStack-Ansible Diff Generator
-------------------------------- --------------------------------

8
elk_metrics_7x/README.rst
View File

@ -2,7 +2,6 @@ Install ELK with beats to gather metrics
######################################## ########################################
:tags: openstack, ansible :tags: openstack, ansible
..
About this repository About this repository
--------------------- ---------------------
@ -16,7 +15,6 @@ Highlevel overview of the Elastic-Stack infrastructure these playbooks will
build and operate against. build and operate against.
.. image:: assets/Elastic-Stack-Diagram.svg .. image:: assets/Elastic-Stack-Diagram.svg
:scale: 50 %
:alt: Elasticsearch Architecture Diagram :alt: Elasticsearch Architecture Diagram
:align: center :align: center
@ -347,7 +345,6 @@ Architecture | Data flow
This diagram outlines the data flow from within an Elastic-Stack deployment. This diagram outlines the data flow from within an Elastic-Stack deployment.
.. image:: assets/Elastic-dataflow.svg .. image:: assets/Elastic-dataflow.svg
:scale: 50 %
:alt: Elastic-Stack Data Flow Diagram :alt: Elastic-Stack Data Flow Diagram
:align: center :align: center
@ -355,7 +352,8 @@ Optional | Enable uwsgi stats
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Config overrides can be used to make uwsgi stats available on unix Config overrides can be used to make uwsgi stats available on unix
domain sockets. Any /tmp/*uwsgi-stats.sock will be picked up by Metricsbeat. domain sockets. Any /tmp/<service>-uwsgi-stats.sock will be picked up by
Metricsbeat.
.. code-block:: yaml .. code-block:: yaml
@ -702,7 +700,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/7.17/security-minimal-se
kibana_setup - any user which is assigned the built in kibana_admin role kibana_setup - any user which is assigned the built in kibana_admin role
logstash_internal - see https://www.elastic.co/guide/en/logstash/7.17/ls-security.html#ls-http-auth-basic logstash_internal - see https://www.elastic.co/guide/en/logstash/7.17/ls-security.html#ls-http-auth-basic
beats_setup - see setup role at https://www.elastic.co/guide/en/beats/filebeat/7.17/feature-roles.html beats_setup - see setup role at https://www.elastic.co/guide/en/beats/filebeat/7.17/feature-roles.html
- this user must also be assigned the built in ingest_admin role - this user must also be assigned the built in ingest_admin role
* Set 'kibana_object_encryption_key' to a string with a minimum length of 32 * Set 'kibana_object_encryption_key' to a string with a minimum length of 32
bytes. bytes.