(DOCSP-21446): Added Prometheus settings to MongoDB CRD reference. (#902)

* (DOCSP-21446): Added Prometheus settings to MongoDB CRD reference.

* (DOCSP-21446): Incorporated JW's feedback.

Author: corryroot

source/reference/k8s-operator-specification.txt

@@ -200,6 +200,119 @@ The following settings apply only to sharded cluster resource types:
 .. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.podTemplate.metadata.rst
 .. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.podTemplate.spec.rst
 
+.. _prometheus-settings:
+
+Prometheus Settings
+-------------------
+
+You can use Prometheus with your standalone resource, replica sets, or 
+sharded clusters. The following settings apply when you use Prometheus 
+with your MongoDB resource:
+
+.. setting:: spec.prometheus
+
+   *Type*: array
+
+   *Optional*
+
+   List that contains the parameters for exposing metrics to Prometheus.
+
+.. setting:: spec.prometheus.metricsPath
+
+   *Type*: string
+
+   *Optional*
+
+   *Default*: ``"/metrics"``
+
+   Human-readable string that indicates the path to the metrics 
+   endpoint. If you don't specify this setting, the default applies.
+
+.. setting:: spec.prometheus.passwordSecretRef
+
+   *Type*: object
+
+   *Conditional*
+
+   Object that contains the details of the |k8s-secret| for 
+   basic HTTP authentication. If you want to use Prometheus with your 
+   MongoDB resource, you must specify this setting.
+
+.. setting:: spec.prometheus.passwordSecretRef.key
+
+   *Type*: string
+
+   *Optional*
+
+   *Default*: ``"password"``
+
+   Human-readable string that indentifies the key in the |k8s-secret| 
+   that stores the password for basic HTTP authentication. If you don't 
+   specify this setting, the default applies.
+
+.. setting:: spec.prometheus.passwordSecretRef.name
+
+   *Type*: string
+
+   *Conditional*
+
+   Human-readable label that identifies the |k8s-secret| that contains 
+   the password for basic HTTP authentication. If you want to use 
+   Prometheus with your MongoDB resource, you must specify this setting.
+
+.. setting:: spec.prometheus.port
+
+   *Type*: integer
+
+   *Optional*
+
+   *Default:* 9216
+
+   Number that identifies the port that the metrics endpoint will 
+   bind to. If you don't specify this setting, the default applies.
+
+.. setting:: spec.prometheus.tlseSecretKeyRef
+
+   *Type*: object
+
+   *Optional*
+
+   Object that contains the details of the |k8s-secret| for |tls| 
+   authentication.
+
+.. setting:: spec.prometheus.tlseSecretKeyRef.key
+
+   *Type*: string
+
+   *Optional*
+
+   *Default*: ``"password"``
+
+   Human-readable string that indentifies the key in the |k8s-secret| 
+   that stores the password for |tls| authentication. If you don't 
+   specify this setting, the default applies.
+
+.. setting:: spec.prometheus.tlseSecretKeyRef.name
+
+   *Type*: string
+
+   *Conditional*
+
+   Human-readable label that identifies the |k8s-secret| that contains 
+   the password for |tls| authentication. If you want to use 
+   Prometheus with your MongoDB resource and you want to use |tls| 
+   authentication, you must specify this setting.
+
+.. setting:: spec.prometheus.username
+
+   *Type*: string
+
+   *Conditional*
+
+   Human-readable label that identifies the user for basic HTTP 
+   authentication. If you want to use Prometheus with your MongoDB 
+   resource, you must specify this setting.
+
 .. _tls-settings:
 .. _security-settings: