1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSD Restructure

This commit is contained in:
Eric Ponvelle
2022-05-06 17:06:53 -04:00
committed by openshift-cherrypick-robot
parent 23e9961de3
commit 4fb4739fab
86 changed files with 870 additions and 208 deletions

View File

@@ -32,16 +32,40 @@ Topics:
File: legal-notice
Distros: openshift-dedicated
---
Name: Architecture
Name: Introduction to OpenShift Dedicated
Dir: osd_architecture
Distros: openshift-dedicated
Topics:
- Name: Introduction to OpenShift Dedicated
- Name: Understanding OpenShift Dedicated
File: osd-understanding
- Name: Architecture concepts
File: osd-architecture
- Name: Policies and service definition
Dir: osd_policy
Distros: openshift-dedicated
Topics:
- Name: OpenShift Dedicated service definition
File: osd-service-definition
- Name: Responsibility assignment matrix
File: policy-responsibility-matrix
- Name: Understanding process and security for OpenShift Dedicated
File: policy-process-security
- Name: About availability for OpenShift Dedicated
File: policy-understand-availability
- Name: Update life cycle
File: osd-life-cycle
- Name: Support for OpenShift Dedicated
File: osd-support
Distros: openshift-dedicated
---
Name: Planning
Name: Red Hat OpenShift Cluster Manager
Dir: ocm
Distros: openshift-dedicated
Topics:
- Name: Red Hat OpenShift Cluster Manager
File: ocm-overview
---
Name: Planning your environment
Dir: osd_planning
Distros: openshift-dedicated
Topics:
@@ -51,45 +75,71 @@ Topics:
File: gcp-ccs
---
Name: Getting started
Dir: osd_quickstart
Distros: openshift-dedicated
Topics:
- Name: Getting started with OpenShift Dedicated
File: osd-quickstart
---
Name: Red Hat OpenShift Cluster Manager
Dir: ocm
Distros: openshift-dedicated
Topics:
- Name: Red Hat OpenShift Cluster Manager
File: ocm-overview
---
Name: Creating a cluster
Dir: osd_cluster_create
Dir: osd_getting_started
Distros: openshift-dedicated
Topics:
- Name: Understanding your cloud deployment options
File: osd-understanding-your-cloud-deployment-options
- Name: Getting started with OpenShift Dedicated
File: osd-getting-started
---
Name: Installing, accessing, and deleting OpenShift Dedicated clusters
Dir: osd_install_access_delete_cluster
Distros: openshift-dedicated
Topics:
- Name: Creating a cluster on AWS
File: creating-an-aws-cluster
- Name: Creating a cluster on GCP
File: creating-a-gcp-cluster
---
Name: Configuring identity providers
Dir: identity_providers
Distros: openshift-dedicated
Topics:
- Name: Configuring your identity providers
File: config-identity-providers
- Name: Notifications for OpenShift Dedicated clusters
File: notifications
---
Name: Administering your cluster
Dir: administering_a_cluster
Name: Cluster administration
Dir: osd_cluster_admin
Distros: openshift-dedicated
Topics:
- Name: Managing administration roles and users
File: osd-admin-roles
- Name: Configuring private connections
Dir: osd_private_connections
Distros: openshift-dedicated
Topics:
- Name: Configuring private connections for AWS
File: aws-private-connections
- Name: Configuring a private cluster
File: private-cluster
- Name: Nodes
Dir: osd_nodes
Distros: openshift-dedicated
Topics:
- Name: About machine pools
File: osd-nodes-machinepools-about
- Name: Managing compute nodes
File: osd-managing-worker-nodes
- Name: About autoscaling nodes on a cluster
File: osd-nodes-about-autoscaling-nodes
- Name: Monitoring user-defined projects
Dir: osd_monitoring
Distros: openshift-dedicated
Topics:
- Name: Understanding the monitoring stack
File: osd-understanding-the-monitoring-stack
- Name: Configuring the monitoring stack
File: osd-configuring-the-monitoring-stack
- Name: Accessing monitoring for user-defined projects
File: osd-accessing-monitoring-for-user-defined-projects
- Name: Managing metrics
File: osd-managing-metrics
- Name: Managing alerts
File: osd-managing-alerts
- Name: Reviewing monitoring dashboards
File: osd-reviewing-monitoring-dashboards
- Name: Troubleshooting monitoring issues
File: osd-troubleshooting-monitoring-issues
---
Name: Authentication and authorization
Name: Cluster security
Dir: authentication
Distros: openshift-dedicated
Topics:
@@ -107,13 +157,6 @@ Topics:
File: osd-upgrades
Distros: openshift-dedicated
---
Name: Cluster notifications
Dir: osd_notifications
Distros: openshift-dedicated
Topics:
- Name: Notifications for OpenShift Dedicated clusters
File: notifications
---
Name: Add-on services
Dir: adding_service_cluster
Distros: openshift-dedicated
@@ -124,14 +167,16 @@ Topics:
File: available-services
Distros: openshift-dedicated
---
Name: Configuring private connections
Dir: osd_private_connections
Name: Storage
Dir: storage
Distros: openshift-dedicated
Topics:
- Name: Configuring private connections for AWS
File: aws-private-connections
- Name: Configuring a private cluster
File: private-cluster
- Name: Persistent storage
Dir: persistent_storage
Distros: openshift-dedicated
Topics:
- Name: Persistent storage using AWS EFS
File: osd-persistent-storage-aws
---
Name: Networking
Dir: networking
@@ -147,47 +192,6 @@ Topics:
- Name: CIDR range definitions
File: cidr-range-definitions
---
Name: Nodes
Dir: nodes
Distros: openshift-dedicated
Topics:
- Name: About machine pools
File: nodes-machinepools-about
- Name: Managing compute nodes
File: rosa-managing-worker-nodes
- Name: About autoscaling nodes on a cluster
File: nodes-about-autoscaling-nodes
---
Name: Monitoring user-defined projects
Dir: monitoring
Distros: openshift-dedicated
Topics:
- Name: Understanding the monitoring stack
File: osd-understanding-the-monitoring-stack
- Name: Configuring the monitoring stack
File: osd-configuring-the-monitoring-stack
- Name: Accessing monitoring for user-defined projects
File: osd-accessing-monitoring-for-user-defined-projects
- Name: Managing metrics
File: osd-managing-metrics
- Name: Managing alerts
File: osd-managing-alerts
- Name: Reviewing monitoring dashboards
File: osd-reviewing-monitoring-dashboards
- Name: Troubleshooting monitoring issues
File: osd-troubleshooting-monitoring-issues
---
Name: Storage
Dir: storage
Distros: openshift-dedicated
Topics:
- Name: Persistent storage
Dir: persistent_storage
Distros: openshift-dedicated
Topics:
- Name: Persistent storage using AWS EFS
File: osd-persistent-storage-aws
---
Name: Applications
Dir: applications
Distros: openshift-dedicated
@@ -199,21 +203,6 @@ Topics:
- Name: Configuring custom domains for applications
File: osd-config-custom-domains-applications
---
Name: Policies and service definition
Dir: osd_policy
Distros: openshift-dedicated
Topics:
- Name: OpenShift Dedicated service definition
File: osd-service-definition
- Name: Responsibility assignment matrix
File: policy-responsibility-matrix
- Name: Understanding process and security for OpenShift Dedicated
File: policy-process-security
- Name: About availability for OpenShift Dedicated
File: policy-understand-availability
- Name: Update life cycle
File: osd-life-cycle
---
Name: Serverless
Dir: serverless
Distros: openshift-dedicated
@@ -363,13 +352,10 @@ Topics:
- Name: Functions development reference guide
File: serverless-functions-reference-guide
---
Name: Support
Dir: support
Name: Troubleshooting
Dir: osd_support
Distros: openshift-dedicated
Topics:
- Name: Getting support
File: getting-support
Distros: openshift-dedicated
- Name: Remote health monitoring with connected clusters
Dir: remote_health_monitoring
Distros: openshift-dedicated
@@ -383,7 +369,7 @@ Topics:
- Name: Using Insights to identify issues with your cluster
File: using-insights-to-identify-issues-with-your-cluster
- Name: Summarizing cluster specifications
File: summarizing-cluster-specifications
File: osd-summarizing-cluster-specifications
Distros: openshift-dedicated
- Name: OpenShift Dedicated managed resources
File: osd-managed-resources

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
// * identity_providers/config-identity-providers.adoc
:_content-type: PROCEDURE

View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
:_content-type: PROCEDURE
[id="config-idp_{context}"]

View File

@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
:_content-type: PROCEDURE
[id="deleting-cluster_{context}"]

View File

@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * rosa_getting_started/rosa-getting-started.adoc
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
:_content-type: PROCEDURE
[id="deploy-app_{context}"]

View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
// * osd_cluster_create/creating-an-aws-cluster.adoc
// * osd_cluster_create/creating-a-gcp-cluster.adoc

View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
// * osd_cluster_create/creating-an-aws-cluster.adoc
// * osd_cluster_create/creating-a-gcp-cluster.adoc

View File

@@ -4,7 +4,7 @@
// * assemblies/osd-architecture.adoc
[id="osd-intro_{context}"]
= Introduction to {product-title}
= An overview of {product-title}
{product-title} is professionally managed by Red Hat and hosted on {AWS} or {GCP}. Each {product-title} cluster comes with a fully managed link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/architecture/control-plane[control plane] (Control and Infrastructure nodes), application nodes, installation and management by Red Hat Site Reliability Engineers (SRE), premium Red Hat Support, and cluster services such as logging, metrics, monitoring, notifications portal, and a cluster portal.

View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * osd_quickstart/osd-quickstart.adoc
// * osd_getting_started/osd-getting-started.adoc
:_content-type: PROCEDURE
[id="scaling-cluster_{context}"]

View File

@@ -32,7 +32,7 @@ Automatic upgrade policies are optional and if they are not set, the upgrade pol
[id="upgrade-manual_upgrades_{context}"]
== Manual upgrades
If you opt for manual upgrades, you are responsible for updating your cluster. If your cluster version falls too far behind, it will transition to a limited support status. For more information on OpenShift life cycle policies, see xref:../osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
If you opt for manual upgrades, you are responsible for updating your cluster. If your cluster version falls too far behind, it will transition to a limited support status. For more information on OpenShift life cycle policies, see xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
[id="upgrade-notifications_{context}"]
== Upgrade notifications

View File

@@ -29,7 +29,7 @@ ifdef::openshift-rosa[]
For information about standard installation prerequisites, see xref:../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#prerequisites[AWS prerequisites for ROSA]. For information about the prerequisites for installation using AWS Security Token Service (STS), see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prerequisites[AWS prerequisites for ROSA with STS].
endif::[]
ifdef::openshift-dedicated[]
For more information, see xref:../osd_quickstart/osd-quickstart.adoc#osd-getting-started[Getting started with {product-title}] for a basic cluster installation workflow.
For more information, see xref:../osd_getting_started/osd-getting-started.adoc#osd-getting-started[Getting started with {product-title}] for a basic cluster installation workflow.
endif::[]
//OSDOCS-3290 Transparent Proxy Update

View File

@@ -0,0 +1,23 @@
:_content-type: ASSEMBLY
[id="osd-getting-support"]
= Getting support
include::_attributes/common-attributes.adoc[]
ifdef::openshift-dedicated[]
include::_attributes/attributes-openshift-dedicated.adoc[]
endif::[]
:context: osd-getting-support
toc::[]
Get support for {product-title}.
include::modules/support.adoc[leveloffset=+1]
include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
include::modules/support-submitting-a-case.adoc[leveloffset=+1]
[id="osd-getting-support-additional-resources"]
[role="_additional-resources"]
== Additional resources
* For details about identifying issues with your cluster, see xref:../osd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster].

View File

@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
[id="osd-understanding"]
= Introduction to {product-title}
= Understanding {product-title}
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-understanding
@@ -13,4 +13,4 @@ include::modules/osd-intro.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* For more information about Telemetry and remote health monitoring for {product-title} clusters, see xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
* For more information about Telemetry and remote health monitoring for {product-title} clusters, see xref:../osd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]

View File

@@ -0,0 +1 @@
../images/

View File

@@ -0,0 +1 @@
../modules/

View File

@@ -0,0 +1,23 @@
:_content-type: ASSEMBLY
[id="osd-accessing-monitoring-for-user-defined-projects"]
= Accessing monitoring for user-defined projects
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-accessing-monitoring-for-user-defined-projects
toc::[]
By default, centralized monitoring for user-defined projects and platform monitoring are enabled. You can monitor your own projects in {product-title} without the need for an additional monitoring solution.
The monitoring of user-defined projects cannot be disabled.
The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.
[NOTE]
====
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
====
[id="accessing-user-defined-monitoring-next-steps"]
== Next steps
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]

View File

@@ -0,0 +1,82 @@
:_content-type: ASSEMBLY
[id="osd-configuring-the-monitoring-stack"]
= Configuring the monitoring stack
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-configuring-the-monitoring-stack
toc::[]
After you configure the monitoring stack, you can review common configuration scenarios and configure monitoring of user-defined projects.
// Maintenance and support for monitoring
include::modules/osd-monitoring-maintenance-and-support.adoc[leveloffset=+1]
include::modules/osd-monitoring-support-considerations.adoc[leveloffset=+2]
// Configuring the monitoring stack
include::modules/osd-monitoring-configuring-the-monitoring-stack.adoc[leveloffset=+1]
// Configurable monitoring components
include::modules/osd-monitoring-configurable-monitoring-components.adoc[leveloffset=+1]
// Moving monitoring components to different nodes
include::modules/osd-monitoring-moving-monitoring-components-to-different-nodes.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* link:https://docs.openshift.com/container-platform/4.7/nodes/nodes/nodes-nodes-working.html#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes]
* link:https://docs.openshift.com/container-platform/4.7/nodes/scheduling/nodes-scheduler-node-selectors.html[Placing pods on specific nodes using node selectors]
* See the link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[Kubernetes documentation] for details on the `nodeSelector` constraint
// TODO: Same question about whether links out to OCP docs should explicitly mention that? (I won't point out any more, but could easily search to find other instances in the repo).
// Assigning tolerations to monitoring components
include::modules/osd-monitoring-assigning-tolerations-to-monitoring-components.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* See the link:https://docs.openshift.com/container-platform/4.7/nodes/scheduling/nodes-scheduler-taints-tolerations.html#nodes-scheduler-taints-tolerations[OpenShift Container Platform documentation] on taints and tolerations
* See the link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Kubernetes documentation] on taints and tolerations
// Configuring persistent storage
[id="configuring-persistent-storage"]
== Configuring persistent storage
Running cluster monitoring with persistent storage means that your metrics are stored to a persistent volume (PV) and can survive a pod being restarted or recreated. This is ideal if you require your metrics data to be guarded from data loss. For production environments, it is highly recommended to configure persistent storage. Because of the high IO demands, it is advantageous to use local storage.
[IMPORTANT]
====
See link:https://docs.openshift.com/container-platform/4.7/scalability_and_performance/optimizing-storage.html#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].
====
[id="persistent-storage-prerequisites"]
=== Persistent storage prerequisites
* Use the block type of storage.
include::modules/osd-monitoring-configuring-a-local-persistent-volume-claim.adoc[leveloffset=+2]
include::modules/osd-monitoring-modifying-retention-time-for-prometheus-metrics-data.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* link:https://docs.openshift.com/container-platform/4.7/storage/understanding-persistent-storage.html[Understanding persistent storage]
* link:https://docs.openshift.com/container-platform/4.7/scalability_and_performance/optimizing-storage.html[Optimizing storage]
// Managing scrape sample limits for user-defined projects
include::modules/osd-monitoring-limiting-scrape-samples-in-user-defined-projects.adoc[leveloffset=+1]
include::modules/osd-monitoring-setting-a-scrape-sample-limit-for-user-defined-projects.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* link:https://docs.openshift.com/container-platform/4.7/monitoring/troubleshooting-monitoring-issues.html#determining-why-prometheus-is-consuming-disk-space_troubleshooting-monitoring-issues[Determining why Prometheus is consuming a lot of disk space] for steps to query which metrics have the highest number of scrape samples
// Setting log levels for monitoring components
include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.adoc[leveloffset=+1]
[id="configuring-the-monitoring-stack-next-steps"]
== Next steps
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]

View File

@@ -0,0 +1,13 @@
:_content-type: ASSEMBLY
[id="osd-managing-alerts"]
= Alerts
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-managing-alerts
toc::[]
Alerts for monitoring workloads in user-defined projects are not currently supported in this {product-title}.
[id="alerts-next-steps"]
== Next steps
* xref:../../osd_cluster_admin/osd_monitoring/osd-reviewing-monitoring-dashboards.adoc#osd-reviewing-monitoring-dashboards[Reviewing monitoring dashboards]

View File

@@ -20,7 +20,7 @@ include::modules/osd-monitoring-specifying-how-a-service-is-monitored.adoc[level
.Additional resources
* See the link:https://github.com/openshift/prometheus-operator/blob/release-4.7/Documentation/api.md[Prometheus Operator API documentation] for more information on `ServiceMonitor` and `PodMonitor` resources.
* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
// Querying metrics
include::modules/osd-monitoring-querying-metrics.adoc[leveloffset=+1]
@@ -31,7 +31,7 @@ include::modules/osd-monitoring-querying-metrics-for-user-defined-projects-as-a-
.Additional resources
* See the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus query documentation] for more information about creating PromQL queries.
* See the xref:../monitoring/osd-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_osd-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
* See the xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_osd-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
// TODO: The above additional resource points to the same module that it's an additional resource of
include::modules/osd-monitoring-exploring-the-visualized-metrics.adoc[leveloffset=+2]
@@ -39,11 +39,11 @@ include::modules/osd-monitoring-exploring-the-visualized-metrics.adoc[leveloffse
[role="_additional-resources"]
.Additional resources
* See the xref:../monitoring/osd-managing-metrics.adoc#querying-metrics_osd-managing-metrics[Querying metrics] section on using the PromQL interface
* xref:../monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
* See the xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#querying-metrics_osd-managing-metrics[Querying metrics] section on using the PromQL interface
* xref:../../osd_cluster_admin/osd_monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
[id="managing-metrics-next-steps"]
== Next steps
* xref:../monitoring/osd-managing-alerts.adoc#osd-managing-alerts[Alerts]
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc#osd-managing-alerts[Alerts]
// TODO: Why is alerts a next step if alerts aren't supported? Can this be removed?

View File

@@ -0,0 +1,32 @@
:_content-type: ASSEMBLY
[id="osd-reviewing-monitoring-dashboards"]
= Reviewing monitoring dashboards
include::_attributes/common-attributes.adoc[]
:context: osd-reviewing-monitoring-dashboards
toc::[]
{product-title} provides monitoring dashboards that help you understand the state of user-defined projects.
In the *Developer* perspective, you can access dashboards that provide the following statistics for a selected project:
* CPU usage
* Memory usage
* Bandwidth information
* Packet rate information
.Example dashboard in the Developer perspective
image::monitoring-dashboard-developer.png[]
[NOTE]
====
In the *Developer* perspective, you can view dashboards for only one project at a time.
====
// Reviewing monitoring dashboards as a developer
include::modules/osd-monitoring-reviewing-monitoring-dashboards-developer.adoc[leveloffset=+1]
[id="monitoring-dashboards-next-steps"]
== Next steps
* xref:../../osd_cluster_admin/osd_monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]

View File

@@ -0,0 +1,11 @@
:_content-type: ASSEMBLY
[id="osd-troubleshooting-monitoring-issues"]
= Troubleshooting monitoring issues
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-troubleshooting-monitoring-issues
toc::[]
Find troubleshooting steps for common monitoring issues with user-defined projects.
include::modules/osd-monitoring-troubleshooting-issues.adoc[leveloffset=+1]

View File

@@ -0,0 +1,33 @@
:_content-type: ASSEMBLY
[id="osd-understanding-the-monitoring-stack"]
= Understanding the monitoring stack
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-understanding-the-monitoring-stack
toc::[]
In {product-title}, you can monitor your own projects in isolation from Red Hat Site Reliability Engineer (SRE) platform metrics. You can monitor your own projects without the need for an additional monitoring solution.
[NOTE]
====
Follow the instructions in this document carefully to configure a supported Prometheus instance for monitoring user-defined projects. Custom Prometheus instances are not supported by {product-title}.
====
// Understanding the monitoring stack
include::modules/osd-monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1]
include::modules/osd-monitoring-components-for-monitoring-user-defined-projects.adoc[leveloffset=+2]
include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffset=+2]
[role="_additional-resources"]
[id="understanding-the-monitoring-stack-additional-resources"]
== Additional resources
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/monitoring/monitoring-overview#default-monitoring-components_monitoring-overview[Default monitoring components]
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/monitoring/monitoring-overview#default-monitoring-targets_monitoring-overview[Default monitoring targets]
// TODO: When there is a link to the OCP docs, should that be explicit, so they're not surprised when they find themselves in another doc set?
[id="understanding-the-monitoring-stack-next-steps"]
== Next steps
* xref:../../osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]

View File

@@ -0,0 +1,24 @@
:_content-type: ASSEMBLY
include::_attributes/attributes-openshift-dedicated.adoc[]
[id="osd-managing-worker-nodes"]
= Managing compute nodes
:context: osd-managing-worker-nodes
toc::[]
This document describes how to manage compute (also known as worker) nodes with {product-title}.
The majority of changes for compute nodes are configured on machine pools. A machine pool is a group of compute nodes in a cluster that have the same configuration, providing ease of management.
You can edit machine pool configuration options such as scaling, adding node labels, and adding taints.
include::modules/creating-a-machine-pool-ocm.adoc[leveloffset=+1]
include::modules/rosa-scaling-worker-nodes.adoc[leveloffset=+1]
include::modules/rosa-adding-node-labels.adoc[leveloffset=+1]
include::modules/rosa-adding-taints.adoc[leveloffset=+1]
[role="_additional-resources"]
== Additional resources
* xref:../../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machinepools-about[About machine pools]
* xref:../../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#osd-nodes-enabling-autoscaling-nodes[Enabling autoscaling]
* xref:../../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#osd-nodes-disabling-autoscaling-nodes[Disabling autoscaling]
* xref:../../osd_architecture/osd_policy/osd-service-definition.adoc#osd-service-definition[{product-title} service definition]

View File

@@ -0,0 +1,56 @@
:_content-type: ASSEMBLY
include::_attributes/attributes-openshift-dedicated.adoc[]
[id="osd-nodes-about-autoscaling-nodes"]
= About autoscaling nodes on a cluster
:context: osd-nodes-about-autoscaling-nodes
toc::[]
[IMPORTANT]
====
Autoscaling is available only on clusters that were purchased through the Red Hat Marketplace.
====
The autoscaler option can be configured to automatically scale the number of machines in a cluster.
The cluster autoscaler increases the size of the cluster when there are pods that failed to schedule on any of the current nodes due to insufficient resources or when another node is necessary to meet deployment needs. The cluster autoscaler does not increase the cluster resources beyond the limits that you specify.
Additionally, the cluster autoscaler decreases the size of the cluster when some nodes are consistently not needed for a significant period, such as when it has low resource use and all of its important pods can fit on other nodes.
When you enable autoscaling, you must also set a minimum and maximum number of worker nodes.
[NOTE]
====
Only cluster owners and organization admins can scale or delete a cluster.
====
[id="osd-nodes-enabling-autoscaling-nodes"]
== Enabling autoscaling nodes on a cluster
You can enable autoscaling on worker nodes to increase or decrease the number of nodes available by editing the machine pool definition for an existing cluster.
[discrete]
include::modules/ocm-enabling-autoscaling-nodes.adoc[leveloffset=+2]
[id="osd-nodes-disabling-autoscaling-nodes"]
== Disabling autoscaling nodes on a cluster
You can disable autoscaling on worker nodes to increase or decrease the number of nodes available by editing the machine pool definition for an existing cluster.
You can disable autoscaling on a cluster using {cluster-manager} console.
[discrete]
include::modules/ocm-disabling-autoscaling-nodes.adoc[leveloffset=+2]
Applying autoscaling to an {product-title} cluster involves deploying a cluster autoscaler and then deploying machine autoscalers for each machine type in your cluster.
[IMPORTANT]
====
You can configure the cluster autoscaler only in clusters where the Machine API is operational.
====
include::modules/cluster-autoscaler-about.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="nodes-about-autoscaling-nodes-additional-resources"]
== Additional resources
* xref:../../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machinepools-about[About machinepools]

View File

@@ -0,0 +1,35 @@
:_content-type: ASSEMBLY
include::_attributes/attributes-openshift-dedicated.adoc[]
[id="osd-machinepools-about"]
= About machine pools
:context: osd-machinepools-about
toc::[]
{product-title} uses machine pools as an elastic, dynamic provisioning method on top of your cloud infrastructure.
The primary resources are machines, machine sets, and machine pools.
== Machines
A machine is a fundamental unit that describes the host for a worker node.
== Machine sets
`MachineSet` resources are groups of machines. If you need more machines or must scale them down, change the number of replicas in the machine pool to which the machine sets belong.
== Machine pools
Machine pools are a higher level construct to machine sets.
A machine pool creates machine sets that are all clones of the same configuration across availability zones. Machine pools perform all of the host node provisioning management actions on a worker node. If you need more machines or must scale them down, change the number of replicas in the machine pool to meet your compute needs. You can manually configure scaling or set autoscaling.
By default, a cluster is created with one machine pool. You can add additional machine pools to an existing cluster, modify the default machine pool, and delete machine pools.
Multiple machine pools can exist on a single cluster, and they can each have different types or different size nodes.
== Machine pools in multiple zone clusters
When you create a machine pool in a multiple availability zone (Multi-AZ) cluster, that one machine pool has 3 zones. The machine pool, in turn, creates a total of 3 machine sets - one machine set for each zone in the cluster. Each of those machine sets manages one or more machines in its respective availability zone.
If you create a new Multi-AZ cluster, the machine pools are replicated to those zones automatically. If you add a machine pool to an existing Multi-AZ, the new pool is automatically created in those zones. Similarly, deleting a machine pool will delete it from all zones.
Due to this multiplicative effect, using machine pools in Multi-AZ cluster can consume more of your project's quota for a specific region when creating machine pools.
[role="_additional-resources"]
== Additional resources
* xref:../../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#osd-nodes-about-autoscaling-nodes[About autoscaling]

View File

@@ -0,0 +1,78 @@
:_content-type: ASSEMBLY
[id="osd-getting-started"]
= Getting started with {product-title}
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-getting-started
toc::[]
[role="_abstract"]
Follow this getting started document to quickly create a {product-title} cluster, grant user access, deploy your first application, and learn how to scale and delete your cluster.
[id="osd-getting-started-prerequisites"]
== Prerequisites
* You reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../osd_architecture/osd-architecture.adoc#osd-architecture[architecture concepts].
* You reviewed the xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
[id="osd-getting-started-create-cluster"]
== Creating an {product-title} cluster
You can install {product-title} in your own cloud provider account through the Customer Cloud Subscription (CCS) model or in a cloud account that is owned by Red Hat. For more information about the deployment options for {product-title}, see xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[Understanding your cloud deployment options].
Choose from one of the following methods to deploy your cluster.
[id="osd-getting-started-create-cluster-ccs"]
=== Creating a cluster using the CCS model
Complete the steps in one of the following sections to deploy {product-title} in a cloud account that you own:
* *xref:../osd_install_access_delete_cluster/creating-an-aws-cluster.adoc#osd-create-aws-cluster-ccs_osd-creating-a-cluster-on-aws[Creating a cluster on AWS with CCS]*: You can install {product-title} in your own {AWS} account by using the CCS model.
* *xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc#osd-create-gcp-cluster-ccs_osd-creating-a-cluster-on-gcp[Creating a cluster on GCP with CCS]*: You can install {product-title} in your own {GCP} account by using the CCS model.
[id="osd-getting-started-create-cluster-red-hat-cloud-account"]
=== Creating a cluster using a Red Hat cloud account
Complete the steps in one of the following sections to deploy {product-title} in a cloud account that is owned by Red Hat:
* *xref:../osd_install_access_delete_cluster/creating-an-aws-cluster.adoc#osd-create-aws-cluster-red-hat-account_osd-creating-a-cluster-on-aws[Creating a cluster on AWS with a Red Hat cloud account]*: You can install {product-title} in an AWS account that is owned by Red Hat.
* *xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc#osd-create-aws-cluster-ccs_osd-creating-a-cluster-on-gcp[Creating a cluster on GCP with a Red Hat cloud account]*: You can install {product-title} in an GCP account that is owned by Red Hat.
include::modules/config-idp.adoc[leveloffset=+1]
.Additional resources
* For detailed steps to configure each of the supported identity provider types, see xref:../osd_install_access_delete_cluster/config-identity-providers.adoc#config-identity-providers[Configuring identity providers].
include::modules/osd-grant-admin-privileges.adoc[leveloffset=+1]
include::modules/access-cluster.adoc[leveloffset=+1]
include::modules/deploy-app.adoc[leveloffset=+1]
include::modules/scaling-cluster.adoc[leveloffset=+1]
.Additional resources
* For information about machine pools, see xref:../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machine-pools-about[About machine pools].
* For detailed steps to enable autoscaling for compute nodes in your cluster, see xref:../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster].
include::modules/osd-revoke-admin-privileges.adoc[leveloffset=+1]
include::modules/osd-revoke-user-access.adoc[leveloffset=+1]
include::modules/deleting-cluster.adoc[leveloffset=+1]
[id="next-steps_{context}"]
== Next steps
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
* xref:../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machine-pools-about[About machine pools]
* xref:../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster]
* xref:../osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
[id="additional-resources_{context}"]
== Additional resources
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
* For more information about deploying {product-title} clusters, see xref:../osd_install_access_delete_cluster/creating-an-aws-cluster.adoc#osd-creating-a-cluster-on-aws[Creating a cluster on AWS] and xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc#osd-creating-a-cluster-on-gcp[Creating a cluster on GCP].
* For documentation on upgrading your cluster, see xref:../upgrading/osd-upgrades.adoc#osd-upgrades[{product-title} cluster upgrades].

View File

@@ -14,5 +14,5 @@ include::modules/understanding-clusters.adoc[leveloffset=+1]
[id="next-steps_{context}"]
== Next steps
* xref:../osd_cluster_create/creating-an-aws-cluster.adoc#osd-creating-a-cluster-on-aws[Creating a cluster on AWS]
* xref:../osd_cluster_create/creating-a-gcp-cluster.adoc#osd-creating-a-cluster-on-gcp[Creating a cluster on GCP]
* xref:../osd_install_access_delete_cluster/creating-an-aws-cluster.adoc#osd-creating-a-cluster-on-aws[Creating a cluster on AWS]
* xref:../osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc#osd-creating-a-cluster-on-gcp[Creating a cluster on GCP]

View File

@@ -0,0 +1 @@
../_attributes/

View File

@@ -13,7 +13,7 @@ You can install {product-title} on {GCP} by using your own GCP account through t
== Prerequisites
* You reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../osd_architecture/osd-architecture.adoc#osd-architecture[architecture concepts].
* You reviewed the xref:../osd_cluster_create/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
* You reviewed the xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
include::modules/osd-create-cluster-ccs.adoc[leveloffset=+1]
include::modules/osd-create-cluster-red-hat-account.adoc[leveloffset=+1]
@@ -21,7 +21,7 @@ include::modules/osd-create-cluster-red-hat-account.adoc[leveloffset=+1]
[id="additional-resources_{context}"]
== Additional resources
* For information about persistent storage for {product-title}, see the xref:../osd_policy/osd-service-definition.adoc#sdpolicy-storage_osd-service-definition[Storage] section in the {product-title} service definition.
* For information about load balancers for {product-title}, see the xref:../osd_policy/osd-service-definition.adoc#load-balancers_osd-service-definition[Load balancers] section in the {product-title} service definition.
* For more information about etcd encryption, see the xref:../osd_policy/osd-service-definition.adoc#etcd-encryption_osd-service-definition[etcd encryption service definition].
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
* For information about persistent storage for {product-title}, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#sdpolicy-storage_osd-service-definition[Storage] section in the {product-title} service definition.
* For information about load balancers for {product-title}, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#load-balancers_osd-service-definition[Load balancers] section in the {product-title} service definition.
* For more information about etcd encryption, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#etcd-encryption_osd-service-definition[etcd encryption service definition].
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].

View File

@@ -13,7 +13,7 @@ You can install {product-title} on {AWS} by using your own AWS account through t
== Prerequisites
* You reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../osd_architecture/osd-architecture.adoc#osd-architecture[architecture concepts].
* You reviewed the xref:../osd_cluster_create/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
* You reviewed the xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
include::modules/osd-create-cluster-ccs.adoc[leveloffset=+1]
include::modules/osd-create-cluster-red-hat-account.adoc[leveloffset=+1]
@@ -22,7 +22,7 @@ include::modules/osd-create-cluster-red-hat-account.adoc[leveloffset=+1]
== Additional resources
* For details about the AWS service control policies required for CCS deployments, see xref:../osd_planning/aws-ccs.adoc#ccs-aws-scp_aws-ccs[Minimum required service control policy (SCP)].
* For information about persistent storage for {product-title}, see the xref:../osd_policy/osd-service-definition.adoc#sdpolicy-storage_osd-service-definition[Storage] section in the {product-title} service definition.
* For information about load balancers for {product-title}, see the xref:../osd_policy/osd-service-definition.adoc#load-balancers_osd-service-definition[Load balancers] section in the {product-title} service definition.
* For more information about etcd encryption, see the xref:../osd_policy/osd-service-definition.adoc#etcd-encryption_osd-service-definition[etcd encryption service definition].
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
* For information about persistent storage for {product-title}, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#sdpolicy-storage_osd-service-definition[Storage] section in the {product-title} service definition.
* For information about load balancers for {product-title}, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#load-balancers_osd-service-definition[Load balancers] section in the {product-title} service definition.
* For more information about etcd encryption, see the xref:../osd_architecture/osd_policy/osd-service-definition.adoc#etcd-encryption_osd-service-definition[etcd encryption service definition].
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -1,78 +0,0 @@
:_content-type: ASSEMBLY
[id="osd-getting-started"]
= Getting started with {product-title}
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-getting-started
toc::[]
[role="_abstract"]
Follow this getting started document to quickly create a {product-title} cluster, grant user access, deploy your first application, and learn how to scale and delete your cluster.
[id="osd-getting-started-prerequisites"]
== Prerequisites
* You reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../osd_architecture/osd-architecture.adoc#osd-architecture[architecture concepts].
* You reviewed the xref:../osd_cluster_create/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
[id="osd-getting-started-create-cluster"]
== Creating an {product-title} cluster
You can install {product-title} in your own cloud provider account through the Customer Cloud Subscription (CCS) model or in a cloud account that is owned by Red Hat. For more information about the deployment options for {product-title}, see xref:../osd_cluster_create/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[Understanding your cloud deployment options].
Choose from one of the following methods to deploy your cluster.
[id="osd-getting-started-create-cluster-ccs"]
=== Creating a cluster using the CCS model
Complete the steps in one of the following sections to deploy {product-title} in a cloud account that you own:
* *xref:../osd_cluster_create/creating-an-aws-cluster.adoc#osd-create-aws-cluster-ccs_osd-creating-a-cluster-on-aws[Creating a cluster on AWS with CCS]*: You can install {product-title} in your own {AWS} account by using the CCS model.
* *xref:../osd_cluster_create/creating-a-gcp-cluster.adoc#osd-create-gcp-cluster-ccs_osd-creating-a-cluster-on-gcp[Creating a cluster on GCP with CCS]*: You can install {product-title} in your own {GCP} account by using the CCS model.
[id="osd-getting-started-create-cluster-red-hat-cloud-account"]
=== Creating a cluster using a Red Hat cloud account
Complete the steps in one of the following sections to deploy {product-title} in a cloud account that is owned by Red Hat:
* *xref:../osd_cluster_create/creating-an-aws-cluster.adoc#osd-create-aws-cluster-red-hat-account_osd-creating-a-cluster-on-aws[Creating a cluster on AWS with a Red Hat cloud account]*: You can install {product-title} in an AWS account that is owned by Red Hat.
* *xref:../osd_cluster_create/creating-a-gcp-cluster.adoc#osd-create-aws-cluster-ccs_osd-creating-a-cluster-on-gcp[Creating a cluster on GCP with a Red Hat cloud account]*: You can install {product-title} in an GCP account that is owned by Red Hat.
include::modules/config-idp.adoc[leveloffset=+1]
.Additional resources
* For detailed steps to configure each of the supported identity provider types, see xref:../identity_providers/config-identity-providers.adoc#config-identity-providers[Configuring identity providers].
include::modules/osd-grant-admin-privileges.adoc[leveloffset=+1]
include::modules/access-cluster.adoc[leveloffset=+1]
include::modules/deploy-app.adoc[leveloffset=+1]
include::modules/scaling-cluster.adoc[leveloffset=+1]
.Additional resources
* For information about machine pools, see xref:../nodes/nodes-machinepools-about.adoc#machine-pools-about[About machine pools].
* For detailed steps to enable autoscaling for compute nodes in your cluster, see xref:../nodes/nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster].
include::modules/osd-revoke-admin-privileges.adoc[leveloffset=+1]
include::modules/osd-revoke-user-access.adoc[leveloffset=+1]
include::modules/deleting-cluster.adoc[leveloffset=+1]
[id="next-steps_{context}"]
== Next steps
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
* xref:../nodes/nodes-machinepools-about.adoc#machine-pools-about[About machine pools]
* xref:../nodes/nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster]
* xref:../monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
[id="additional-resources_{context}"]
== Additional resources
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
* For more information about deploying {product-title} clusters, see xref:../osd_cluster_create/creating-an-aws-cluster.adoc#osd-creating-a-cluster-on-aws[Creating a cluster on AWS] and xref:../osd_cluster_create/creating-a-gcp-cluster.adoc#osd-creating-a-cluster-on-gcp[Creating a cluster on GCP].
* For documentation on upgrading your cluster, see xref:../upgrading/osd-upgrades.adoc#osd-upgrades[{product-title} cluster upgrades].

1
osd_support/_attributes Symbolic link
View File

@@ -0,0 +1 @@
../_attributes/

1
osd_support/images Symbolic link
View File

@@ -0,0 +1 @@
../images

1
osd_support/modules Symbolic link
View File

@@ -0,0 +1 @@
../modules

View File

@@ -0,0 +1,54 @@
:_content-type: ASSEMBLY
[id="osd-managed-resources"]
= {product-title} managed resources
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-managed-resources
toc::[]
[id="osd-managed-resources-overview"]
== Overview
The following covers all resources managed or protected by the Service Reliability Engineering Platform (SRE-P) Team. Customers should not attempt to modify these resources because doing so can lead to cluster instability.
[id="osd-managed-resources-all"]
== Hive managed resources
The following list displays the {product-title} resources managed by OpenShift Hive, the centralized fleet configuration management system. These resources are in addition to the OpenShift Container Platform resources created during installation. OpenShift Hive continually attempts to maintain consistency across all {product-title} clusters. Changes to {product-title} resources should be made through {cluster-manager} so that {cluster-manager} and Hive are synchronized. Contact ocm-feedback@redhat.com if {cluster-manager} does not support modifying the resources in question.
.List of Hive managed resources
[%collapsible]
====
[source,yaml]
----
include::https://raw.githubusercontent.com/openshift/managed-cluster-config/master/resources/managed/all-osd-resources.yaml[]
----
====
[id="osd-add-on-managed-namespaces"]
== {product-title} add-on namespaces
{product-title} add-ons are services available for installation after cluster installation. These additional services include AWS CloudWatch, Red Hat CodeReady Workspaces, Red Hat OpenShift API Management, and Cluster Logging Operator. Any changes to resources within the following namespaces might be overridden by the add-on during upgrades, which can lead to unsupported configurations for the add-on functionality.
.List of add-on managed namespaces
[%collapsible]
====
[source,yaml]
----
include::https://raw.githubusercontent.com/openshift/managed-cluster-config/master/resources/addons-namespaces/main.yaml[]
----
====
[id="osd-validating-webhooks"]
== {product-title} validating webhooks
{product-title} validating webhooks are a set of dynamic admission controls maintained by the OpenShift SRE team. These HTTP callbacks, also known as webhooks, are called for various types of requests to ensure cluster stability. Upon request the webhooks accept or reject the request. The following list describes the various webhooks with rules containing the registered operations and resources that are controlled. Any attempt to circumvent these validating webhooks could affect the stability and supportability of the cluster.
.List of validating webhooks
[%collapsible]
====
[source,json]
----
include::https://raw.githubusercontent.com/openshift/managed-cluster-validating-webhooks/master/docs/webhooks.json[]
----
====

View File

@@ -0,0 +1,13 @@
:_content-type: ASSEMBLY
[id="summarizing-cluster-specifications"]
= Summarizing cluster specifications
include::_attributes/common-attributes.adoc[]
ifdef::openshift-dedicated[]
include::_attributes/attributes-openshift-dedicated.adoc[]
endif::[]
:context: summarizing-cluster-specifications
toc::[]
// Summarizing cluster specifications through `clusterversion`
include::modules/summarizing-cluster-specifications-through-clusterversion.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../../_attributes/

View File

@@ -0,0 +1,123 @@
:_content-type: ASSEMBLY
[id="about-remote-health-monitoring"]
= About remote health monitoring
include::_attributes/common-attributes.adoc[]
ifdef::openshift-dedicated[]
include::_attributes/attributes-openshift-dedicated.adoc[]
endif::[]
:context: about-remote-health-monitoring
toc::[]
{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. The data that is provided to Red Hat enables the benefits outlined in this document.
A cluster that reports data to Red Hat through Telemetry and the Insights Operator is considered a _connected cluster_.
*Telemetry* is the term that Red Hat uses to describe the information being sent to Red Hat by the {product-title} Telemeter Client. Lightweight attributes are sent from connected clusters to Red Hat to enable subscription management automation, monitor the health of clusters, assist with support, and improve customer experience.
The *Insights Operator* gathers {product-title} configuration data and sends it to Red Hat. The data is used to produce insights about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators on {cluster-manager-url}.
More information is provided in this document about these two processes.
.Telemetry and Insights Operator benefits
Telemetry and the Insights Operator enable the following benefits for end-users:
* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red Hat from a broader perspective across a fleet of clusters. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a Bugzilla.
* *Advanced release management*. {product-title} offers the `candidate`, `fast`, and `stable` release channels, which enable you to choose an update strategy. The graduation of a release from `fast` to `stable` is dependent on the success rate of updates and on the events seen during upgrades. With the information provided by connected clusters, Red Hat can improve the quality of releases to `stable` channels and react more rapidly to issues found in the `fast` channels.
* *Targeted prioritization of new features and functionality*. The data collected provides insights about which areas of {product-title} are used most. With this information, Red Hat can focus on developing the new features and functionality that have the greatest impact for our customers.
* *A streamlined support experience*. You can provide a cluster ID for a connected cluster when creating a support ticket on the link:https://access.redhat.com/support/[Red Hat Customer Portal]. This enables Red Hat to deliver a streamlined support experience that is specific to your cluster, by using the connected information. This document provides more information about that enhanced support experience.
* *Predictive analytics*. The insights displayed for your cluster on {cluster-manager-url} are enabled by the information collected from connected clusters. Red Hat is investing in applying deep learning, machine learning, and artificial intelligence automation to help identify issues that {product-title} clusters are exposed to.
ifdef::openshift-origin[]
{product-title} may be installed without a pull secret received at console.redhat.com. In this case default imagestreams will not be imported and telemetry data will not be sent.
endif::[]
include::modules/telemetry-about-telemetry.adoc[leveloffset=+1]
ifndef::openshift-dedicated[]
[role="_additional-resources"]
.Additional resources
* See the xref:../../updating/updating-cluster-within-minor.adoc#updating-cluster-within-minor[{product-title} update documentation] for more information about updating or upgrading a cluster.
endif::[]
include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2]
ifndef::openshift-dedicated[]
[role="_additional-resources"]
.Additional resources
* See xref:../../osd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by Telemetry] for details about how to list the attributes that Telemetry gathers from Prometheus in {product-title}.
* See the link:https://github.com/openshift/cluster-monitoring-operator/blob/master/manifests/0000_50_cluster-monitoring-operator_04-config.yaml[upstream cluster-monitoring-operator source code] for a list of the attributes that Telemetry gathers from Prometheus.
* Telemetry is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../osd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
endif::[]
include::modules/insights-operator-about.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* The Insights Operator is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../osd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
ifdef::openshift-dedicated[]
// TODO: When you click on that link, you actually can't opt out. Should this additional resources link be removed?
endif::[]
include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
ifndef::openshift-dedicated[]
* See xref:../../osd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.html#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator] for details about how to review the data that is collected by the Insights Operator.
endif::[]
* The Insights Operator source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator upstream project] for a list of the items collected by the Insights Operator.
include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[leveloffset=+1]
ifndef::openshift-dedicated[]
[role="_additional-resources"]
.Additional resources
* See xref:../../monitoring/monitoring-overview.adoc#monitoring-overview_monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
* See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights
endif::[]
[id="additional-details-about-how-remote-health-monitoring-data-is-used"]
== Additional details about how remote health monitoring data is used
The information collected to enable remote health monitoring is detailed in xref:../../osd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#what-information-is-collected_about-remote-health-monitoring[Information collected by Telemetry] and xref:../../osd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#insights-operator-what-information-is-collected_about-remote-health-monitoring[Information collected by the Insights Operator].
As further described in the preceding sections of this document, Red Hat collects data about your use of the Red Hat Product(s) for purposes such as providing support and upgrades, optimizing performance or configuration, minimizing service impacts, identifying and remediating threats, troubleshooting, improving the offerings and user experience, responding to issues, and for billing purposes if applicable.
.Collection safeguards
Red Hat employs technical and organizational measures designed to protect the telemetry and configuration data.
.Sharing
Red Hat may share the data collected through Telemetry and the Insights Operator internally within Red Hat to improve your user experience. Red Hat may share telemetry and configuration data with its business partners in an aggregated form that does not identify customers to help the partners better understand their markets and their customers use of Red Hat offerings or to ensure the successful integration of products jointly supported by those partners.
.Third parties
Red Hat may engage certain third parties to assist in the collection, analysis, and storage of the Telemetry and configuration data.
.User control / enabling and disabling telemetry and configuration data collection
You may disable {product-title} Telemetry and the Insights Operator by following the instructions in xref:../../osd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
ifdef::openshift-dedicated[]
// TODO: Same question about should this be removed or updated, since you can't actually opt out for dedicated?
endif::[]

View File

@@ -0,0 +1,20 @@
:_content-type: ASSEMBLY
[id="enabling-remote-health-reporting"]
= Enabling remote health reporting
include::_attributes/common-attributes.adoc[]
:context: enabling-remote-health-reporting
toc::[]
If you or your organization have disabled remote health reporting, you can enable this feature again. You can see that remote health reporting is disabled from the message "Insights not available" in the *Status* tile on the {product-title} Web Console Overview page.
To enable remote health reporting, you must xref:../../support/remote_health_monitoring/enabling-remote-health-reporting.adoc#insights-operator-new-pull-secret-enable_enabling-remote-health-reporting[Modify the global cluster pull secret] with a new authorization token.
[NOTE]
====
Enabling remote health reporting enables both Insights Operator and Telemetry.
====
include::modules/insights-operator-new-pull-secret-enable.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../../images

View File

@@ -0,0 +1,23 @@
:_content-type: ASSEMBLY
[id="insights-operator-simple-access"]
= Importing simple content access certificates with Insights Operator
include::_attributes/common-attributes.adoc[]
:context: remote-health-reporting-from-restricted-network
:FeatureName: `InsightsOperatorPullingSCA`
toc::[]
Insights Operator periodically imports your simple content access certificates from {cluster-manager-url} and stores them in the `etc-pki-entitlement` secret in the `openshift-config-managed` namespace. Simple content access is a capability in Red Hat subscription tools which simplifies the behavior of the entitlement tooling. This feature makes it easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling.
Insights Operator imports simple content access certificates every 8 hours by default, but can be configured or disabled using the `support` secret in the `openshift-config` namespace.
[role="_additional-resources"]
.Additional resources
* See link:https://access.redhat.com/documentation/en-us/subscription_central/2021/html-single/getting_started_with_simple_content_access/index#assembly-about-simplecontent[About simple content access] in the Red Hat Subscription Central documentation, for more information about simple content access.
* See xref:../../cicd/builds/running-entitled-builds.adoc[Using Red Hat subscriptions in builds], for more information about using simple content access certificates in {product-title} entitled builds.
include::modules/insights-operator-configuring-sca.adoc[leveloffset=+1]
include::modules/insights-operator-disabling-sca.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../../modules

View File

@@ -0,0 +1,35 @@
:_content-type: ASSEMBLY
[id="opting-out-remote-health-reporting"]
= Opting out of remote health reporting
include::_attributes/common-attributes.adoc[]
ifdef::openshift-dedicated[]
include::_attributes/attributes-openshift-dedicated.adoc[]
endif::[]
:context: opting-out-remote-health-reporting
toc::[]
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
You may choose to opt out of reporting health and usage data for your cluster.
endif::[]
ifdef::openshift-dedicated[]
On {product-title}, remote health reporting is always enabled. You cannot opt out.
// TODO: Is there even a reason to include this assembly for OSD? Could you remove it, and just mention in the other assemblies that you can't opt out?
endif::[]
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
To opt out of remote health reporting, you must:
. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#insights-operator-new-pull-secret_opting-out-remote-health-reporting[Modify the global cluster pull secret] to disable remote health reporting.
. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#images-update-global-pull-secret_opting-out-remote-health-reporting[Update the cluster] to use this modified pull secret.
include::modules/telemetry-consequences-of-disabling-telemetry.adoc[leveloffset=+1]
include::modules/insights-operator-new-pull-secret-disabled.adoc[leveloffset=+1]
include::modules/images-update-global-pull-secret.adoc[leveloffset=+1]
endif::[]

View File

@@ -0,0 +1,28 @@
:_content-type: ASSEMBLY
[id="remote-health-reporting-from-restricted-network"]
= Using remote health reporting in a restricted network
include::_attributes/common-attributes.adoc[]
:context: remote-health-reporting-from-restricted-network
toc::[]
You can manually gather and upload Insights Operator archives to diagnose issues from a restricted network.
To use the Insights Operator in a restricted network, you must:
* Create a copy of your Insights Operator archive.
* Upload the Insights Operator archive to link:https://console.redhat.com[console.redhat.com].
Additionally, you can choose to xref:../../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#insights-operator-enable-obfuscation_remote-health-reporting-from-restricted-network[obfuscate] the Insights Operator data before upload.
include::modules/insights-operator-one-time-gather.adoc[leveloffset=+1]
include::modules/insights-operator-manual-upload.adoc[leveloffset=+1]
include::modules/insights-operator-enable-obfuscation.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* For more information on how to download your Insights Operator archive, see xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator].

View File

@@ -0,0 +1,16 @@
:_content-type: ASSEMBLY
[id="showing-data-collected-by-remote-health-monitoring"]
= Showing data collected by remote health monitoring
include::_attributes/common-attributes.adoc[]
ifdef::openshift-dedicated[]
include::_attributes/attributes-openshift-dedicated.adoc[]
endif::[]
:context: showing-data-collected-by-remote-health-monitoring
toc::[]
As an administrator, you can review the metrics collected by Telemetry and the Insights Operator.
include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../../snippets

View File

@@ -0,0 +1,20 @@
:_content-type: ASSEMBLY
[id="using-insights-to-identify-issues-with-your-cluster"]
= Using Insights to identify issues with your cluster
include::_attributes/common-attributes.adoc[]
ifdef::openshift-dedicated[]
include::_attributes/attributes-openshift-dedicated.adoc[]
endif::[]
:context: using-insights-to-identify-issues-with-your-cluster
toc::[]
Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report in the *Insights* tab of each cluster on {cluster-manager-url}.
include::modules/insights-operator-advisor-overview.adoc[leveloffset=+1]
include::modules/insights-operator-advisor-recommendations.adoc[leveloffset=+1]
include::modules/displaying-potential-issues-with-your-cluster.adoc[leveloffset=+1]
include::modules/displaying-all-insights-advisor-recommendations.adoc[leveloffset=+1]
include::modules/disabling-insights-advisor-recommendations.adoc[leveloffset=+1]
include::modules/enabling-insights-advisor-recommendations.adoc[leveloffset=+1]
include::modules/displaying-the-insights-status-in-the-web-console.adoc[leveloffset=+1]

1
osd_support/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets