diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 8965d214b7..a04fea130f 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -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 diff --git a/modules/adding-tab-pods-page.adoc b/modules/adding-tab-pods-page.adoc index 52e5ab2f58..a51172c1fd 100644 --- a/modules/adding-tab-pods-page.adoc +++ b/modules/adding-tab-pods-page.adoc @@ -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. diff --git a/modules/build-image-docker.adoc b/modules/build-image-docker.adoc index a3d38fb6b2..9c6a6cabd4 100644 --- a/modules/build-image-docker.adoc +++ b/modules/build-image-docker.adoc @@ -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}"] diff --git a/modules/deployment-plug-in-cluster.adoc b/modules/deployment-plug-in-cluster.adoc index 8d3c1dff49..1e45723984 100644 --- a/modules/deployment-plug-in-cluster.adoc +++ b/modules/deployment-plug-in-cluster.adoc @@ -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] diff --git a/modules/disabling-plug-in-browser.adoc b/modules/disabling-plug-in-browser.adoc index 8d0f81be88..465c1b1a86 100644 --- a/modules/disabling-plug-in-browser.adoc +++ b/modules/disabling-plug-in-browser.adoc @@ -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. diff --git a/modules/dynamic-plug-in-development.adoc b/modules/dynamic-plug-in-development.adoc index 6329063fb6..e7fc7936f8 100644 --- a/modules/dynamic-plug-in-development.adoc +++ b/modules/dynamic-plug-in-development.adoc @@ -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}"] diff --git a/modules/dynamic-plug-in-api.adoc b/modules/dynamic-plugin-api.adoc similarity index 99% rename from modules/dynamic-plug-in-api.adoc rename to modules/dynamic-plugin-api.adoc index e193e5ce6c..f7b3357eac 100644 --- a/modules/dynamic-plug-in-api.adoc +++ b/modules/dynamic-plugin-api.adoc @@ -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` diff --git a/modules/dynamic-plug-in-sdk-extensions.adoc b/modules/dynamic-plugin-sdk-extensions.adoc similarity index 99% rename from modules/dynamic-plug-in-sdk-extensions.adoc rename to modules/dynamic-plugin-sdk-extensions.adoc index b1df6c6edc..71cdc58619 100644 --- a/modules/dynamic-plug-in-sdk-extensions.adoc +++ b/modules/dynamic-plugin-sdk-extensions.adoc @@ -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] diff --git a/modules/troubleshooting-dynamic-plug-in.adoc b/modules/troubleshooting-dynamic-plugin.adoc similarity index 95% rename from modules/troubleshooting-dynamic-plug-in.adoc rename to modules/troubleshooting-dynamic-plugin.adoc index 50dff5d955..fe145f45ce 100644 --- a/modules/troubleshooting-dynamic-plug-in.adoc +++ b/modules/troubleshooting-dynamic-plugin.adoc @@ -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. diff --git a/web_console/dynamic-plug-in/_attributes b/web_console/dynamic-plugin/_attributes similarity index 100% rename from web_console/dynamic-plug-in/_attributes rename to web_console/dynamic-plugin/_attributes diff --git a/web_console/dynamic-plug-in/deploy-plug-in-cluster.adoc b/web_console/dynamic-plugin/deploy-plugin-cluster.adoc similarity index 55% rename from web_console/dynamic-plug-in/deploy-plug-in-cluster.adoc rename to web_console/dynamic-plugin/deploy-plugin-cluster.adoc index c92a5ab37d..baf50c2c95 100644 --- a/web_console/dynamic-plug-in/deploy-plug-in-cluster.adoc +++ b/web_console/dynamic-plugin/deploy-plugin-cluster.adoc @@ -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] diff --git a/web_console/dynamic-plug-in/dynamic-plug-in-example.adoc b/web_console/dynamic-plugin/dynamic-plugin-example.adoc similarity index 67% rename from web_console/dynamic-plug-in/dynamic-plug-in-example.adoc rename to web_console/dynamic-plugin/dynamic-plugin-example.adoc index 8eda8c9a68..1222befd5e 100644 --- a/web_console/dynamic-plug-in/dynamic-plug-in-example.adoc +++ b/web_console/dynamic-plugin/dynamic-plugin-example.adoc @@ -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] diff --git a/web_console/dynamic-plug-in/dynamic-plug-ins-get-started.adoc b/web_console/dynamic-plugin/dynamic-plugins-get-started.adoc similarity index 72% rename from web_console/dynamic-plug-in/dynamic-plug-ins-get-started.adoc rename to web_console/dynamic-plugin/dynamic-plugins-get-started.adoc index e717ebb895..3a943912bb 100644 --- a/web_console/dynamic-plug-in/dynamic-plug-ins-get-started.adoc +++ b/web_console/dynamic-plugin/dynamic-plugins-get-started.adoc @@ -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] diff --git a/web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc b/web_console/dynamic-plugin/dynamic-plugins-reference.adoc similarity index 68% rename from web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc rename to web_console/dynamic-plugin/dynamic-plugins-reference.adoc index 0fcd0b4f45..3723ce3770 100644 --- a/web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc +++ b/web_console/dynamic-plugin/dynamic-plugins-reference.adoc @@ -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 diff --git a/web_console/dynamic-plug-in/images b/web_console/dynamic-plugin/images similarity index 100% rename from web_console/dynamic-plug-in/images rename to web_console/dynamic-plugin/images diff --git a/web_console/dynamic-plug-in/modules b/web_console/dynamic-plugin/modules similarity index 100% rename from web_console/dynamic-plug-in/modules rename to web_console/dynamic-plugin/modules diff --git a/web_console/dynamic-plug-in/dynamic-plug-in.adoc b/web_console/dynamic-plugin/overview-dynamic-plugin.adoc similarity index 96% rename from web_console/dynamic-plug-in/dynamic-plug-in.adoc rename to web_console/dynamic-plugin/overview-dynamic-plugin.adoc index 2839c3394d..439be6c3ba 100644 --- a/web_console/dynamic-plug-in/dynamic-plug-in.adoc +++ b/web_console/dynamic-plugin/overview-dynamic-plugin.adoc @@ -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::[] diff --git a/web_console/dynamic-plug-in/snippets b/web_console/dynamic-plugin/snippets similarity index 100% rename from web_console/dynamic-plug-in/snippets rename to web_console/dynamic-plugin/snippets