mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-14988
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
991312e20d
commit
414f151448
@@ -2,6 +2,7 @@
|
||||
[id="adding-user-preferences"]
|
||||
= Adding user preferences
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: adding-user-preferences
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="capabilities-products-web-console"]
|
||||
= Optional capabilities and products in the web console
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: capabilities-web-console
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="configuring-web-console"]
|
||||
= Configuring the web console in {product-title}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: configuring-web-console
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -3,6 +3,7 @@ ifndef::openshift-rosa,openshift-dedicated[]
|
||||
[id="creating-quick-start-tutorials"]
|
||||
= Creating quick start tutorials in the web console
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: creating-quick-start-tutorials
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
@@ -10,12 +11,15 @@ ifdef::openshift-rosa,openshift-dedicated[]
|
||||
[id="creating-quick-start-tutorials"]
|
||||
= About quick start tutorials
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: creating-quick-start-tutorials
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
|
||||
toc::[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
If you are creating quick start tutorials for the {product-title} web console, follow these guidelines to maintain a consistent user experience across all quick starts.
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
include::modules/understanding-quick-starts.adoc[leveloffset=+1]
|
||||
|
||||
@@ -24,7 +28,7 @@ include::modules/quick-start-user-workflow.adoc[leveloffset=+1]
|
||||
include::modules/quick-start-components.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding in ROSA/OSD, as dedicated-admins cannot create "consolequickstarts" resource
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/contributing-quick-starts.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/understanding-quick-start-elements.adoc[leveloffset=+2]
|
||||
@@ -49,4 +53,4 @@ include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
|
||||
|
||||
* For voice and tone requirements, refer to link:https://www.patternfly.org/ux-writing/brand-voice-and-tone[PatternFly's brand voice and tone guidelines].
|
||||
* For other UX content guidance, refer to all areas of link:https://www.patternfly.org/ux-writing/about[PatternFly's UX writing style guide].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="customizing-web-console"]
|
||||
= Customizing the web console in {product-title}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: customizing-web-console
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="disabling-web-console"]
|
||||
= Disabling the web console in {product-title}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: disabling-web-console
|
||||
|
||||
toc::[]
|
||||
@@ -10,6 +11,16 @@ You can disable the {product-title} web console.
|
||||
|
||||
== Prerequisites
|
||||
|
||||
* Deploy an {product-title} cluster.
|
||||
* Deploy
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
an {product-title}
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
a {rosa-short}
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa[]
|
||||
a {rosa-classic-short}
|
||||
endif::openshift-rosa[]
|
||||
cluster.
|
||||
|
||||
include::modules/web-console-disable.adoc[leveloffset=+1]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="content-security-policy_{context}"]
|
||||
= Content Security Policy (CSP)
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: content-security-policy
|
||||
|
||||
toc::[]
|
||||
@@ -12,7 +13,9 @@ You can specify Content Security Policy (CSP) directives for your dynamic plugin
|
||||
====
|
||||
The console currently uses the `Content-Security-Policy-Report-Only` response header, so the browser will only warn about CSP violations in the web console and enforcement of CSP policies will be limited. CSP violations will be logged in the browser console, but the associated CSP directives will not be enforced. This feature is behind a `feature-gate`, so you will need to manually enable it.
|
||||
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
For more information, see xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features-console_nodes-cluster-enabling[Enabling feature sets using the web console].
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
====
|
||||
|
||||
include::modules/csp-overview.adoc[leveloffset=+1]
|
||||
|
||||
@@ -2,11 +2,19 @@
|
||||
[id="deploy-plugin-cluster_{context}"]
|
||||
= Deploy your plugin on a cluster
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: deploy-plugin-cluster
|
||||
|
||||
toc::[]
|
||||
|
||||
You can deploy the plugin to a {product-title} cluster.
|
||||
You can deploy the plugin to
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
an {product-title}
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp,openshift-rosa[]
|
||||
a {product-title}
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
cluster.
|
||||
|
||||
include::modules/build-image-docker.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="dynamic-plugin-example_{context}"]
|
||||
= Dynamic plugin example
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: dynamic-plugin-example
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="getting-started-with-dynamic-plugins_{context}"]
|
||||
= Getting started with dynamic plugins
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: dynamic-plugins-get-started
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="dynamic-plugins-reference_{context}"]
|
||||
= Dynamic plugin reference
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: dynamic-plugins-reference
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="overview-of-dynamic-plugins_{context}"]
|
||||
= Overview of dynamic plugins
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: overview-of-dynamic-plugins
|
||||
|
||||
toc::[]
|
||||
@@ -53,8 +54,17 @@ conster Header: React.FC ++= () => {++
|
||||
When creating your plugin, follow these guidelines for using PatternFly:
|
||||
|
||||
* Use link:https://www.patternfly.org/components/all-components/[PatternFly] components and PatternFly CSS variables. Core PatternFly components are available through the SDK. Using PatternFly components and variables help your plugin look consistent in future console versions.
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
** Use Patternfly 4.x if you are using {product-title} versions 4.14 and earlier.
|
||||
** Use Patternfly 5.x if you are using {product-title} 4.15 or later.
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
** Use Patternfly 5.x.
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa[]
|
||||
** Use Patternfly 4.x if you are using {rosa-classic-short} versions 4.14 and earlier.
|
||||
** Use Patternfly 5.x if you are using {rosa-classic-short} 4.15 or later.
|
||||
endif::openshift-rosa[]
|
||||
* Make your plugin accessible by following link:https://www.patternfly.org/accessibility/accessibility-fundamentals/[PatternFly's accessibility fundamentals].
|
||||
* Avoid using other CSS libraries such as Bootstrap or Tailwind. They might conflict with PatternFly and not match the rest of the console. Plugins should only include styles that are specific to their user interfaces to be evaluated on top of base PatternFly styles. Avoid importing styles such as `@patternfly/react-styles/**/*.css` or any styles from the `@patternfly/patternfly` package in your plugin.
|
||||
* The console application is responsible for loading base styles for all supported PatternFly version(s).
|
||||
|
||||
@@ -1,13 +1,31 @@
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="using-dashboard-to-get-cluster-info"]
|
||||
= Using the {product-title} dashboard to get cluster information
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: using-dashboard-to-get-cluster-info
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="using-dashboard-to-get-cluster-info"]
|
||||
= Using the {rosa-short} dashboard to get cluster information
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: using-dashboard-to-get-cluster-info
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa[]
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="using-dashboard-to-get-cluster-info"]
|
||||
= Using the {rosa-classic-short} dashboard to get cluster information
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: using-dashboard-to-get-cluster-info
|
||||
endif::openshift-rosa[]
|
||||
|
||||
toc::[]
|
||||
|
||||
The {product-title} web console captures high-level information
|
||||
about the cluster.
|
||||
The {product-title} web console captures high-level information about the cluster.
|
||||
|
||||
include::modules/virt-about-the-overview-dashboard.adoc[leveloffset=+1]
|
||||
include::modules/recognize-resource-limits-quotas.adoc[leveloffset=+1]
|
||||
|
||||
@@ -2,15 +2,28 @@
|
||||
[id="web-console-overview"]
|
||||
= Web Console Overview
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: web-console-overview
|
||||
|
||||
toc::[]
|
||||
|
||||
The Red Hat {product-title} web console provides a graphical user interface to visualize your project data and perform administrative, management, and troubleshooting tasks. The web console runs as pods on the control plane nodes in the openshift-console project. It is managed by a `console-operator` pod.
|
||||
The {product-title} web console provides a graphical user interface to visualize your project data and perform administrative, management, and troubleshooting tasks. The web console runs as pods on the control plane nodes in the openshift-console project. It is managed by a `console-operator` pod.
|
||||
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
You can create quick start tutorials for {product-title} that provide guided steps within the web console with user tasks. They are helpful for getting oriented with an application, Operator, or other product offering.
|
||||
You can create quick start tutorials for
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
{product-title}
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
{rosa-short}
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa[]
|
||||
{rosa-classic-short}
|
||||
endif::openshift-rosa[]
|
||||
that provide guided steps within the web console with user tasks. They are helpful for getting oriented with an application, Operator, or other product offering.
|
||||
|
||||
include::modules/about-administrator_web-console.adoc[leveloffset=+1]
|
||||
include::modules/about-developer_web-console.adoc[leveloffset=+1]
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
[id="web-console"]
|
||||
= Accessing the web console
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: web-console
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="configuring-web-terminal"]
|
||||
= Configuring the web terminal
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: configuring-web-terminal
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="installing-web-terminal"]
|
||||
= Installing the web terminal
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: installing-web-terminal
|
||||
|
||||
toc::[]
|
||||
@@ -12,7 +13,17 @@ You can install the web terminal by using the {web-terminal-op} listed in the {p
|
||||
[id="prerequisites_installing-web-terminal"]
|
||||
== Prerequisites
|
||||
|
||||
* You are logged into the {product-title} web console.
|
||||
* You are logged into the
|
||||
ifndef::openshift-rosa-hcp,openshift-rosa[]
|
||||
{product-title}
|
||||
endif::openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
{rosa-short}
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa[]
|
||||
{rosa-classic-short}
|
||||
endif::openshift-rosa[]
|
||||
web console.
|
||||
* You have cluster administrator permissions.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="odc-using-web-terminal"]
|
||||
= Using the web terminal
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: odc-using-web-terminal
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="troubleshooting-web-terminal"]
|
||||
= Troubleshooting the web terminal
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: troubleshooting-web-terminal
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
[id="uninstalling-web-terminal"]
|
||||
= Uninstalling the web terminal
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: uninstalling-web-terminal
|
||||
|
||||
toc::[]
|
||||
|
||||
Reference in New Issue
Block a user