mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-21 03:38:43 +00:00
Code Activity

pkg/apis/monitoring/v1: improve configSecret doc ()

Browse source 
Signed-off-by: Simon Pasquier <spasquie@redhat.com>

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
This commit is contained in:
Simon Pasquier 2022-10-12 22:00:23 +02:00 • committed by GitHub
parent 1e56bf14af
commit cb5b69b2e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 25 additions and 19 deletions
Documentation
api.md
bundle.yaml
example
prometheus-operator-crd-full
monitoring.coreos.com_alertmanagers.yaml
prometheus-operator-crd
monitoring.coreos.com_alertmanagers.yaml
jsonnet/prometheus-operator
alertmanagers-crd.json
pkg/apis/monitoring/v1
types.go

10
Documentation/api.md
View file

@ -231,9 +231,10 @@ Alertmanager object, which contains the configuration for this Alertmanager
instance. If empty, it defaults to <code>alertmanager-&lt;alertmanager-name&gt;</code>.</p>
<p>The Alertmanager configuration should be available under the
<code>alertmanager.yaml</code> key. Additional keys from the original secret are
copied to the generated secret.</p>
copied to the generated secret and mounted into the
<code>/etc/alertmanager/config</code> directory in the <code>alertmanager</code> container.</p>
<p>If either the secret or the <code>alertmanager.yaml</code> key is missing, the
operator provisions an Alertmanager configuration with one empty
operator provisions a minimal Alertmanager configuration with one empty
receiver (effectively dropping alert notifications).</p>
</td>
</tr>
@ -3971,9 +3972,10 @@ Alertmanager object, which contains the configuration for this Alertmanager
instance. If empty, it defaults to <code>alertmanager-&lt;alertmanager-name&gt;</code>.</p>
<p>The Alertmanager configuration should be available under the
<code>alertmanager.yaml</code> key. Additional keys from the original secret are
copied to the generated secret.</p>
copied to the generated secret and mounted into the
<code>/etc/alertmanager/config</code> directory in the <code>alertmanager</code> container.</p>
<p>If either the secret or the <code>alertmanager.yaml</code> key is missing, the
operator provisions an Alertmanager configuration with one empty
operator provisions a minimal Alertmanager configuration with one empty
receiver (effectively dropping alert notifications).</p>
</td>
</tr>

9
bundle.yaml
View file

@ -5904,10 +5904,11 @@ spec:
for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`.
\n The Alertmanager configuration should be available under the
`alertmanager.yaml` key. Additional keys from the original secret
are copied to the generated secret. \n If either the secret or the
`alertmanager.yaml` key is missing, the operator provisions an Alertmanager
configuration with one empty receiver (effectively dropping alert
notifications)."
are copied to the generated secret and mounted into the `/etc/alertmanager/config`
directory in the `alertmanager` container. \n If either the secret
or the `alertmanager.yaml` key is missing, the operator provisions
a minimal Alertmanager configuration with one empty receiver (effectively
dropping alert notifications)."
type: string
containers:
description: 'Containers allows injecting additional containers. This

9
example/prometheus-operator-crd-full/monitoring.coreos.com_alertmanagers.yaml
View file

@ -1429,10 +1429,11 @@ spec:
for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`.
\n The Alertmanager configuration should be available under the
`alertmanager.yaml` key. Additional keys from the original secret
are copied to the generated secret. \n If either the secret or the
`alertmanager.yaml` key is missing, the operator provisions an Alertmanager
configuration with one empty receiver (effectively dropping alert
notifications)."
are copied to the generated secret and mounted into the `/etc/alertmanager/config`
directory in the `alertmanager` container. \n If either the secret
or the `alertmanager.yaml` key is missing, the operator provisions
a minimal Alertmanager configuration with one empty receiver (effectively
dropping alert notifications)."
type: string
containers:
description: 'Containers allows injecting additional containers. This

9
example/prometheus-operator-crd/monitoring.coreos.com_alertmanagers.yaml
View file

@ -1429,10 +1429,11 @@ spec:
for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`.
\n The Alertmanager configuration should be available under the
`alertmanager.yaml` key. Additional keys from the original secret
are copied to the generated secret. \n If either the secret or the
`alertmanager.yaml` key is missing, the operator provisions an Alertmanager
configuration with one empty receiver (effectively dropping alert
notifications)."
are copied to the generated secret and mounted into the `/etc/alertmanager/config`
directory in the `alertmanager` container. \n If either the secret
or the `alertmanager.yaml` key is missing, the operator provisions
a minimal Alertmanager configuration with one empty receiver (effectively
dropping alert notifications)."
type: string
containers:
description: 'Containers allows injecting additional containers. This

2
jsonnet/prometheus-operator/alertmanagers-crd.json
View file

@ -1283,7 +1283,7 @@
"type": "array"
},
"configSecret": {
"description": "ConfigSecret is the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains the configuration for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`. \n The Alertmanager configuration should be available under the `alertmanager.yaml` key. Additional keys from the original secret are copied to the generated secret. \n If either the secret or the `alertmanager.yaml` key is missing, the operator provisions an Alertmanager configuration with one empty receiver (effectively dropping alert notifications).",
"description": "ConfigSecret is the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains the configuration for this Alertmanager instance. If empty, it defaults to `alertmanager-<alertmanager-name>`. \n The Alertmanager configuration should be available under the `alertmanager.yaml` key. Additional keys from the original secret are copied to the generated secret and mounted into the `/etc/alertmanager/config` directory in the `alertmanager` container. \n If either the secret or the `alertmanager.yaml` key is missing, the operator provisions a minimal Alertmanager configuration with one empty receiver (effectively dropping alert notifications).",
"type": "string"
},
"containers": {

5
pkg/apis/monitoring/v1/types.go
View file

@ -1903,10 +1903,11 @@ type AlertmanagerSpec struct {
//
// The Alertmanager configuration should be available under the
// `alertmanager.yaml` key. Additional keys from the original secret are
// copied to the generated secret.
// copied to the generated secret and mounted into the
// `/etc/alertmanager/config` directory in the `alertmanager` container.
//
// If either the secret or the `alertmanager.yaml` key is missing, the
// operator provisions an Alertmanager configuration with one empty
// operator provisions a minimal Alertmanager configuration with one empty
// receiver (effectively dropping alert notifications).
ConfigSecret string `json:"configSecret,omitempty"`
// Log level for Alertmanager to be configured with.