Skip to content

Commit

Permalink
QE verification changes for Operator - DM review (#58) (apache#1739)
Browse files Browse the repository at this point in the history
* QE verification changes for Operator - DM review

* Further corrections from Karel and Thomas

* Typo fixed
  • Loading branch information
mramendi authored and sterobin committed Jul 9, 2019
1 parent d8b11c4 commit 826b44f
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 40 deletions.
10 changes: 2 additions & 8 deletions assemblies/assembly_openshift-operator/main.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,10 @@ include::_artifacts/author-group.adoc[]
// Purpose statement for the assembly
As a system engineer, you can deploy a {PRODUCT} environment on {OPENSHIFT} to provide an infrastructure to develop or execute processes and other business assets. You can use OpenShift Operators to deploy the environment defined in a structured YAML file and to maintain and modify this environment as necessary.

[NOTE]
====
This functionality is currently for Technology Preview only. For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope].
====

.Prerequisites

* An {OPENSHIFT} environment is available. The Operator is supported on {OPENSHIFT} version 4.1 and higher.
* At least four gigabytes of memory are available in the OpenShift environment.
* The OpenShift Operator Framework is installed and started in the OpenShift environment.
* The OpenShift project for the deployment is created.
* You are logged in to the project using the OpenShift web console.
* Dynamic persistent volume (PV) provisioning is enabled. Alternatively, if dynamic PV provisioning is not enabled, enough persistent volumes must be available. By default, the following sizes are required:
Expand Down Expand Up @@ -53,11 +48,10 @@ include::{enterprise-dir}/openshift/secrets-secrettarget-create-proc.adoc[levelo
ifdef::PAM[]
:secrettarget: smartrouter
include::{enterprise-dir}/openshift/secrets-secrettarget-create-proc.adoc[leveloffset=+2]
// include::{enterprise-dir}/openshift/externaldb-build-proc.adoc[leveloffset=+2]
include::{enterprise-dir}/openshift/externaldb-build-proc.adoc[leveloffset=+2]
include::{enterprise-dir}/openshift/glusterfs-reconfig-proc.adoc[leveloffset=+2]
endif::PAM[]
include::{enterprise-dir}/openshift/offline-repo-proc.adoc[leveloffset=+2]
include::{enterprise-dir}/openshift/externaldb-build-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]
Expand Down
2 changes: 1 addition & 1 deletion doc-content/enterprise-only/openshift/operator-con.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

To deploy a {PRODUCT} environment, the OpenShift Operator uses a YAML source that describes the environment. {PRODUCT} provides an installer that you can use to form the YAML source and deploy the environment.

When {OPENSHIFT} deploys the environment, it creates a YAML description of the environment, and then ensures that the environment is consistent with the description at all times. You can edit the description to modify the environment.
When the Business Automation operator deploys the environment, it creates a YAML description of the environment, and then ensures that the environment is consistent with the description at all times. You can edit the description to modify the environment.
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,34 @@ Optionally, you can set custom configuration for {KIE_SERVERS}. In this case, de
. In the *Deployments* field, enter the number of similar {KIE_SERVERS} that are to be deployed. The installer can deploy several {KIE_SERVERS} with the same configuration. The identifiers and names of the {KIE_SERVERS} are modified automatically and remain unique.
. If you created the secret for {KIE_SERVER} according to the instructions in <<secrets-kie-create-proc>>, enter the name of the secret in the *Secret* field.
. Optionally, enter the number of replicas for the {KIE_SERVER} in the *Replicas* field.
. If you want to use a custom image for the {KIE_SERVER}, for example, if you created an image with an external database driver according to instructions in <<externaldb-build-proc>>, complete the following additional steps:
. If you want to use a custom image for the {KIE_SERVER},
ifdef::PAM[]
for example, if you created an image with an external database driver according to instructions in <<externaldb-build-proc>>,
endif::PAM[]
complete the following additional steps:
.. Click *Set KIE Server image*.
.. Enter the name of the image stream in the *Name* field. If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in <<externaldb-build-proc>>, enter the following value:
.. Enter the name of the image stream in the *Name* field.
ifdef::PAM[]
If you created a custom image for using an external database server other than MySQL or PostgreSQL, as described in <<externaldb-build-proc>>, enter the following value:
+
*** For Microsoft SQL Server, `{PRODUCT_INIT}{ENTERPRISE_VERSION_SHORT}-kieserver-mssql-openshift`
*** For MariaDB, `{PRODUCT_INIT}{ENTERPRISE_VERSION_SHORT}-kieserver-mariadb-openshift`
*** For IBM DB2, `{PRODUCT_INIT}{ENTERPRISE_VERSION_SHORT}-kieserver-db2-openshift`
*** For Oracle Database, `{PRODUCT_INIT}{ENTERPRISE_VERSION_SHORT}-kieserver-oracle-openshift`
*** For Sybase, `{PRODUCT_INIT}{ENTERPRISE_VERSION_SHORT}-kieserver-sybase-openshift`
+
endif::PAM[]
.. If the image stream is not in the `openshift` namespace, enter the namespace in the *Namespace* field.
. If you want to configure an immutable {KIE_SERVER} using Source to Image (S2I), complete the following additional steps:
.. Click *Set Build configuration (Source to Image)*.
. If you want to configure an immutable {KIE_SERVER}, complete the following additional steps:
.. Click *Set Immutable server configuration*.
.. In the *KIE Server container deployment* field, enter the identifying information of the decision services (KJAR files) that the deployment must pull from the Maven repository. The format is: `<containerId>=<groupId>:<artifactId>:<version>`. You can provide two or more KJAR files using the `|` separator, as illustrated in the following example: `containerId=groupId:artifactId:version|c2=g2:a2:v2`.
.. If your OpenShift environment does not have a connection to the public Internet, enter the URL of the Maven mirror that you set up according to <<offline-repo-proc>> in the *Maven mirror URL* field.
.. In the *Artifact directory* field, enter the path within the project that contains the required binary files (KJAR files and any other necessary files) after a successful Maven build. Normally this directory is the target directory of the build. However, you can provide prebuilt binaries in this directory in the Git repository.
.. In the *S2I Git URI* field, enter the URI for the Git repository that contains the source for your services.
.. In the *Reference* field, enter the branch in the Git repository.
.. Optionally, in the *Context directory* field, enter the path to the source within the project downloaded from the Git repository. By default, the root directory of the downloaded project is the source directory.
.. If you want to set a Git Webhook so that changes in the Git repository cause an automatic rebuild of the {KIE_SERVER}, click *Add new Webhook*. Then select the type of the Webhook in the *Type* field and enter the secret string for the Webhook in the *Secret* field.
.. If you want to create the immutable server from source in a Git repository using the Source to Image (S2I) process, click the *Set Git source* button and enter information in the following fields:
*** *S2I Git URI*:The URI for the Git repository that contains the source for your services.
*** *Reference*: The branch in the Git repository.
*** *Context directory*: (Optional) The path to the source within the project downloaded from the Git repository. By default, the root directory of the downloaded project is the source directory.
.. If you are using S2I and want to set a Git Webhook so that changes in the Git repository cause an automatic rebuild of the {KIE_SERVER}, click *Add new Webhook*. Then select the type of the Webhook in the *Type* field and enter the secret string for the Webhook in the *Secret* field.
.. If you want to use a custom base {KIE_SERVER} image for the S2I build, click *Set Base build image*. Then enter the name of the image stream in the *Name* field. If the image stream is not in the `openshift` namespace, enter the namespace in the *Namespace* field.
. Optionally, enter requested and maximum CPU and memory limits in the fields under *Resource quotas*. If you are configuring several {KIE_SERVERS}, the limits apply to each server separately.
. If you selected RH-SSO authentication, configure RH-SSO for the {KIE_SERVER}:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ To start deploying a {PRODUCT} environment using {operator_name}, access the ins

.Procedure

. In the {OPENSHIFT} web cluster console menu, select *Operators -> Subscriptions*.
. Click the name of the subscription that contains `businessautomation`. Information about this subscription is displayed.
. Under the *Installed version* heading, click the version name of the subscription. An overview of the subscription is displayed.
. In the {OPENSHIFT} web cluster console menu, select *Catalog -> Installed operators*.
. Click the name of the operator that contains `businessautomation`. Information about this operator is displayed.
. Click the *Installer* link on the left side of the window.
. If prompted, log in with your OpenShift credentials.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ After you subscribe to {operator_name}, you can use the installer wizard to conf

[IMPORTANT]
====
In {PRODUCT} {VERSION}, the operator installer wizard is for Technology Preview only. For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
In {PRODUCT} {PRODUCT_VERSION}, the operator installer wizard is for Technology Preview only. For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
====


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ To modify the environment, you must modify the YAML description of the environme

.Procedure
. Enter your project in the OpenShift web cluster console.
. In the OpenShift Web console navigation panel, select *Operators -> Subscriptions*.
. Click the name of the subscription that contains `businessautomation`. Information about this subscription is displayed.
. Under the *Installed version* heading, click the version name of the subscription. An overview of the subscription is displayed.
. Select the *Instances* tab.
. In the OpenShift Web console navigation panel, select *Catalog -> Installed Operators*.
. Find the `Business Automation` operator line in the table and click `KieApp` in the line. Information about the environments that you deployed using this operator is displayed.
. Click the name of a deployed environment.
. Select the *YAML* tab. A YAML source is displayed.
. If you want to change common settings, such as passwords, edit the values under `commonConfig:`.
Expand Down Expand Up @@ -44,5 +42,5 @@ Replace the following values:
*** `<directory>`: The path to the source within the project downloaded from the Git repository.
+
. If you want to scale a {KIE_SERVER}, find the description of the server in the block under `servers:` and add a `replicas:` setting under that description. For example, `replicas: 3` scales the server to three pods.
. Click *Save Changes* and then wait for a `This object has been updated` pop-up message.
. Click *Save* and then wait for a `has been updated` pop-up message.
. Click *Reload* to view the new YAML description of the environment.
17 changes: 3 additions & 14 deletions doc-content/enterprise-only/openshift/operator-subscribe-proc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,6 @@ To be able to deploy {PRODUCT} using operators, you must subscribe to {operator_
.Procedure

. Enter your project in the OpenShift Web cluster console.
. In the OpenShift Web console navigation panel, select *Operators* and then *Catalog Sources*.
. Search for *Business Automation*. If you find it, click *Create Subscription* next to it.
. If the *Business Automation* entry is not available, complete the following steps:
.. Log in to the OpenShift environment as an administrator.
.. Enter the following command:
+
[subs="attributes,verbatim,macros"]
----
$ oc create -f https://raw.githubusercontent.com/kiegroup/kie-cloud-operator/1.0.1/deploy/catalog_resources/redhat/catalog-source.yaml
----
+
.. Refresh the OpenShift Web console in the browser.
.. Search for *Business Automation* again. Click *Create Subscription* next to it.
. A YAML description of the new subscription is displayed. Click *Create* to create the subscription.
. In the OpenShift Web console navigation panel, select *Catalog* and then *OperatorHub*.
. Search for *Business Automation*, select it and click *Install*.
. On the *Create Operator Subscription* page, select your target namespace and approval strategy and then click *Subscribe* to create a subscription.

0 comments on commit 826b44f

Please sign in to comment.