Skip to content

Commit f8087e0

Browse files
Merge pull request #447 from openshift/docs
docs: update cluster_installer description
2 parents 02e9c50 + 1c067e7 commit f8087e0

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/dev/metrics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The cluster version is reported as seconds since the epoch with labels for `vers
77

88
* `current` - the version the operator is applying right now (the running CVO version) and the age of the payload
99
* `initial` - the initial version of the cluster, and value is the creation timestamp of the cluster version (cluster age)
10-
* `cluster` - the current version of the cluster with from_version set to the initial version, and value is the creation timestamp of the cluster version (cluster age)
10+
* `cluster` - the current version of the cluster with `from_version` set to the initial version, and value is the creation timestamp of the cluster version (cluster age)
1111
* `failure` - if the failure condition is set, reports the last transition time for the condition.
1212
* `desired` - reported if different from current as the most recent timestamp on the cluster version
1313
* `completed` - the time the most recent version was completely applied, or absent if not reached
@@ -59,10 +59,10 @@ cluster_operator_payload_errors{version="4.0.3"} 10
5959

6060
Metrics about the installation:
6161

62-
`cluster_installer` records information about the installation process. The type is either "openshift-install", indicating that `openshift-install` was used to install the cluster (IPI) or "", indicating that an unknown process installed the cluster (UPI). When `openshift-install` creates a cluster, it will also report its version and invoker. The version is helpful for determining exactly which builds are being used to install (e.g. were they official builds or had they been modified). The invoker is "user" by default, but it may be overridden by a consuming tool (e.g. Hive, CI).
62+
`cluster_installer` records information about the installation process. The type is either "openshift-install", indicating that `openshift-install` was used to install the cluster (IPI) or "other", indicating that an unknown process installed the cluster (UPI). When `openshift-install` creates a cluster, it will also report its version and invoker. When an unknown process installed the cluster, the version and invoker reported will be that of the `openshift-install` invocation which created the manifests. The version is helpful for determining exactly which builds are being used to install (e.g. were they official builds or had they been modified). The invoker is "user" by default, but it may be overridden by a consuming tool (e.g. Hive, CI, Assisted Installer).
6363

6464
```
6565
# TYPE cluster_installer gauge
6666
cluster_installer{type="openshift-install",invoker="user",version="unreleased-master-1209-gfd08f44181f2111486749e2fb38399088f315cfb"} 1
67-
cluster_installer{type="",invoker="",version=""} 1
67+
cluster_installer{type="other",invoker="user",version="unreleased-master-1209-gfd08f44181f2111486749e2fb38399088f315cfb"} 1
6868
```

pkg/cvo/metrics.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ version for 'cluster', or empty for 'initial'.
9191
}, []string{"name", "condition"}),
9292
clusterInstaller: prometheus.NewGaugeVec(prometheus.GaugeOpts{
9393
Name: "cluster_installer",
94-
Help: "Reports info about the installation process and, if applicable, the install tool.",
94+
Help: "Reports info about the installation process and, if applicable, the install tool. The type is either 'openshift-install', indicating that openshift-install was used to install the cluster, or 'other', indicating that an unknown process installed the cluster. The invoker is 'user' by default, but it may be overridden by a consuming tool. The version reported is that of the openshift-install that was used to generate the manifests and, if applicable, provision the infrastructure.",
9595
}, []string{"type", "version", "invoker"}),
9696
clusterVersionOperatorUpdateRetrievalTimestampSeconds: prometheus.NewGaugeVec(prometheus.GaugeOpts{
9797
Name: "cluster_version_operator_update_retrieval_timestamp_seconds",

0 commit comments

Comments
 (0)