openstack
/
magnum
Code Issues Proposed changes

Fix docs 

Change-Id: Ie25c2748eb2acb6f1ad6bf019a10562628a51010
This commit is contained in:
Piotr Parczewski 2022-01-20 16:01:45 +01:00
parent fa298eeab1
commit a9b9ba2361
3 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/index.rst
View File

@ -53,12 +53,20 @@ Features
* Integration with Neutron for Kubernetes multi-tenancy network security
* Integration with Cinder to provide volume service for containers
Installation Guide
==================
.. toctree::
:maxdepth: 1
install/index
User Documentation
==================
.. toctree::
:maxdepth: 1
user/index
user/monitoring.rst
user/glossary.rst
Contributor Guide
@ -75,13 +83,6 @@ Admin Guide
admin/index
Installation Guide
==================
.. toctree::
:maxdepth: 1
install/index
CLI Guide
=========
.. toctree::

33
doc/source/user/index.rst
View File

@ -312,37 +312,37 @@ the table are linked to more details elsewhere in the user guide.
| `heapster_enabled`_ | - true | false |
| | - false | |
+---------------------------------------+--------------------+---------------+
| `metrics_server_chart_tag`_ | see below | see below |
| :ref:`metrics_server_chart_tag` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `metrics_server_enabled`_ | - true | true |
| :ref:`metrics_server_enabled` | - true | true |
| | - false | |
+---------------------------------------+--------------------+---------------+
| `monitoring_enabled`_ | - true | false |
| :ref:`monitoring_enabled` | - true | false |
| | - false | |
+---------------------------------------+--------------------+---------------+
| `monitoring_retention_days`_ | see below | see below |
| :ref:`monitoring_retention_days` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `monitoring_retention_size`_ | see below | see below |
| :ref:`monitoring_retention_size` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `monitoring_storage_class_name`_ | see below | see below |
| :ref:`monitoring_storage_class_name` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `monitoring_interval_seconds`_ | see below | see below |
| :ref:`monitoring_interval_seconds` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `monitoring_ingress_enabled`_ | - true | false |
| :ref:`monitoring_ingress_enabled` | - true | false |
| | - false | |
+---------------------------------------+--------------------+---------------+
| `cluster_basic_auth_secret`_ | see below | see below |
| :ref:`cluster_basic_auth_secret` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `cluster_root_domain_name`_ | see below | see below |
| :ref:`cluster_root_domain_name` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `prometheus_operator_chart_tag`_ | see below | see below |
| :ref:`prometheus_operator_chart_tag` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `prometheus_adapter_enabled`_ | - true | true |
| :ref:`prometheus_adapter_enabled` | - true | true |
| | - false | |
+---------------------------------------+--------------------+---------------+
| `prometheus_adapter_chart_tag`_ | see below | see below |
| :ref:`prometheus_adapter_chart_tag` | see below | see below |
+---------------------------------------+--------------------+---------------+
| `prometheus_adapter_configmap`_ | (rules CM name) | "" |
| :ref:`prometheus_adapter_configmap` | (rules CM name) | "" |
+---------------------------------------+--------------------+---------------+
| `swarm_strategy`_ | - spread | spread |
| | - binpack | |
@ -355,7 +355,7 @@ the table are linked to more details elsewhere in the user guide.
| `prometheus_monitoring` (deprecated) | - true | false |
| | - false | |
+---------------------------------------+--------------------+---------------+
| `grafana_admin_passwd`_ | (any string) | "admin" |
| :ref:`grafana_admin_passwd` | (any string) | "admin" |
+---------------------------------------+--------------------+---------------+
| `hyperkube_prefix`_ | see below | see below |
+---------------------------------------+--------------------+---------------+
@ -3453,7 +3453,8 @@ created. This example can be applied for any ``create``, ``update`` or
Container Monitoring
====================
.. include:: monitoring.rst
As of this moment, monitoring is only supported for Kubernetes clusters.
For details, please refer to the :ref:`monitoring` document.
Kubernetes Post Install Manifest
================================

2
doc/source/user/monitoring.rst
View File

@ -1,4 +1,4 @@
As of this moment, monitoring is only supported for kubernetes clusters.
.. _monitoring:
Container Monitoring in Kubernetes
----------------------------------