Skip to content

[enterprise-4.20] OBSDOCS-2224a: fix oc CLI attribute #97106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To list alerting rules for a user-defined project, you must have been assigned t

* You have enabled monitoring for user-defined projects.
* You are logged in as a user that has the `monitoring-rules-view` cluster role for your project.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have created the secret to be configured in Alertmanager in the `{namespace-name}` project.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists in the `openshift-user-workload-monitoring` namespace. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To choose a metrics collection profile for core {product-title} monitoring compo

.Prerequisites

* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have created the `cluster-monitoring-config` `ConfigMap` object.
* You have access to the cluster as a user with the `cluster-admin` cluster role.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* Alert routing has been enabled for user-defined projects.
endif::openshift-dedicated,openshift-rosa[]
* You are logged in as a user that has the `alert-routing-edit` cluster role for the project for which you want to create alert routing.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-rosa,openshift-dedicated[]
* You have access to the cluster as a user with the `dedicated-admin` role.
endif::[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-configuring-external-alertmanagers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-configuring-remote-write-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have set up a remote write compatible endpoint (such as Thanos) and know the endpoint URL. See the link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Prometheus remote endpoints and storage documentation] for information about endpoints that are compatible with the remote write feature.
+
[IMPORTANT]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To help users understand the impact and cause of the alert, ensure that your ale

* You have enabled monitoring for user-defined projects.
* You are logged in as a cluster administrator or as a user that has the `monitoring-rules-edit` cluster role for the project where you want to create an alerting rule.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` ConfigMap object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have configured remote write storage.
.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can configure the core {product-title} monitoring components by creating and
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you are a non-administrator user, you can still create cross-project alerting
====
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-creating-new-alerting-rules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ These alerting rules trigger alerts based on the values of chosen metrics.
.Prerequisites

* You have access to the cluster as a user that has the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-creating-scrape-sample-alerts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can create alerts that notify you when:
* You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project.
* A cluster administrator has enabled monitoring for user-defined projects.
* You have limited the number of samples that can be accepted per target scrape in user-defined projects, by using `enforcedSampleLimit`.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can configure the user workload monitoring components with the `user-workloa
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role.
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role.
endif::openshift-dedicated,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-disabling-the-local-alertmanager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you do not need the local Alertmanager, you can disable it by configuring the

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have created the `cluster-monitoring-config` config map.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You must have access to the cluster as a user with the `cluster-admin` cluster r
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have created the `cluster-monitoring-config` `ConfigMap` object.
* You have optionally created and configured the `user-workload-monitoring-config` `ConfigMap` object in the `openshift-user-workload-monitoring` project. You can add configuration options to this `ConfigMap` object for the components that monitor user-defined projects.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Because log rotation is not supported, only enable this feature temporarily when

.Prerequisites

* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have created the `cluster-monitoring-config` `ConfigMap` object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can allow users to create user-defined alert routing configurations that use

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* A cluster administrator has enabled monitoring for user-defined projects.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ifndef::openshift-rosa,openshift-dedicated[]
* You have enabled monitoring for user-defined projects.
endif::[]
* The user account that you are assigning the role to already exists.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ As a cluster administrator, you can assign the `user-workload-monitoring-config-

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* The user account that you are assigning the role to already exists.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-installation-progress.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can monitor high-level installation, bootstrap, and control plane logs as an
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have SSH access to your hosts.
* You have the fully qualified domain names of the bootstrap and control plane nodes.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ endif::[]
ifndef::openshift-rosa,openshift-dedicated[]
* You have access to the cluster as a user with the `cluster-admin` role.
endif::[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For example, you can change the severity label of an alert, add a custom label,
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role.
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ It is not permitted to move components to control plane or infrastructure nodes.
// tag::CPM[]
* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have created the `cluster-monitoring-config` `ConfigMap` object.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
// end::CPM[]

// tag::UWM[]
Expand All @@ -51,7 +51,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role.
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
// end::UWM[]

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you need to forward large amounts of data outside the cluster, use remote wri

.Prerequisites

* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have access to the cluster as a user with the `cluster-monitoring-view` cluster role or have obtained a bearer token with `get` permission on the `namespaces` resource.
+
[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role or with view permissions for all projects.
endif::openshift-dedicated,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can remove alerting rules for user-defined projects.

* You have enabled monitoring for user-defined projects.
* You are logged in as a cluster administrator or as a user that has the `monitoring-rules-edit` cluster role for the project where you want to create an alerting rule.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/monitoring-resizing-a-persistent-volume.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can only expand the size of the PVC. Shrinking the storage size is not possi
* A cluster administrator has enabled monitoring for user-defined projects.
* You have configured at least one PVC for components that monitor user-defined projects.
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role.
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In default platform monitoring, you can configure the audit log level for the Pr

.Prerequisites

* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have created the `cluster-monitoring-config` `ConfigMap` object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
* You have access to the cluster as a user with the `dedicated-admin` role.
* The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created.
endif::openshift-dedicated,openshift-rosa[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Prometheus then considers this target to be down and sets its `up` metric value
.Prerequisites

* You have access to the cluster as a user with the `cluster-admin` cluster role.
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.
.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To configure CPU and memory resources, specify values for resource limits and re
// tag::UWM[]
* You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project.
// end::UWM[]
* You have installed the OpenShift CLI (`oc`).
* You have installed the {oc-first}.

.Procedure

Expand Down