-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Operator procedure for immutable KIE server from Maven repo #131
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -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 *Set Immutable server configuration* and do not complete these steps. Instead, set the `KIE_SERVER_CONTAINER_REPLOYMENT` environment variable. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ok, so, click on the "..." button and...? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix typo in variable name
Suggested change
|
||||||||||
==== | ||||||||||
+ | ||||||||||
.. 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`. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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: | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is this section specific for immutable with s2i? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion - adopt UI style for buttons from IBMSG 212p:
|
||||||||||
*** *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. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
Question - is the Type field a drop down? if so:
|
||||||||||
. 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. | ||||||||||
|
@@ -112,6 +112,7 @@ 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 an immutable KIE server that pulls services from the configured Maven repository, 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`. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add a link to the section where the maven repo configuration is explained. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sadly, a link is not exactly possible within the same section, but I will add a note that this has to be configured. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The note was now added There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. thanks. |
||||||||||
** 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: | ||||||||||
*** `MAVEN_REPO_URL`: The URL for the Maven repository | ||||||||||
|
There was a problem hiding this comment.
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