OSDOCS-4073: Dynamic plug-in doc updates

Author: opayne1

_topic_maps/_topic_map.yml

@@ -656,8 +656,19 @@ Topics:
   File: customizing-the-web-console
   Distros: openshift-enterprise,openshift-origin
 - Name: Dynamic plug-ins
-  File: dynamic-plug-ins
+  Dir: dynamic-plug-in
   Distros: openshift-enterprise,openshift-origin
+  Topics: 
+  - Name: Overview of dynamic plug-ins
+    File: dynamic-plug-in
+  - Name: Getting started with dynamic plug-ins
+    File: dynamic-plug-ins-get-started
+  - Name: Deploy your plug-in on a cluster
+    File: deploy-plug-in-cluster
+  - Name: Dynamic plug-in example
+    File: dynamic-plug-in-example
+  - Name: Dynamic plug-in reference
+    File: dynamic-plug-ins-reference
 - Name: Web terminal
   File: odc-about-web-terminal
   Distros: openshift-enterprise,openshift-online

modules/adding-new-extension-dynamic-plug-in.adoc

@@ -1,14 +1,55 @@
 // Module included in the following assemblies:
 //
-// * web_console/dynamic-plug-ins.adoc
+// * web_console/dynamic-plugin-example.adoc
 
 :_content-type: PROCEDURE
 [id="adding-tab-to-pods-page_{context}"]
 = Adding a tab to the pods page
-The following procedure adds a tab to the *Pod Details* page as an example extension to your plug-in.
+
+There are different customizations you can make to the {product-title} web console. The following procedure adds a tab to the *Pod details* page as an example extension to your plug-in.
+
+[NOTE]
+====
+The {product-title} web console runs in a container connected to the cluster you have logged into. See "Dynamic plug-in development" for information to test the plug-in before creating your own.
+====
 
 .Procedure
 
+. Visit the link:https://github.com/openshift/console-plugin-template[`console-plugin-template`] repository containing a template for creating plug-ins in a new tab.
++
+[IMPORTANT]
+====
+Custom plug-in code is not supported by Red Hat. Only link:https://access.redhat.com/solutions/5893251[Cooperative community support] is available for your plug-in.
+====
+
+. Select the *Use this template* dropdown button and select *_Create new repository_* from the dropdown list to create a GitHub repository.
+
+. Re-name the new repository with the name of your plug-in.
+
+. Clone your copied repositury to your local machine so you can edit the code.
+
+. Edit the plug-in metadata in the `consolePlugin` declaration of `package.json`.
++
+[source,json]
+----
+"consolePlugin": {
+  "name": "my-plugin", <1>
+  "version": "0.0.1", <2>
+  "displayName": "My Plugin", <3>
+  "description": "Enjoy this shiny, new console plugin!", <4>
+  "exposedModules": {
+    "ExamplePage": "./components/ExamplePage"
+  },
+  "dependencies": {
+    "@console/pluginAPI": "/*"
+  }
+}
+----
+<1> Update the name of your plug-in.
+<2> Update the version.
+<3> Update the display name for your plug-in.
+<4> Update the description with a synopsis about your plug-in.
+
 . Add the following to the `console-extensions.json` file:
 +
 [source,json]
@@ -57,4 +98,4 @@ export default function ExampleTab() {
 ----
 
 .Verification
-* Visit a *Pod* page to view the added tab.
+* Visit a *Pod* page to view the added tab.

modules/adding-tab-pods-page.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * web_console/dynamic-plug-ins.adoc
+// * web_console/deploy-plug-in-cluster.adoc
 
 :_content-type: PROCEDURE
 [id="build-image-with-docker_{context}"]

modules/build-image-docker.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * web_console/dynamic-plug-ins.adoc
+// * web_console/deploy-plug-in-cluster.adoc
 
 :_content-type: PROCEDURE
 [id="deploy-on-cluster_{context}"]
@@ -10,32 +10,86 @@ After pushing an image with your changes to a registry, you can deploy the plug-
 
 .Procedure
 
-. To deploy your plug-in to a cluster, instantiate your plug-in by running the following command:
+. To deploy your plug-in to a cluster, install a Helm chart with the name of the plug-in as the Helm release name into a new namespace or an existing namespace as specified by the `-n` command-line option. Provide the location of the image within the `plugin.image` parameter by using the following command:
+
 +
 [source,terminal]
 ----
-$ oc process -f template.yaml \
-  -p PLUGIN_NAME=my-plugin \ <1>
-  -p NAMESPACE=my-plugin-namespace \ <2>
-  -p IMAGE=quay.io/my-repository/my-plugin:latest \ <3>
-  | oc create -f -
+$ helm upgrade -i  my-plugin charts/openshift-console-plugin -n my-plugin-namespace --create-namespace --set plugin.image=my-plugin-image-location
 ----
-<1> Update with the name of your plug-in.
-<2> Update with the namespace.
-<3> Update with the name of the image you created.
 +
-This command runs a light-weight NGINX HTTP server to serve the assets for your plug-in.
-
-[IMPORTANT]
-====
-`PLUGIN_NAME` must match the plug-in name you used in the `consolePlugin` declaration of `package.json`.
-====
-
-[start=2]
-. Patch the *Console Operator* configuration to enable the plug-in by running the following command:
+Where:
 +
-[source,terminal]
+--
+`n <my-plugin-namespace>`:: Specifies an existing namespace to deploy your plug-in into.
+`--create-namespace`:: Optional: If deploying to a new namespace, use this parameter.
+`--set plugin.image=my-plugin-image-location`:: Specifies the location of the image within the `plugin.image` parameter.
+--
 
+. 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]
 ----
-$ oc patch consoles.operator.openshift.io cluster --patch '{ "spec": { "plugins": ["my-plugin"] } }' --type=merge
+plugin:
+  name: ""
+  description: ""
+  image: ""
+  imagePullPolicy: IfNotPresent
+  replicas: 2
+  port: 9443
+  securityContext:
+    enabled: true
+  podSecurityContext:
+    enabled: true
+    runAsNonRoot: true
+    seccompProfile:
+      type: RuntimeDefault
+  containerSecurityContext:
+    enabled: true
+    allowPrivilegeEscalation: false
+    capabilities:
+      drop:
+        - ALL
+  resources:
+    requests:
+      cpu: 10m
+      memory: 50Mi
+  basePath: /
+  certificateSecretName: ""
+  serviceAccount:
+    create: true
+    annotations: {}
+    name: ""
+  patcherServiceAccount:
+    create: true
+    annotations: {}
+    name: ""
+  jobs:
+    patchConsoles:
+      enabled: true
+      image: "registry.redhat.io/openshift4/ose-tools-rhel8@sha256:e44074f21e0cca6464e50cb6ff934747e0bd11162ea01d522433a1a1ae116103"
+      podSecurityContext:
+        enabled: true
+        runAsNonRoot: true
+        seccompProfile:
+          type: RuntimeDefault
+      containerSecurityContext:
+        enabled: true
+        allowPrivilegeEscalation: false
+        capabilities:
+          drop:
+            - ALL
+      resources:
+        requests:
+          cpu: 10m
+          memory: 50Mi
 ----
+
+.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*.
+
+
+[NOTE]
+====
+It can take a few minutes for the new plug-in configuration to appear. If you do not see your plug-in, you might need to refresh your browser if the plugin was recently enabled. If you recieve any errors at runtime, check the JS console in browser developer tools to look for any errors in your plugin code.
+====

modules/deployment-plug-in-cluster.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * web_console/dynamic-plug-ins.adoc
+// * web_console/deploy-plug-in-cluster.adoc
 
 :_content-type: PROCEDURE
 [id="disabling-your-plug-in-browser_{context}"]