Merge pull request #5310 from dtaylor113/master

Documentation for "Configuring Quota Notification Messages"

Author: ahardin-rh

install_config/web_console_customization.adoc

@@ -687,6 +687,51 @@ ifdef::openshift-enterprise[]
 endif::[]
 ----
 
+endif::[]
+[[configuring-quota-notification-messages]]
+== Configuring Quota Notification Messages
+
+Whenever a user reaches a quota, a quota notification is put into the notification drawer.
+A custom quota notification message, per
+xref:../dev_guide/compute_resources.adoc#dev-managed-by-quota[quota resource type], can be added to the notification.  For example:
+"Your project is over quota.  It is using 200% of 2 cores CPU (Limit). Upgrade to <a href='http://www.openshift.com'>
+OpenShift Pro</a> if you need additional resources.".  The "Upgrade to..." part of the notification is the custom
+message and may contain HTML such as links to additional resources.
+
+. Create the following configuration scripts within a file (for example,
+*_quota-messages.js_*):
++
+[source, javascript]
+----
+// Set custom notification messages per quota type/key
+window.OPENSHIFT_CONSTANTS.QUOTA_NOTIFICATION_MESSAGE = {
+    "pods": 'Upgrade to <a href="http://www.openshift.com">OpenShift Pro</a> if you need additional resources.',
+    "limits.memory": 'Upgrade to <a href="http://www.openshift.com">OpenShift Online Pro</a> if you need additional resources.'
+}
+----
+
+. Save the file and add it to the master configuration at
+*_/etc/origin/master/master-config.yaml_*:
++
+[source, yaml]
+----
+assetConfig:
+  ...
+  extensionScripts:
+    - /path/to/quota-messages.js
+----
+
+. Restart the master host:
++
+----
+ifdef::openshift-origin[]
+# systemctl restart origin-master
+endif::[]
+ifdef::openshift-enterprise[]
+# systemctl restart atomic-openshift-master
+endif::[]
+----
+
 endif::[]
 
 [[configuring-the-create-from-url-namespace-whitelist]]
@@ -1013,4 +1058,4 @@ xref:../install_config/install/advanced_install.adoc#advanced-install-configurin
 # Configure loggingPublicURL in the master config for aggregate logging. Ansible is also able to install logging for you.
 # See: https://docs.openshift.com/enterprise/latest/install_config/aggregate_logging.html
 #openshift_master_logging_public_url=https://kibana.example.com
-----
+----