Skip to content
Open
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
2 changes: 2 additions & 0 deletions _attributes/attributes-openshift-dedicated.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
:sts-short: STS
:insights-operator: Insights Operator
:red-hat-lightspeed: Red{nbsp}Hat Lightspeed
:rhl-advisor: Red{nbsp}Hat Lightspeed Advisor
:rhl-advisor-service: Red{nbsp}Hat Lightspeed advisor service
:autonode: Red{nbsp}Hat build of Karpenter
//logging
:logging-title: logging for Red Hat OpenShift
Expand Down
2 changes: 2 additions & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ endif::[]
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Advisor]
:insights-operator: Insights Operator
:red-hat-lightspeed: Red{nbsp}Hat Lightspeed
:rhl-advisor: Red{nbsp}Hat Lightspeed Advisor
:rhl-advisor-service: Red{nbsp}Hat Lightspeed advisor service
:hybrid-console: Red{nbsp}Hat Hybrid Cloud Console
:hybrid-console-second: Hybrid Cloud Console
:hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
Expand Down
2 changes: 1 addition & 1 deletion architecture/ocm-overview-ocp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Selecting an active, installed cluster shows tabs associated with that cluster.
* Add-ons
* Networking
* Machine pools
* {red-hat-lightspeed} Advisor
* {rhl-advisor}
* Support
* Settings

Expand Down
6 changes: 3 additions & 3 deletions modules/about-insights-advisor-workload-recommendations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

:_mod-docs-content-type: CONCEPT
[id="about-insights-advisor-workload-recommendations_{context}"]
= About {red-hat-lightspeed} advisor service recommendations for workloads
= About {rhl-advisor-service} recommendations for workloads

[role="_abstract"]
You can use the {red-hat-lightspeed} advisor service to view and manage information about recommendations that affect not only your clusters, but also your workloads. The advisor service takes advantage of deployment validation and helps OpenShift cluster administrators to see all runtime violations of deployment policies. You can see recommendations for workloads at link:https://console.redhat.com/openshift/insights/advisor/workloads[OpenShift > Advisor > Workloads] on the {hybrid-console}. For more information, see these additional resources:
You can use the {rhl-advisor-service} to view and manage information about recommendations that affect not only your clusters, but also your workloads. The advisor service takes advantage of deployment validation and helps OpenShift cluster administrators to see all runtime violations of deployment policies. You can see recommendations for workloads at link:https://console.redhat.com/openshift/insights/advisor/workloads[OpenShift > Advisor > Workloads] on the {hybrid-console}. For more information, see these additional resources:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.


* link:https://kubernetes.io/docs/concepts/workloads/[Information about Kubernetes workloads]
* https://www.redhat.com/en/blog/boost-your-cluster-operations-with-deployment-validation-and-insights-advisor-for-workloads[Boost your cluster operations with Deployment Validation and {red-hat-lightspeed} Advisor for Workloads]
* https://www.redhat.com/en/blog/boost-your-cluster-operations-with-deployment-validation-and-insights-advisor-for-workloads[Boost your cluster operations with Deployment Validation and {rhl-advisor} for Workloads]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#identifying-workload-recommendations-for-namespaces-in-clusters_using-insights-advisor[Identifying workload recommendations for namespaces in your clusters]
* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#viewing-workload-recommendations-for-namespaces_using-insights-advisor[Viewing workload recommendations for namespaces in your cluster]
* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#excluding-objects-from-workload-recommendations_using-insights-advisor[Excluding objects from workload recommendations in your clusters]
2 changes: 1 addition & 1 deletion modules/disabling-insights-advisor-recommendations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="disabling-insights-advisor-recommendations_{context}"]
= Disabling {red-hat-lightspeed} advisor service recommendations
= Disabling {rhl-advisor-service} recommendations

[role="_abstract"]
You can disable specific recommendations that affect your clusters, so that they no longer appear in your reports. It is possible to disable a recommendation for a single cluster or all of your clusters.
Expand Down
2 changes: 1 addition & 1 deletion modules/disabling-insights-operator-gather.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,5 @@ After you save the changes, the {insights-operator} gather configurations are up

[NOTE]
====
Disabling gather operations restricts the ability of the {red-hat-lightspeed} advisor service to offer effective recommendations for your cluster.
Disabling gather operations restricts the ability of the {rhl-advisor-service} to offer effective recommendations for your cluster.
====
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="displaying-all-insights-advisor-recommendations_{context}"]
= Displaying all {red-hat-lightspeed} advisor service recommendations
= Displaying all {rhl-advisor-service} recommendations

[role="_abstract"]
The Recommendations view, by default, only displays the recommendations that are detected on your clusters. However, you can view all of the recommendations in the advisor service's archive.
Expand Down
4 changes: 2 additions & 2 deletions modules/displaying-potential-issues-with-your-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Displaying potential issues with your cluster

[role="_abstract"]
This section describes how to display the {red-hat-lightspeed} report in *{red-hat-lightspeed} Advisor* on {cluster-manager-url}.
This section describes how to display the {red-hat-lightspeed} report in *{rhl-advisor}* on {cluster-manager-url}.

Note that {red-hat-lightspeed} repeatedly analyzes your cluster and shows the latest results. These results can change, for example, if you fix an issue or a new issue has been detected.

Expand All @@ -21,7 +21,7 @@ Note that {red-hat-lightspeed} repeatedly analyzes your cluster and shows the la

. Navigate to *Advisor* -> *Recommendations* on {cluster-manager-url}.
+
Depending on the result, the {red-hat-lightspeed} advisor service displays one of the following:
Depending on the result, the {rhl-advisor-service} displays one of the following:
+
* *No matching recommendations found*, if {red-hat-lightspeed} did not identify any issues.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@

. Click *{red-hat-lightspeed}* on the *Status* card.
+
The pop-up window lists potential issues grouped by risk. Click the individual categories or *View all recommendations in {red-hat-lightspeed} Advisor* to display more details.
The pop-up window lists potential issues grouped by risk. Click the individual categories or *View all recommendations in {rhl-advisor}* to display more details.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'window' rather than 'pop-up window'. For more information, see RedHat.TermsErrors.

4 changes: 2 additions & 2 deletions modules/enabling-insights-advisor-recommendations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

:_mod-docs-content-type: PROCEDURE
[id="enabling-insights-advisor-recommendations_{context}"]
= Enabling a previously disabled {red-hat-lightspeed} advisor service recommendation
= Enabling a previously disabled {rhl-advisor-service} recommendation

[role="_abstract"]
When a recommendation is disabled for all clusters, you no longer see the recommendation in the {red-hat-lightspeed} advisor service. You can change this behavior.
When a recommendation is disabled for all clusters, you no longer see the recommendation in the {rhl-advisor-service}. You can change this behavior.

.Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion modules/enabling-insights-operator-gather.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ After you save the changes, the {insights-operator} gather configurations are up
+
[NOTE]
====
Disabling gather operations restricts the ability of the {red-hat-lightspeed} advisor service to offer effective recommendations for your cluster.
Disabling gather operations restricts the ability of the {rhl-advisor-service} to offer effective recommendations for your cluster.
====
2 changes: 1 addition & 1 deletion modules/filtering-insights-advisor-recommendations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="filtering-unnecessary-advisor-recommendations_{context}"]
= Filtering {red-hat-lightspeed} advisor service recommendations
= Filtering {rhl-advisor-service} recommendations

[role="_abstract"]
As an {product-title} cluster manager, you can filter the recommendations that are displayed on the recommendations list. By applying filters, you can reduce the number of reported recommendations and concentrate on your highest priority recommendations.
Expand Down
2 changes: 1 addition & 1 deletion modules/insights-advisor-recommendations-filters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Advisor recommendation filters

[role="_abstract"]
The {red-hat-lightspeed} advisor service can return a large number of recommendations. To focus on your most critical recommendations, you can apply filters to the https://console.redhat.com/openshift/insights/advisor/recommendations[Advisor recommendations] list to remove low-priority recommendations.
The {rhl-advisor-service} can return a large number of recommendations. To focus on your most critical recommendations, you can apply filters to the https://console.redhat.com/openshift/insights/advisor/recommendations[Advisor recommendations] list to remove low-priority recommendations.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.


By default, filters are set to only show enabled recommendations that are impacting one or more clusters. To view all or disabled recommendations in the {red-hat-lightspeed} library, you can customize the filters.

Expand Down
6 changes: 3 additions & 3 deletions modules/insights-operator-advisor-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

:_mod-docs-content-type: CONCEPT
[id="insights-operator-advisor-overview_{context}"]
= About {red-hat-lightspeed} Advisor for {product-title}
= About {rhl-advisor} for {product-title}

[role="_abstract"]
You can use the {red-hat-lightspeed} advisor service to assess and monitor the health of your {product-title} clusters. Whether you are concerned about individual clusters, or with your whole infrastructure, it is important to be aware of the exposure of your cluster infrastructure to issues that can affect service availability, fault tolerance, performance, or security.
You can use the {rhl-advisor-service} to assess and monitor the health of your {product-title} clusters. Whether you are concerned about individual clusters, or with your whole infrastructure, it is important to be aware of the exposure of your cluster infrastructure to issues that can affect service availability, fault tolerance, performance, or security.

If the cluster has the Deployment Validation Operator (DVO) installed the recommendations also highlight workloads whose configuration might lead to cluster health issues.

The results of the {red-hat-lightspeed} analysis are available in the {red-hat-lightspeed} advisor service on {hybrid-console}. In the {hybrid-console}, you can perform the following actions:
The results of the {red-hat-lightspeed} analysis are available in the {rhl-advisor-service} on {hybrid-console}. In the {hybrid-console}, you can perform the following actions:


* View clusters and workloads affected by specific recommendations.
Expand Down
6 changes: 3 additions & 3 deletions modules/insights-operator-advisor-recommendations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

:_mod-docs-content-type: CONCEPT
[id="insights-operator-advisor-recommendations_{context}"]
= Understanding {red-hat-lightspeed} advisor service recommendations
= Understanding {rhl-advisor-service} recommendations

[role="_abstract"]
The {red-hat-lightspeed} advisor service bundles information about various cluster states and component configurations that can negatively affect the service availability, fault tolerance, performance, or security of your clusters and workloads. This information set is called a recommendation in the {red-hat-lightspeed} advisor service. Recommendations for clusters includes the following information:
The {rhl-advisor-service} bundles information about various cluster states and component configurations that can negatively affect the service availability, fault tolerance, performance, or security of your clusters and workloads. This information set is called a recommendation in the {rhl-advisor-service}. Recommendations for clusters includes the following information:

* *Name:* A concise description of the recommendation
* *Added:* When the recommendation was published to the {red-hat-lightspeed} advisor service archive
* *Added:* When the recommendation was published to the {rhl-advisor-service} archive
* *Category:* Whether the issue has the potential to negatively affect service availability, fault tolerance, performance, or security
* *Total risk:* A value derived from the _likelihood_ that the condition will negatively affect your cluster or workload, and the _impact_ on operations if that were to happen
* *Clusters:* A list of clusters on which a recommendation is detected
Expand Down
2 changes: 1 addition & 1 deletion modules/insights-operator-gather-duration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Viewing {insights-operator} gather durations

[role="_abstract"]
You can view the time it takes for the {insights-operator} to gather the information contained in the archive. This helps you to understand {insights-operator} resource usage and issues with {red-hat-lightspeed} Advisor.
You can view the time it takes for the {insights-operator} to gather the information contained in the archive. This helps you to understand {insights-operator} resource usage and issues with {rhl-advisor}.


.Prerequisites
Expand Down
6 changes: 3 additions & 3 deletions modules/insights-operator-manual-upload.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ If the operation is successful, the command returns a `"request_id"` and `"accou

. To display the details of the cluster, click the cluster name.

. Open the *{red-hat-lightspeed} Advisor* tab of the cluster.
. Open the *{rhl-advisor}* tab of the cluster.
+
If the upload was successful, the tab displays one of the following:
+
* *Your cluster passed all recommendations*, if the {red-hat-lightspeed} advisor service did not identify any issues.
* *Your cluster passed all recommendations*, if the {rhl-advisor-service} did not identify any issues.

* A list of issues that the {red-hat-lightspeed} advisor service has detected, prioritized by risk (low, moderate, important, and critical).
* A list of issues that the {rhl-advisor-service} has detected, prioritized by risk (low, moderate, important, and critical).
2 changes: 1 addition & 1 deletion modules/insights-operator.adoc

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.DocumentTitle: The document title (=) is missing.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ifdef::cluster-caps[]
The {insights-operator} provides the features for the `Insights` capability.
endif::cluster-caps[]

The {insights-operator} gathers {product-title} configuration data and sends it to Red{nbsp}Hat. The data is used to produce proactive insights recommendations about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators through the {red-hat-lightspeed} advisor service on link:https://console.redhat.com/[console.redhat.com].
The {insights-operator} gathers {product-title} configuration data and sends it to Red{nbsp}Hat. The data is used to produce proactive insights recommendations about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators through the {rhl-advisor-service} on link:https://console.redhat.com/[console.redhat.com].

ifdef::operator-ref[]
Project::
Expand Down
4 changes: 2 additions & 2 deletions modules/ocm-insightsadvisor-tab.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

:_mod-docs-content-type: CONCEPT
[id="ocm-insightsadvisor-tab_{context}"]
= {red-hat-lightspeed} Advisor tab
= {rhl-advisor} tab

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.


The **{red-hat-lightspeed} Advisor** tab uses the Remote Health functionality of the OpenShift Container Platform to identify and mitigate risks to security, performance, availability, and stability. See link:https://docs.openshift.com/container-platform/latest/support/getting-support.html[Using {red-hat-lightspeed} to identify issues with your cluster] in the {OCP} documentation.
The **{rhl-advisor}** tab uses the Remote Health functionality of the OpenShift Container Platform to identify and mitigate risks to security, performance, availability, and stability. See link:https://docs.openshift.com/container-platform/latest/support/getting-support.html[Using {red-hat-lightspeed} to identify issues with your cluster] in the {OCP} documentation.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="removing-filters-from-insights-recommendations_{context}"]
= Removing filters from {red-hat-lightspeed} advisor service recommendations
= Removing filters from {rhl-advisor-service} recommendations

[role="_abstract"]
You can apply multiple filters to the list of recommendations. When ready, you can remove them individually or completely reset them.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ Required::

| `advisorURI`
| `string`
| advisorURI is required field that provides the URL link to the Insights Advisor.
| advisorURI is required field that provides the URL link to the Red Hat Lightspeed Advisor.
The link must be a valid HTTPS URL and the maximum length is 2048 characters.

| `description`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -464,15 +464,15 @@ Required::

| `advisorURI`
| `string`
| advisorURI provides the URL link to the Insights Advisor.
| advisorURI provides the URL link to the Red Hat Lightspeed Advisor.

| `description`
| `string`
| description provides basic description of the healtcheck.

| `state`
| `string`
| state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor user interface.
| state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Red Hat Lightspeed Advisor user interface.

| `totalRisk`
| `integer`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ You can optionally customize the following items for the on-demand data gather o

[IMPORTANT]
====
Excluding gather operations from the default list might reduce or limit the recommendations offered by the {red-hat-lightspeed} advisor service for your cluster.
Excluding gather operations from the default list might reduce or limit the recommendations offered by the {rhl-advisor-service} for your cluster.
====


Expand Down