Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Operator procedure for immutable KIE server from Maven repo #131

Merged
merged 4 commits into from
Nov 30, 2020
Merged

Operator procedure for immutable KIE server from Maven repo #131

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0601015
Operator procedure for immutable KIE server from Maven repo
mramendi Nov 19, 2020
beb77d8
Reference external Maven repo with the KIE server immutable Maven
mramendi Nov 24, 2020
066dcff
SME review
mramendi Nov 26, 2020
fd2b363
peer review
mramendi Nov 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc-content/enterprise-only/openshift/operator-deploy-basic-proc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ endif::DM[]
+
You cannot remove any service from the pod or add any new service to the pod. If you want to use another version of a service or to modify the configuration in any other way, deploy a new server image to replace the old one. You can use any container-based integration workflows to manage the pods.
+
When configuring this environment, in the *KIE Servers* tab you must customize the {KIE_SERVER} and click the *Set immutable server configuration* button. For instructions about configuring the {KIE_SERVER}, see xref:operator-deploy-kieserver-proc_{context}[].
When configuring this environment, in the *KIE Servers* tab you must customize the {KIE_SERVER} and either click the *Set immutable server configuration* button or set the `KIE_SERVER_CONTAINER_DEPLOYMENT` environment variable. For instructions about configuring the {KIE_SERVER}, see xref:operator-deploy-kieserver-proc_{context}[].
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion - adopt UI style for buttons from IBMSG 212p:

s/click the *Set Immutable server configuration* button or/click *Set Immutable server configuration* or

ifdef::PAM[]
+
Optionally, you can also use the *Console* tab to include {CENTRAL} Monitoring in this environment to monitor, stop, and restart the execution of process services. For instructions about configuring {CENTRAL} Monitoring, see xref:operator-deploy-central-proc_{context}[].
Expand Down
27 changes: 15 additions & 12 deletions doc-content/enterprise-only/openshift/operator-deploy-kieserver-proc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,23 @@ Optionally, you can set custom configuration for {KIE_SERVERS}. In this case, de
+
For instructions about creating custom images, see xref:customimage-con_{context}[].
+
. If you want to configure an immutable {KIE_SERVER}, complete the following additional steps:
. If you want to configure an immutable {KIE_SERVER} using a Source to Image (S2I) build, complete the following additional steps:
+
[IMPORTANT]
====
If you want to configure an immutable {KIE_SERVER} that pulls services from the Maven repository, do not click the *Set Immutable server configuration* button and do not complete these steps. Instead, set the `KIE_SERVER_CONTAINER_REPLOYMENT` environment variable.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion - adopt UI style for buttons from IBMSG 212p:

s/do not click the *Set Immutable server configuration* button and/do not click *Set Immutable server configuration* and

====
+
.. Click *Set Immutable server configuration*.
.. In the *KIE Server container deployment* field, enter the identifying information of the services (KJAR files) that the deployment must pull from the Maven repository or from the result of a Source to Image (S2I) build. The format is `<containerId>=<groupId>:<artifactId>:<version>` or, if you want to specify an alias name for the container, `<containerId>(<aliasId>)=<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(alias2)=g2:a2:v2`.
.. In the *KIE Server container deployment* field, enter the identifying information of the services (KJAR files) that the deployment must take from the result of a Source to Image (S2I) build. The format is `<containerId>=<groupId>:<artifactId>:<version>` or, if you want to specify an alias name for the container, `<containerId>(<aliasId>)=<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(alias2)=g2:a2:v2`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion - replace "take" with "extract".

.. 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_{context}>> in the *Maven mirror URL* field.
.. If you want to use an S2I build, 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.
.. If you want to use a custom base {KIE_SERVER} image for the S2I build, click *Set Base build image* and 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. If you want to use a Docker image name and not an OpenShift image stream tag, change the *Kind* value to `DockerImage`.
.. 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:
.. Click the *Set Git source* button and enter information in the following fields:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this section specific for immutable with s2i?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entire big step, with all substeps. is now specific to immutable with S2I. We told the user earlier to "not complete these steps" for immutable with Maven

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion - adopt UI style for buttons from IBMSG 212p:

s/Click the *Set Git Source* button and/Click *Set Git Source* and

*** *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.
+
[NOTE]
====
If you do not configure a Git source, the immutable {KIE_SERVER} does not use an S2I build. Instead, it pulls the artifacts that you define in the *KIE Server container deployment* field from the configured Maven repository.
====
+
.. 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 are 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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion - correct typo, remove then and that, and adopt UI description for the Type field:

s/If you are want to set/ If you want to set

s/so that changes/so changes

s/Then select the/Select the

Question - is the Type field a drop down? if so:

s/Select the type of the Webhook in the *Type* field and/Select the Webhook type from the *Type* list and

. 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}:
.. Enter the client name in the *Client name* field and the client secret in the *Client secret* field. If a client with this name does not exist, the deployment attempts to create a new client with this name and secret.
Expand Down Expand Up @@ -112,8 +112,10 @@ If you are using a MySQL version 8 image provided by Red Hat on {OPENSHIFT}, to
If you created users on the MySQL version 8 server before enabling the `mysql_native_password` plugin, you must update the `mysql-user` table after you enable the plugin.
endif::PAM[]
. Optionally, depending on your needs, set environment variables. To set an environment variable, click *Add new Environment variable*, then enter the name and value for the variable in the *Name* and *Value* fields.
** If you want to configure your {KIE_SERVER} deployment to use Prometheus to collect and store metrics, set the `PROMETHEUS_SERVER_EXT_DISABLED` environment variable to `false`. For instructions about configuring Prometheus metrics collection, see {URL_MANAGING_SETTINGS}#prometheus-monitoring-ocp-proc_execution-server[_{MANAGING_KIE_SERVER}_].
** If you want to use an external Maven repository, set the following variables:
** If you want to configure an immutable KIE server that pulls services from the configured Maven repository, enter the following settings:
... Set the `KIE_SERVER_CONTAINER_DEPLOYMENT` environment variable. The variable must contain the identifying information of the services (KJAR files) that the deployment must pull from the Maven repository. The format is `<containerId>=<groupId>:<artifactId>:<version>` or, if you want to specify an alias name for the container, `<containerId>(<aliasId>)=<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(alias2)=g2:a2:v2`.
... Configure an external Maven repository.
** If you want to configure an external Maven repository, set the following variables:
*** `MAVEN_REPO_URL`: The URL for the Maven repository
*** `MAVEN_REPO_ID`: An identifier for the Maven repository, for example, `repo-custom`
*** `MAVEN_REPO_USERNAME`: The user name for the Maven repository
Expand All @@ -126,6 +128,7 @@ If you configure an external Maven repository (`MAVEN_REPO_URL`), change `MAVEN_
+
If your authoring environment uses a built-in {CENTRAL} Maven repository, change `MAVEN_MIRROR_OF` to exclude the artifacts in this repository from the mirror: `external:*,!repo-{PRODUCT_INIT}centr`.
+
** If you want to configure your {KIE_SERVER} deployment to use Prometheus to collect and store metrics, set the `PROMETHEUS_SERVER_EXT_DISABLED` environment variable to `false`. For instructions about configuring Prometheus metrics collection, see {URL_MANAGING_SETTINGS}#prometheus-monitoring-ocp-proc_execution-server[_{MANAGING_KIE_SERVER}_].
** In some authoring environments, you might need to ensure that several users can deploy services on the same {KIE_SERVER} at the same time. By default, after deploying a service onto a {KIE_SERVER} using {CENTRAL}, the user needs to wait for some seconds before more services can be deployed. The `OpenShiftStartupStrategy` setting is enabled by default and causes this limitation. To remove the limitation, you can configure an `{PRODUCT_INIT}-authoring` environment to use the _controller strategy_. Do not make this change unless a specific need for it exists; if you decide to enable controller strategy, make this change on {CENTRAL} and on all {KIE_SERVERS} in the same environment.
+
[NOTE]
Expand Down