Skip to content

Commit a9b9ba2

Browse files
committed
Fix docs
Change-Id: Ie25c2748eb2acb6f1ad6bf019a10562628a51010
1 parent fa298ee commit a9b9ba2

File tree

3 files changed

+26
-24
lines changed

3 files changed

+26
-24
lines changed

doc/source/index.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,20 @@ Features
5353
* Integration with Neutron for Kubernetes multi-tenancy network security
5454
* Integration with Cinder to provide volume service for containers
5555

56+
Installation Guide
57+
==================
58+
.. toctree::
59+
:maxdepth: 1
60+
61+
install/index
62+
5663
User Documentation
5764
==================
5865
.. toctree::
5966
:maxdepth: 1
6067

6168
user/index
69+
user/monitoring.rst
6270
user/glossary.rst
6371

6472
Contributor Guide
@@ -75,13 +83,6 @@ Admin Guide
7583

7684
admin/index
7785

78-
Installation Guide
79-
==================
80-
.. toctree::
81-
:maxdepth: 1
82-
83-
install/index
84-
8586
CLI Guide
8687
=========
8788
.. toctree::

doc/source/user/index.rst

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -312,37 +312,37 @@ the table are linked to more details elsewhere in the user guide.
312312
| `heapster_enabled`_ | - true | false |
313313
| | - false | |
314314
+---------------------------------------+--------------------+---------------+
315-
| `metrics_server_chart_tag`_ | see below | see below |
315+
| :ref:`metrics_server_chart_tag` | see below | see below |
316316
+---------------------------------------+--------------------+---------------+
317-
| `metrics_server_enabled`_ | - true | true |
317+
| :ref:`metrics_server_enabled` | - true | true |
318318
| | - false | |
319319
+---------------------------------------+--------------------+---------------+
320-
| `monitoring_enabled`_ | - true | false |
320+
| :ref:`monitoring_enabled` | - true | false |
321321
| | - false | |
322322
+---------------------------------------+--------------------+---------------+
323-
| `monitoring_retention_days`_ | see below | see below |
323+
| :ref:`monitoring_retention_days` | see below | see below |
324324
+---------------------------------------+--------------------+---------------+
325-
| `monitoring_retention_size`_ | see below | see below |
325+
| :ref:`monitoring_retention_size` | see below | see below |
326326
+---------------------------------------+--------------------+---------------+
327-
| `monitoring_storage_class_name`_ | see below | see below |
327+
| :ref:`monitoring_storage_class_name` | see below | see below |
328328
+---------------------------------------+--------------------+---------------+
329-
| `monitoring_interval_seconds`_ | see below | see below |
329+
| :ref:`monitoring_interval_seconds` | see below | see below |
330330
+---------------------------------------+--------------------+---------------+
331-
| `monitoring_ingress_enabled`_ | - true | false |
331+
| :ref:`monitoring_ingress_enabled` | - true | false |
332332
| | - false | |
333333
+---------------------------------------+--------------------+---------------+
334-
| `cluster_basic_auth_secret`_ | see below | see below |
334+
| :ref:`cluster_basic_auth_secret` | see below | see below |
335335
+---------------------------------------+--------------------+---------------+
336-
| `cluster_root_domain_name`_ | see below | see below |
336+
| :ref:`cluster_root_domain_name` | see below | see below |
337337
+---------------------------------------+--------------------+---------------+
338-
| `prometheus_operator_chart_tag`_ | see below | see below |
338+
| :ref:`prometheus_operator_chart_tag` | see below | see below |
339339
+---------------------------------------+--------------------+---------------+
340-
| `prometheus_adapter_enabled`_ | - true | true |
340+
| :ref:`prometheus_adapter_enabled` | - true | true |
341341
| | - false | |
342342
+---------------------------------------+--------------------+---------------+
343-
| `prometheus_adapter_chart_tag`_ | see below | see below |
343+
| :ref:`prometheus_adapter_chart_tag` | see below | see below |
344344
+---------------------------------------+--------------------+---------------+
345-
| `prometheus_adapter_configmap`_ | (rules CM name) | "" |
345+
| :ref:`prometheus_adapter_configmap` | (rules CM name) | "" |
346346
+---------------------------------------+--------------------+---------------+
347347
| `swarm_strategy`_ | - spread | spread |
348348
| | - binpack | |
@@ -355,7 +355,7 @@ the table are linked to more details elsewhere in the user guide.
355355
| `prometheus_monitoring` (deprecated) | - true | false |
356356
| | - false | |
357357
+---------------------------------------+--------------------+---------------+
358-
| `grafana_admin_passwd`_ | (any string) | "admin" |
358+
| :ref:`grafana_admin_passwd` | (any string) | "admin" |
359359
+---------------------------------------+--------------------+---------------+
360360
| `hyperkube_prefix`_ | see below | see below |
361361
+---------------------------------------+--------------------+---------------+
@@ -3453,7 +3453,8 @@ created. This example can be applied for any ``create``, ``update`` or
34533453
Container Monitoring
34543454
====================
34553455

3456-
.. include:: monitoring.rst
3456+
As of this moment, monitoring is only supported for Kubernetes clusters.
3457+
For details, please refer to the :ref:`monitoring` document.
34573458

34583459
Kubernetes Post Install Manifest
34593460
================================

doc/source/user/monitoring.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
As of this moment, monitoring is only supported for kubernetes clusters.
1+
.. _monitoring:
22

33
Container Monitoring in Kubernetes
44
----------------------------------

0 commit comments

Comments
 (0)