Merge pull request openshift#3470 from ahardin-rh/extension-properties

Bug 1410292, added information about setting extension properties

Author: ahardin-rh

install_config/web_console_customization.adoc

@@ -13,14 +13,22 @@ toc::[]
 
 ifdef::openshift-origin,openshift-enterprise[]
 == Overview
+
 Administrators can customize the
-xref:../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[web console]
-using extensions, which let you run scripts and load custom stylesheets when the
-web console loads. You can change the look and feel of nearly any aspect of the
-user interface in this way.
+xref:../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[web
+console] using extensions, which let you run scripts and load custom stylesheets
+when the web console loads. Extension scripts allow you to override the default
+behavior of the web console and customize it for your needs.
+
+For example, extension scripts can be used to add your own
+company's branding or to add company-specific capabilities. A common use case
+for this is rebranding or white-labelling for different environments. You can
+use the same extension code, but provide settings that change the web console.
+You can change the look and feel of nearly any aspect of the user interface in
+this way.
 
 [[loading-custom-scripts-and-stylesheets]]
-== Loading Custom Scripts and Stylesheets
+== Loading Extension Scripts and Stylesheets
 
 To add scripts and stylesheets, edit the
 xref:../install_config/master_node_configuration.adoc#install-config-master-node-configuration[master configuration
@@ -68,6 +76,44 @@ link:https://github.com/openshift/origin-web-console/tree/master/extensions/exam
 Origin] repository on GitHub.
 ====
 
+[[setting-extension-properties]]
+=== Setting Extension Properties
+
+If you have a specific extension, but want to use different text in it for each
+of the environments, you can define the environment in the
+*_master-config.yaml_* file, and use the same extension script across
+environments. Pass settings from the *_master-config.yaml_* file to be used by
+the extension using the
+xref:../install_config/master_node_configuration.adoc#master-config-asset-config[`extensionProperties`
+mechanism]:
+
+====
+[source,yaml]
+----
+assetConfig:
+  extensionDevelopment: true
+  extensionProperties:
+    doc_url: https://docs.openshift.com
+    key1: value1
+    key2: value2
+  extensionScripts:
+----
+====
+
+This results in a global variable that can be accessed by the extension, as if
+the following code was executed:
+
+====
+[source, javascript]
+----
+window.OPENSHIFT_EXTENSION_PROPERTIES = {
+  doc_url: "https://docs.openshift.com",
+  key1: "value1",
+  key2: "value2",
+}
+----
+====
+
 [[customizing-the-logo]]
 === Customizing the Logo