mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OCPBUGS#13156: Updates 4.11 and 4.12 with additional feeback recieved
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
0a2fed4553
commit
90257ce32a
@@ -747,19 +747,19 @@ Topics:
|
||||
File: customizing-the-web-console
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
- Name: Dynamic plugins
|
||||
Dir: dynamic-plug-in
|
||||
Dir: dynamic-plugin
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
Topics:
|
||||
- Name: Overview of dynamic plugins
|
||||
File: dynamic-plug-in
|
||||
File: overview-dynamic-plugin
|
||||
- Name: Getting started with dynamic plugins
|
||||
File: dynamic-plug-ins-get-started
|
||||
File: dynamic-plugins-get-started
|
||||
- Name: Deploy your plugin on a cluster
|
||||
File: deploy-plug-in-cluster
|
||||
File: deploy-plugin-cluster
|
||||
- Name: Dynamic plugin example
|
||||
File: dynamic-plug-in-example
|
||||
File: dynamic-plugin-example
|
||||
- Name: Dynamic plugin reference
|
||||
File: dynamic-plug-ins-reference
|
||||
File: dynamic-plugins-reference
|
||||
- Name: Web terminal
|
||||
Dir: web_terminal
|
||||
Distros: openshift-enterprise,openshift-online
|
||||
@@ -767,7 +767,7 @@ Topics:
|
||||
- Name: Installing the web terminal
|
||||
File: installing-web-terminal
|
||||
- Name: Configuring the web terminal
|
||||
File: configuring-web-terminal
|
||||
File: configuring-web-terminal
|
||||
- Name: Using the web terminal
|
||||
File: odc-using-web-terminal
|
||||
- Name: Troubleshooting the web terminal
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/dynamic-plugin-example.adoc
|
||||
// * web_console/dynamic-plugin/dynamic-plugin-example.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="adding-tab-to-pods-page_{context}"]
|
||||
@@ -22,15 +22,16 @@ The {product-title} web console runs in a container connected to the cluster you
|
||||
Custom plugin code is not supported by Red Hat. Only link:https://access.redhat.com/solutions/5893251[Cooperative community support] is available for your plugin.
|
||||
====
|
||||
|
||||
. Select the *Use this template* dropdown button and select *_Create new repository_* from the dropdown list to create a GitHub repository.
|
||||
. Create a GitHub repository for the template by clicking *Use this template* -> *_Create new repository_*.
|
||||
|
||||
. Re-name the new repository with the name of your plugin.
|
||||
. Rename the new repository with the name of your plugin.
|
||||
|
||||
. Clone your copied repository to your local machine so you can edit the code.
|
||||
. Clone the new repository to your local machine so you can edit the code.
|
||||
|
||||
. Edit the plugin metadata in the `consolePlugin` declaration of `package.json`.
|
||||
. Edit the `package.json` file, adding your plugin's metadata to the `consolePlugin` declaration. For example:
|
||||
+
|
||||
[source,json]
|
||||
|
||||
----
|
||||
"consolePlugin": {
|
||||
"name": "my-plugin", <1>
|
||||
@@ -97,5 +98,18 @@ export default function ExampleTab() {
|
||||
}
|
||||
----
|
||||
|
||||
. Install a Helm chart with the name of the plugin as the Helm release name into a new namespace or an existing namespace as specified by the `-n` command-line option to deploy your plugin on a cluster. Provide the location of the image within the `plugin.image` parameter by using the following command:
|
||||
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ helm upgrade -i my-plugin charts openshift-console-plugin -n my-plugin-namespace --create-namespace --set plugin image=my-plugin-image-location
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For more information on deploying your plugin on a cluster, see "Deploy your plugin on a cluster".
|
||||
====
|
||||
|
||||
.Verification
|
||||
* Visit a *Pod* page to view the added tab.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/deploy-plug-in-cluster.adoc
|
||||
// * web_console/dynamic-plugin/deploy-plugin-cluster.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="build-image-with-docker_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/deploy-plug-in-cluster.adoc
|
||||
// * web_console/dynamic-plugin/deploy-plugin-cluster.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="deploy-on-cluster_{context}"]
|
||||
@@ -27,7 +27,7 @@ Where:
|
||||
--
|
||||
|
||||
. Optional: You can specify any additional parameters by using the set of supported parameters in the `charts/openshift-console-plugin/values.yaml` file.
|
||||
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
plugin:
|
||||
@@ -86,7 +86,7 @@ plugin:
|
||||
----
|
||||
|
||||
.Verification
|
||||
You can see the list of the enabled plugins on the *Overview* page or by navigating from *Administration* -> *Cluster Settings* -> *Configuration* -> *Console* `operator.openshift.io` -> *Console plugins*.
|
||||
* View the list of enabled plugins by navigating from *Administration* -> *Cluster Settings* -> *Configuration* -> *Console* `operator.openshift.io` -> *Console plugins* or by visiting the *Overview* page.
|
||||
|
||||
|
||||
[NOTE]
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/deploy-plug-in-cluster.adoc
|
||||
// * web_console/dynamic-plugin/deploy-plugin-cluster.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="disabling-your-plug-in-browser_{context}"]
|
||||
[id="disabling-your-plugin-browser_{context}"]
|
||||
= Disabling your plugin in the browser
|
||||
|
||||
Console users can use the `disable-plugins` query parameter to disable specific or all dynamic plugins that would normally get loaded at run-time.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/dynamic-plug-ins-get-started.adoc
|
||||
// * web_console/dynamic-plugin/dynamic-plugins-get-started.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="dynamic-plugin-development_{context}"]
|
||||
|
||||
@@ -1,14 +1,13 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc
|
||||
// * web_console/dynamic-plugin/dynamic-plugins-reference.adoc
|
||||
|
||||
:power-bi-url: https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules_typedoc_node_modules_typescript_lib_lib_dom_d_.requestinit.html
|
||||
//needed to add an attribute for the url because escaping the underscore in the link would not work and the build was failing.
|
||||
|
||||
:_content-type: REFERENCE
|
||||
[id="dynamic-plug-in-api_{context}"]
|
||||
[id="dynamic-plugin-api_{context}"]
|
||||
= {product-title} console API
|
||||
:source-highlighter: rouge
|
||||
|
||||
[discrete]
|
||||
== `useActivePerspective`
|
||||
@@ -1,9 +1,9 @@
|
||||
// Module is included in the following assemblies:
|
||||
//
|
||||
// * web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc
|
||||
// * web_console/dynamic-plugin/dynamic-plugins-reference.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="dynamic-plug-in-sdk-extensions_{context}"]
|
||||
[id="dynamic-plugin-sdk-extensions_{context}"]
|
||||
= Dynamic plugin extension types
|
||||
|
||||
[discrete]
|
||||
@@ -1,9 +1,9 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc
|
||||
// * web_console/dynamic-plugin/dynamic-plugins-reference.adoc
|
||||
|
||||
:_content-type: REFERENCE
|
||||
[id="troubleshooting-dynamic-plug-in_{context}"]
|
||||
[id="troubleshooting-dynamic-plugin_{context}"]
|
||||
= Troubleshooting your dynamic plugin
|
||||
|
||||
Refer to this list of troubleshooting tips if you run into issues loading your plugin.
|
||||
@@ -1,8 +1,8 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="deploy-plug-in-cluster_{context}"]
|
||||
[id="deploy-plugin-cluster_{context}"]
|
||||
= Deploy your plugin on a cluster
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: deploy-plug-in-cluster
|
||||
:context: deploy-plugin-cluster
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -13,3 +13,8 @@ include::modules/build-image-docker.adoc[leveloffset=+1]
|
||||
include::modules/deployment-plug-in-cluster.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/disabling-plug-in-browser.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="dynamic-plugins_additional-resources"]
|
||||
== Additional resources
|
||||
* xref:../../applications/working_with_helm_charts/understanding-helm.adoc#understaning-helm[Understanding Helm]
|
||||
@@ -2,10 +2,10 @@
|
||||
[id="dynamic-plugin-example_{context}"]
|
||||
= Dynamic plugin example
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dynamic-plug-in-example
|
||||
:context: dynamic-plugin-example
|
||||
|
||||
toc::[]
|
||||
|
||||
Before working through the example, verify that the plugin is working by following the steps in xref:../../web_console/dynamic-plug-in/dynamic-plug-ins-get-started.adoc#dynamic-plugin-development_dynamic-plug-ins-get-started[Dynamic plugin development]
|
||||
Before working through the example, verify that the plugin is working by following the steps in xref:../../web_console/dynamic-plugin/dynamic-plugins-get-started.adoc#dynamic-plugin-development_dynamic-plugins-get-started[Dynamic plugin development]
|
||||
|
||||
include::modules/adding-tab-pods-page.adoc[leveloffset=+1]
|
||||
@@ -2,10 +2,10 @@
|
||||
[id="getting-started-with-dynamic-plugins_{context}"]
|
||||
= Getting started with dynamic plugins
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dynamic-plug-ins-get-started
|
||||
:context: dynamic-plugins-get-started
|
||||
|
||||
toc::[]
|
||||
|
||||
To get started using the dynamic plugin, you must set up your environment to write a new {product-title} dynamic plugin. For an example of how to write a new plugin, see xref:../../web_console/dynamic-plug-in/dynamic-plug-in-example.html#adding-tab-to-pods-page_dynamic-plug-in-example[Adding a tab to the pods page].
|
||||
To get started using the dynamic plugin, you must set up your environment to write a new {product-title} dynamic plugin. For an example of how to write a new plugin, see xref:../../web_console/dynamic-plugin/dynamic-plugin-example.html#adding-tab-to-pods-page_dynamic-plugin-example[Adding a tab to the pods page].
|
||||
|
||||
include::modules/dynamic-plug-in-development.adoc[leveloffset=+1]
|
||||
@@ -2,17 +2,17 @@
|
||||
[id="dynamic-plugins-reference_{context}"]
|
||||
= Dynamic plugin reference
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dynamic-plug-ins-reference
|
||||
:context: dynamic-plugins-reference
|
||||
|
||||
toc::[]
|
||||
|
||||
You can add extensions that allow you to customize your plugin. Those extensions are then loaded to the console at run-time.
|
||||
|
||||
include::modules/dynamic-plug-in-sdk-extensions.adoc[leveloffset=+1]
|
||||
include::modules/dynamic-plugin-sdk-extensions.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/dynamic-plug-in-api.adoc[leveloffset=+1]
|
||||
include::modules/dynamic-plugin-api.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/troubleshooting-dynamic-plug-in.adoc[leveloffset=+1]
|
||||
include::modules/troubleshooting-dynamic-plugin.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
@@ -1,8 +1,8 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="overview-of-dynamic-plug-ins_{context}"]
|
||||
[id="overview-of-dynamic-plugins_{context}"]
|
||||
= Overview of dynamic plugins
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: overview-of-dynamic-plug-ins
|
||||
:context: overview-of-dynamic-plugins
|
||||
|
||||
toc::[]
|
||||
|
||||
Reference in New Issue
Block a user