-
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
Conversation
+ | ||
[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 comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
If you want to configure an immutable {KIE_SERVER} that pulls services from the Maven repository, do not check *Set Immutable server configuration* checkbox 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 comment
The 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 comment
The reason will be displayed to describe this comment to others. Learn more.
ok, so, click on the "..." button and...?
.. 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 comment
The 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 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
@@ -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 comment
The 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 comment
The 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 comment
The 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 comment
The reason will be displayed to describe this comment to others. Learn more.
thanks.
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.
A few questions and suggestions, otherwise looks good to me.
+ | ||
[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. |
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/do not click the *Set Immutable server configuration* button and/do not click *Set Immutable server configuration* and
@@ -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}[]. |
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
.. 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 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: |
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 Git Source* button and/Click *Set Git Source* and
==== | ||
+ | ||
.. 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 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
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.
Looks ok, please just fix the typo :)
+ | ||
[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 comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typo in variable name
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. | |
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_DEPLOYMENT` environment variable. |
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
* Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
…repo - master (apache#3073) * Operator procedure for immutable KIE server from Maven repo (#131) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review * Correction to BXMSDOC-6644 fix
…om Maven repo - 7.44.x (apache#3075) * Operator procedure for immutable KIE server from Maven repo (#131) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review * Correction to BXMSDOC-6644 fix
…pache#3077) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
…pache#3076) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
…pache#3078) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
…pache#3074) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
…pache#3079) * Operator procedure for immutable KIE server from Maven repo * Reference external Maven repo with the KIE server immutable Maven * SME review * peer review
No description provided.