BXMSDOC-8586-blue add the Operator doc as only guide in OS doc (#4319)

* BXMSDOC-8586-blue-reinstate reinstated operator contnet * BXMSDOC-8586 * BXMSDOC-8586-blue-reinstate updated the OS guide with Operator only * BXMSDOC-8586-blue-reinsate updated with FS comments Co-authored-by: Emily Murphy <[email protected]>
IBM · Jul 28, 2022 · a22d3bf · a22d3bf
1 parent 719b9b6
commit a22d3bf
Show file tree

Hide file tree

Showing 20 changed files with 68 additions and 79 deletions.
diff --git a/_artifacts/document-attributes.adoc b/_artifacts/document-attributes.adoc
@@ -1,5 +1,5 @@
 
-:REBUILT: Friday, July 22, 2022
+:REBUILT: Friday, July 29, 2022
 
 
 :ENTERPRISE_VERSION: 8.0

diff --git a/assemblies/assembly-clustering-eap.adoc b/assemblies/assembly-clustering-eap.adoc
@@ -50,7 +50,7 @@ endif::PAM[]
 == Additional resources
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-install-on-eap[_{INSTALLING_ON_EAP}_]
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-planning[_{PLANNING_INSTALL}_]
-//* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
+* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
 //* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-templates[_{DEPLOYING_OPENSHIFT_TEMPLATES}_]
 
 ifdef::parent-context[:context: {parent-context}]

diff --git a/assemblies/assembly-managing-and-monitoring-execution-server.adoc b/assemblies/assembly-managing-and-monitoring-execution-server.adoc
@@ -118,7 +118,7 @@ include::{shared-dir}/KieServer/performance-tuning-kie-server-ref.adoc[leveloffs
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-install-on-eap[_{INSTALLING_ON_EAP}_]
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-planning[_{PLANNING_INSTALL}_]
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-install-on-eap[_{INSTALLING_ON_EAP}_]
-//* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
+* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
 * {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-templates[_{DEPLOYING_OPENSHIFT_TEMPLATES}_]
 
 ifdef::parent-context[:context: {parent-context}]

diff --git a/assemblies/assembly-openshift-operator.adoc b/assemblies/assembly-openshift-operator.adoc
@@ -75,6 +75,7 @@ environment or any environment with {CENTRAL} Monitoring pods,
 endif::PAM[]
 your OpenShift environment supports persistent volumes with `ReadWriteMany` mode. If your environment does not support this mode, you can use NFS to provision the volumes. For information about access mode support in OpenShift public and dedicated clouds, see https://access.redhat.com/documentation/en-us/openshift_container_platform/4.6/html/storage/understanding-persistent-storage#pv-access-modes_understanding-persistent-storage[Access Modes] in {OPENSHIFT} documentation.
 
+
 include::{enterprise-dir}/openshift/ba-openshift-overview-con.adoc[leveloffset=+1]
 include::{enterprise-dir}/openshift/architecture-authoring-con.adoc[leveloffset=+2]
 include::{enterprise-dir}/openshift/dm-openshift-prepare-con.adoc[leveloffset=+1]
@@ -96,30 +97,36 @@ include::{enterprise-dir}/openshift/environment-immutable-source-extract-proc.ad
 include::{enterprise-dir}/openshift/restricted-network-proc.adoc[leveloffset=+2]
 include::{enterprise-dir}/openshift/offline-repo-proc.adoc[leveloffset=+2]
 
-
-
 include::{enterprise-dir}/openshift/operator-con.adoc[leveloffset=+1]
+
 include::{enterprise-dir}/openshift/operator-subscribe-proc.adoc[leveloffset=+2]
+
+
 include::{enterprise-dir}/openshift/operator-environment-deploy-assy.adoc[leveloffset=+2]
+
 include::{enterprise-dir}/openshift/operator-modify-proc.adoc[leveloffset=+2]
+
 include::{enterprise-dir}/openshift/jboss-postconfigure-proc.adoc[leveloffset=+2]
+
 include::{enterprise-dir}/openshift/jvm-settings-ref.adoc[leveloffset=+2]
 include::{enterprise-dir}/openshift/configmaps-con.adoc[leveloffset=+2]
 include::{enterprise-dir}/openshift/using-configmaps-proc.adoc[leveloffset=+3]
 include::{enterprise-dir}/openshift/customimage-con.adoc[leveloffset=+2]
 include::{enterprise-dir}/openshift/customimage-rpm-proc.adoc[leveloffset=+3]
+
 include::{enterprise-dir}/openshift/customimage-jar-proc.adoc[leveloffset=+3]
+
 ifdef::PAM[]
 include::{enterprise-dir}/openshift/customimage-smartrouter-proc.adoc[leveloffset=+3]
 endif::PAM[]
 
+
 ifdef::PAM[]
 include::{enterprise-dir}/openshift/dashbuilder-standalone-proc.adoc[leveloffset=+1]
 include::{enterprise-dir}/openshift/ref-custom-resource-parameters.adoc[leveloffset=+2]
 endif::PAM[]
 
 include::{enterprise-dir}/openshift/migration-ocp3-4-assy.adoc[leveloffset=+1]
 
-
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]
diff --git a/assemblies/assembly-openshift-templates.adoc b/assemblies/assembly-openshift-templates.adoc
@@ -14,12 +14,10 @@ services, process applications,
 endif::PAM[]
 and other business assets. You can use one of the supplied templates to deploy a predefined {PRODUCT} environment to suit your particular needs.
 
-////
 [NOTE]
 ====
 For instructions about deploying an {PRODUCT} environment on {OPENSHIFT} {OPENSHIFT_VERSION_SHORT} using Operators, see {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_].
 ====
-////
 
 .Prerequisites
 

diff --git a/assemblies/assembly-packaging-deploying.adoc b/assemblies/assembly-packaging-deploying.adoc
@@ -68,7 +68,7 @@ include::{enterprise-dir}/admin-and-config/service-stop-remove-proc.adoc[levelof
 == Additional resources
 * {URL_DEVELOPING_DECISION_SERVICES}#assets-executing-proc_drl-rules["Executing rules" in _{DRL_RULES}_]
 * {URL_DEPLOYING_AND_MANAGING_SERVICES}#assembly-kie-apis[_{KIE_APIS}_]
-//* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
+* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
 //* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-templates[_{DEPLOYING_OPENSHIFT_TEMPLATES}_]
 
 ifdef::parent-context[:context: {parent-context}]

diff --git a/assemblies/assembly-planning.adoc b/assemblies/assembly-planning.adoc
@@ -55,7 +55,7 @@ include::{enterprise-dir}/installation/integrating-con.adoc[leveloffset=+1]
 ////
 
 .OpenShift
-//* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
+* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
 //* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-templates[_{DEPLOYING_OPENSHIFT_TEMPLATES}_]
 //* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-hacep[_{HA_CEP}_]
 

diff --git a/doc-content/enterprise-only/installation/installing-con.adoc b/doc-content/enterprise-only/installation/installing-con.adoc
@@ -75,8 +75,8 @@ ifeval::["{context}" == "install-on-tomcat"]
 endif::[]
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-installing-kie-server-on-was[_{INSTALLING_KIE_ON_WAS}_]
 * {URL_INSTALLING_AND_CONFIGURING}#assembly-installing-kie-server-on-wls[_{INSTALLING_KIE_ON_WLS}_]
-//* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
-* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-templates[_{DEPLOYING_OPENSHIFT_TEMPLATES}_]
+* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_]
+//* {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-templates[_{DEPLOYING_OPENSHIFT_TEMPLATES}_]
 
 ////
 For information about supported components, see the following documents:

diff --git a/doc-content/enterprise-only/installation/kie-server-configure-central-proc.adoc b/doc-content/enterprise-only/installation/kie-server-configure-central-proc.adoc
@@ -5,12 +5,10 @@ WARNING: This section provides a sample setup that you can use for testing purpo
 
 If a {KIE_SERVER} is not configured in your {PRODUCT} environment, or if you require additional {KIE_SERVERS} in your {PRODUCT} environment, you must configure a {KIE_SERVER} to connect to {CENTRAL}.
 
-////
 [NOTE]
 ====
 If you are deploying {KIE_SERVER} on {OPENSHIFT}, see the {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_] document for instructions about configuring it to connect to {CENTRAL}.
 ====
-////
 
 ifeval::["{context}" == "execution-server"]
 {KIE_SERVER} can be managed or unmanaged. If {KIE_SERVER} is unmanaged, you must manually create and maintain KIE containers (deployment units). If {KIE_SERVER} is managed, the {CONTROLLER} manages the {KIE_SERVER} configuration and you interact with the {CONTROLLER} to create and maintain the KIE containers.

diff --git a/doc-content/enterprise-only/integration/sso-central-proc.adoc b/doc-content/enterprise-only/integration/sso-central-proc.adoc
@@ -13,9 +13,7 @@ This chapter describes how to authenticate {CENTRAL} through RH-SSO. It includes
 * You added {CENTRAL} users to RH-SSO as described in <<sso-user-add-proc>>.
 * Optional: To manage RH-SSO users from {CENTRAL}, you added all realm-management client roles in RH-SSO to the {CENTRAL} administrator user.
 
-////
 [NOTE]
 ====
 Except for <<sso-central-client-create-proc>>, this section is intended for standalone installations. If you are integrating RH-SSO and {PRODUCT} on {OPENSHIFT}, complete only the steps in <<sso-central-client-create-proc>> and then deploy the {PRODUCT} environment on {OPENSHIFT}. For information about deploying {PRODUCT} on {OPENSHIFT}, see {URL_DEPLOYING_ON_OPENSHIFT}[{DEPLOYING_ON_OPENSHIFT}].
 ====
-////
diff --git a/doc-content/enterprise-only/integration/sso-kie-server-con.adoc b/doc-content/enterprise-only/integration/sso-kie-server-con.adoc
@@ -16,9 +16,7 @@ This chapter contains the following sections:
 * <<sso-kie-server-client-adapter-proc>>
 * <<sso-kie-server-token-proc>>
 
-////
 [NOTE]
 ====
 Except for <<sso-kie-server-client-proc>>, this section is intended for standalone installations. If you are integrating RH-SSO and {PRODUCT} on {OPENSHIFT}, complete the steps in <<sso-kie-server-client-proc>> and then deploy the {PRODUCT} environment on {OPENSHIFT}. For information about deploying {PRODUCT} on {OPENSHIFT}, see {URL_DEPLOYING_ON_OPENSHIFT}[{DEPLOYING_ON_OPENSHIFT}].
 ====
-////
diff --git a/doc-content/enterprise-only/openshift/configmaps-con.adoc b/doc-content/enterprise-only/openshift/configmaps-con.adoc
@@ -22,58 +22,58 @@ data:
 
 The operator uses ConfigMaps to configure and deploy the components. This includes all supported {PRODUCT} components such as {KIE_SERVER}, Smart Router, {CENTRAL} and service-related configuration such as for persistent volumes, build configuration, and routes. When ConfigMaps are edited manually, the operator uses the new values to create the deployments when the environment is reconciled.
 
-The {PRODUCT} operator can use the current version and the previous version of {PRODUCT} components concurrently, with ConfigMaps for each version, for example, 7.13.0 and 7.12.1.
+The {PRODUCT} operator can use the current version and the previous version of {PRODUCT} components concurrently, with ConfigMaps for each version, for example, 8.0.0 and 7.12.1.
 
-kieconfigs-7.12.1::
-This contains the `common.yaml` configuration file. For more information, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/common.yaml[`common.yaml`] on GitHub. You can configure the following components using this configuration file:
+kieconfigs-8.0.0::
+This contains the `common.yaml` configuration file. For more information, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/common.yaml[`common.yaml`] on GitHub. You can configure the following components using this configuration file:
 +
 * {KIE_SERVER}, the server object, is identified by the `## KIE Servers BEGIN` placeholder.
 * {CENTRAL} and {CENTRAL} Monitoring, the console object, is defined on the first line of the `common.yaml`.
 * Smartrouter, the smartrouter object, is identified by the `## KIE smartrouter BEGIN` placeholder.
 
 [NOTE]
 ====
-`kieconfigs-7.12.1` also holds the routes and services relating to these three components.
+`kieconfigs-8.0.0` also holds the routes and services relating to these three components.
 ====
 
-kieconfigs-7.12.1-dashbuilder::
+kieconfigs-8.0.0-dashbuilder::
 This contains the configuration YAML file for the Dashbuilder component.
 +
-For more information, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dashbuilder/rhpam-standalone-dashbuilder.yaml[`rhpam-standalone-dashbuilder.yaml`] on GitHub.
+For more information, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dashbuilder/rhpam-standalone-dashbuilder.yaml[`rhpam-standalone-dashbuilder.yaml`] on GitHub.
 
-kieconfigs-7.12.1-dbs::
+kieconfigs-8.0.0-dbs::
 This contains the base `DeploymentConfig` for the MySQL and PostgreSQL databases.
 +
-For more information about the MySQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/servers/mysql.yaml[`mysql.yaml`] on GitHub.
+For more information about the MySQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/servers/mysql.yaml[`mysql.yaml`] on GitHub.
 +
-For more information about the PostgreSQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/servers/postgresql.yaml[`postgresql.yaml`] on GitHub.
+For more information about the PostgreSQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/servers/postgresql.yaml[`postgresql.yaml`] on GitHub.
 
-kieconfigs-7.12.1-dbs-pim::
+kieconfigs-8.0.0-dbs-pim::
 This contains the snippet configuration for the process instance migration (PIM) supported databases; external, MySQL, and PostgreSQL.
 +
-For more information about the PIM external configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/pim/external.yaml[`external.yaml`] on GitHub.
+For more information about the PIM external configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/pim/external.yaml[`external.yaml`] on GitHub.
 +
-For more information about the PIM MySQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/pim/mysql.yaml[`mysql.yaml`] on GitHub.
+For more information about the PIM MySQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/pim/mysql.yaml[`mysql.yaml`] on GitHub.
 +
-For more information about the PIM PostgreSQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/pim/postgresql.yaml[`postgresql.yaml`] on GitHub.
+For more information about the PIM PostgreSQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/pim/postgresql.yaml[`postgresql.yaml`] on GitHub.
 +
 [NOTE]
 ====
 These YAML files only hold the specific configuration for the PIM database configured using `application.properties` in this configMap.
 ====
 
-kieconfigs-7.12.1-dbs-servers::
+kieconfigs-8.0.0-dbs-servers::
 This contains the snippet configuration for the supported database configurations; external, h2, MySQL, and PostgreSQL.
 +
-For more information about the external configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/servers/external.yaml[`external.yaml`] on GitHub.
+For more information about the external configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/servers/external.yaml[`external.yaml`] on GitHub.
 +
-For more information about the h2 configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/servers/h2.yaml[`h2.yaml`] on GitHub. Note that the h2 configuration is not supported on production environments.
+For more information about the h2 configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/servers/h2.yaml[`h2.yaml`] on GitHub. Note that the h2 configuration is not supported on production environments.
 +
-For more information about the MySQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/servers/mysql.yaml[`mysql.yaml`] on GitHub.
+For more information about the MySQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/servers/mysql.yaml[`mysql.yaml`] on GitHub.
 +
-For more information about the PostgreSQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/dbs/servers/postgresql.yaml[`postgresql.yaml`] on GitHub.
+For more information about the PostgreSQL configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/dbs/servers/postgresql.yaml[`postgresql.yaml`] on GitHub.
 
-kieconfigs-7.12.1-envs::
+kieconfigs-8.0.0-envs::
 This contains the specific configurations for each {PRODUCT} environment such as the authoring or trial environments. This ConfigMap contains the following YAML files:
 +
 * rhdm-authoring-ha.yaml
@@ -87,10 +87,10 @@ This contains the specific configurations for each {PRODUCT} environment such as
 * rhpam-standalone-dashbuilder.yaml
 * rhpam-trial.yaml
 +
-For more information about specific configurations for each {PRODUCT} environment, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/envs/[ConfigMaps for {PRODUCT} environments] on GitHub.
+For more information about specific configurations for each {PRODUCT} environment, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/envs/[ConfigMaps for {PRODUCT} environments] on GitHub.
 
-kieconfigs-7.12.1-jms::
-This contains the ActiveMQ configuration for {KIE_SERVER} when the JMS Executor is enabled. For more information about the JMS Executor configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/7.12.1-1/rhpam-config/7.12.1/jms/activemq-jms-config.yaml[`activemq-jms-config`] on GitHub.
+kieconfigs-8.0.0-jms::
+This contains the ActiveMQ configuration for {KIE_SERVER} when the JMS Executor is enabled. For more information about the JMS Executor configuration, see https://github.com/kiegroup/kie-cloud-operator/blob/8.0.0-1/rhpam-config/8.0.0/jms/activemq-jms-config.yaml[`activemq-jms-config`] on GitHub.
 
-kieconfigs-7.12.1-pim::
-This contains the process instance migration (PIM) DeploymentConfig and related PIM configuration. If you are using MySQL or any other database with PIM you must use the `kieconfigs-7.12.1-dbs-pim` configMap and edit the `mysql.yaml` file.
+kieconfigs-8.0.0-pim::
+This contains the process instance migration (PIM) DeploymentConfig and related PIM configuration. If you are using MySQL or any other database with PIM you must use the `kieconfigs-8.0.0-dbs-pim` configMap and edit the `mysql.yaml` file.
diff --git a/doc-content/enterprise-only/openshift/dashbuilder-standalone-proc.adoc b/doc-content/enterprise-only/openshift/dashbuilder-standalone-proc.adoc
@@ -5,13 +5,15 @@ You can use Dashbuilder Standalone to view dashboards in OpenShift that were cre
 
 .Prerequisites
 * Dashbuilder Standalone is available in the OpenShift registry.
-//* You have prepared your OpenShift environment as described in
+////
+* You have prepared your OpenShift environment as described in
 ifeval::["{context}" == "creating-custom-pages"]
 {URL_DEPLOYING_ON_OPENSHIFT}#assembly-openshift-operator[_{DEPLOYING_OPENSHIFT_OPERATOR}_].
 endif::[]
 ifeval::["{context}" == "openshift-operator"]
 xref:operator-con_openshift-operator[]
 endif::[]
+////
 
 * You have created and exported a dashboard in {CENTRAL}.
 

diff --git a/doc-content/enterprise-only/openshift/githooks-prepare-proc.adoc b/doc-content/enterprise-only/openshift/githooks-prepare-proc.adoc
@@ -17,9 +17,9 @@ A `pre-commit` script is not supported in {CENTRAL}. Use a `post-commit` script.
 ====
 +
 . Create a configuration map (ConfigMap) or persistent volume with the files.
-////
+
 For more information about ConfigMaps, see {URL_DEPLOYING_ON_OPENSHIFT}#configmaps-con[_KIE configuration and ConfigMaps_].
-////
+
 ** If the Git hooks consist of one or several fixed script files, use the `oc` command to create a configuration map. For example:
 +
 [subs="attributes,verbatim,macros"]