From 92f00c448699448190af856618e7c77fa59deebe Mon Sep 17 00:00:00 2001
From: Dmitriy Rabotyagov <dmitriy.rabotyagov@cleura.com>
Date: Mon, 22 Apr 2024 19:17:33 +0200
Subject: [PATCH] Add documentation for ELK to the renderred docs

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

Change-Id: Icc5521a59e388ccf15f94e494de81ff4a385e90c
---
 doc/source/assets/Elastic-Stack-Diagram.svg             | 1 +
 doc/source/assets/Elastic-dataflow.svg                  | 1 +
 doc/source/assets/openstack-kibana-custom-dashboard.png | 1 +
 doc/source/elk_metrics.rst                              | 2 ++
 doc/source/index.rst                                    | 1 +
 elk_metrics_7x/README.rst                               | 8 +++-----
 6 files changed, 9 insertions(+), 5 deletions(-)
 create mode 120000 doc/source/assets/Elastic-Stack-Diagram.svg
 create mode 120000 doc/source/assets/Elastic-dataflow.svg
 create mode 120000 doc/source/assets/openstack-kibana-custom-dashboard.png
 create mode 100644 doc/source/elk_metrics.rst

diff --git a/doc/source/assets/Elastic-Stack-Diagram.svg b/doc/source/assets/Elastic-Stack-Diagram.svg
new file mode 120000
index 00000000..42851051
--- /dev/null
+++ b/doc/source/assets/Elastic-Stack-Diagram.svg
@@ -0,0 +1 @@
+../../../elk_metrics_7x/assets/Elastic-Stack-Diagram.svg
\ No newline at end of file
diff --git a/doc/source/assets/Elastic-dataflow.svg b/doc/source/assets/Elastic-dataflow.svg
new file mode 120000
index 00000000..777cd35d
--- /dev/null
+++ b/doc/source/assets/Elastic-dataflow.svg
@@ -0,0 +1 @@
+../../../elk_metrics_7x/assets/Elastic-dataflow.svg
\ No newline at end of file
diff --git a/doc/source/assets/openstack-kibana-custom-dashboard.png b/doc/source/assets/openstack-kibana-custom-dashboard.png
new file mode 120000
index 00000000..b1bcfaeb
--- /dev/null
+++ b/doc/source/assets/openstack-kibana-custom-dashboard.png
@@ -0,0 +1 @@
+../../../elk_metrics_7x/assets/openstack-kibana-custom-dashboard.png
\ No newline at end of file
diff --git a/doc/source/elk_metrics.rst b/doc/source/elk_metrics.rst
new file mode 100644
index 00000000..afc714a2
--- /dev/null
+++ b/doc/source/elk_metrics.rst
@@ -0,0 +1,2 @@
+
+.. include:: ../../elk_metrics_7x/README.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 39372a77..b0127dcb 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,6 +6,7 @@ OpenStack-Ansible Operator Tooling
    :maxdepth: 2
 
    swift_storage_mount_drives
+   elk_metrics
 
 OpenStack-Ansible Diff Generator
 --------------------------------
diff --git a/elk_metrics_7x/README.rst b/elk_metrics_7x/README.rst
index db32f2c7..0eb6b0f3 100644
--- a/elk_metrics_7x/README.rst
+++ b/elk_metrics_7x/README.rst
@@ -2,7 +2,6 @@ Install ELK with beats to gather metrics
 ########################################
 :tags: openstack, ansible
 
-..
 About this repository
 ---------------------
 
@@ -16,7 +15,6 @@ Highlevel overview of the Elastic-Stack infrastructure these playbooks will
 build and operate against.
 
 .. image:: assets/Elastic-Stack-Diagram.svg
-    :scale: 50 %
     :alt: Elasticsearch Architecture Diagram
     :align: center
 
@@ -347,7 +345,6 @@ Architecture | Data flow
 This diagram outlines the data flow from within an Elastic-Stack deployment.
 
 .. image:: assets/Elastic-dataflow.svg
-    :scale: 50 %
     :alt: Elastic-Stack Data Flow Diagram
     :align: center
 
@@ -355,7 +352,8 @@ Optional | Enable uwsgi stats
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 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
 
@@ -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
   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
-              - 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
   bytes.