BXMSDOC-3748-master: Add a chapter about kie server system properties in managing and monitoring kie server document. #39
Conversation
…c on the basis of QE review.
…the enterprise and community doc.
|
|
||
| include::{enterprise-dir}/installation/run-standalone-properties-con.adoc[leveloffset=+1] | ||
| //include::{enterprise-dir}/installation/run-standalone-properties-con.adoc[leveloffset=+1] |
There was a problem hiding this comment.
What about these commented documents? Will they be removed?
There was a problem hiding this comment.
Hey @MarianMacik,
There properties are for Business central so I am moving these properties section in the following documents:
Configuring Business Central settings and properties RHPAM link
Configuring Business Central settings and properties RHDM link
Earlier it was present in the Managing and monitoring Process Server doc. Please check chapter 22 Supported properties.
I am going to rename this existing chapter Supported properties to Business Central system properties and migrate it in to the Configuring Business Central settings and properties. I guess that document is the right place for this properties section.
Also, I am going to single source this.
Also, can you please confirm if this chapter 22 Supported properties is needed in the Managing and monitoring Process Server document? Should I keep it?
There was a problem hiding this comment.
Hi, no, this chapter 22 doesn't need to be in the Managing and monitoring Process Server document.
There was a problem hiding this comment.
@MarianMacik, Thank you for confirming. I will remove it from the assembly.
| |`org.kie.executor.disabled` | ||
| |`true`, `false` | ||
| |`false` | ||
| |If set to `true`, disables the {KIE_SERVER} executor. |
There was a problem hiding this comment.
This property should be moved to other executor properties, i.e. org.kie.executor.interval.
| |String | ||
| |`queue/KIE.SERVER.EXECUTOR` | ||
| |Job executor JMS queue for {KIE_SERVER}. | ||
| |=== |
There was a problem hiding this comment.
These kie.executor properties are also for jbpm/rhpam only.
There was a problem hiding this comment.
Okay. I will remove those properties from RHDM docs.
| .Kie Server bootstrap switches | ||
| [cols="1,1,1,1", frame="all", options="header"] | ||
| ifdef::PAM,JBPM[] | ||
| .System properties for persistence properties |
There was a problem hiding this comment.
System properties for persistence properties doesn't make much sense. I would omit the properties word.
| If you are running both {KIE_SERVER} and {CENTRAL} you must configure KIE Server to use a different Data Source to {CENTRAL} using the *org.kie.server.persistence.ds* property. | ||
| {CENTRAL} uses a jBPM Executor Service that can conflict with {KIE_SERVER} if they share the same Data Source. | ||
| ==== | ||
| .System properties for executor properties |
|
|
||
| ifdef::JBPM,DROOLS[] | ||
| include::kie-server-extensions-con.adoc[leveloffset=+1] | ||
|
|
||
| include::kie-server-extensions-endpoint-proc.adoc[leveloffset=+2] | ||
|
|
||
| include::kie-server-extensions-transport-proc.adoc[leveloffset=+2] | ||
|
|
||
| include::kie-server-extensions-client-proc.adoc[leveloffset=+2] |
There was a problem hiding this comment.
These chapters are only used for community?
There was a problem hiding this comment.
No, there are present in enterprise as well. I am going to remove those conditionals.
| |=== | ||
| endif::[] | ||
|
|
||
| .System properties for loading keystore |
There was a problem hiding this comment.
All system properties for keystores don't contain any default value, please remove them.
There was a problem hiding this comment.
@kaldesai Done. Some minor comments in line. Be sure to expand any "hidden conversations" in this PR.
As a reminder, please be sure to also single-source the {CENTRAL} system properties section that we discussed and which you removed from this document (correct), and then add that {CENTRAL} system properties section in Clifton's "Configuring {CENTRAL} settings and properties" doc. A separate PR is fine. That properties section for {CENTRAL} is critical and must be included. If time becomes a constraint and you don't single source it, at least just get that included in Clifton's doc at worst. But honestly, single-sourcing it takes all of 5 mins when no updates are required, and I highly recommend doing it.
| @@ -16,25 +16,47 @@ The {KIE_SERVER} accepts a number of bootstrap switches (system properties) to c | |||
| |`false` | |||
There was a problem hiding this comment.
You should be able to remove this file now. Search the anchor ID and file name throughout the project, and if any references exist (shouldn't be) change to your new kie-server-system-properties file instead. Once all is clear, then delete this file to tidy up.
There was a problem hiding this comment.
Done. Safely deleted the previous file.
|
|
||
| = {KIE_SERVER} system properties | ||
|
|
||
| The {KIE_SERVER} accepts a number of system properties (bootstrap switches) to configure the behavior of the server. |
There was a problem hiding this comment.
Suggest this, for consistency and conformance with our docs.
The {KIE_SERVER} accepts the following system properties (bootstrap switches) to configure the behavior of the server:
| |`org.jbpm.server.ext.disabled` | ||
| |`true`, `false` | ||
| |`false` | ||
| |If set to `true`, disables the {PRODUCT} support (for example processes support). |
| |`org.drools.server.ext.disabled` | ||
| |`true`, `false` | ||
| |`false` | ||
| |If set to `true`, disables the Business Rule Management (BRM) support (for example rules support). |
| |If set to `true`, disables the {KIE_SERVER} swagger documentation support | ||
| |=== | ||
|
|
||
| NOTE: Some {CONTROLLER} properties listed below are marked as required. Set these properties when you handle {KIE_SERVER} container creation and removal in {CENTRAL}. If you use the {KIE_SERVER} separately without any interaction with {CENTRAL}, the properties do not have to be set. |
There was a problem hiding this comment.
Suggest the following, for clarity, and per IBM SG. Shouldn't ever say "above" or "below", as a reminder, and should avoid passive voice and unclear constructs.
NOTE: Some {CONTROLLER} properties listed in the following table are marked as required. Set these properties when you create or remove {KIE_SERVER} containers in {CENTRAL}. If you use the {KIE_SERVER} separately without any interaction with {CENTRAL}, you do not need to set the required properties.
| |`org.kie.server.sync.deploy` | ||
| |`true`, `false` | ||
| |`false` | ||
| |A property that instructs the {KIE_SERVER} to hold the deployment until the {CONTROLLER} provides the containers deployment configuration. This property only affects servers running in managed mode. The options are as follows: |
There was a problem hiding this comment.
"provides the container deployment"
Also, can't say "as follows", "the following", etc. per IBM SG. Suggest "The following options are available:"
| |`false` | ||
| |A property that instructs the {KIE_SERVER} to hold the deployment until the {CONTROLLER} provides the containers deployment configuration. This property only affects servers running in managed mode. The options are as follows: | ||
|
|
||
| * `false`; the connection to the {CONTROLLER} is asynchronous. The application starts, connects to the {CONTROLLER}, and once successful, deploys the containers. The application accepts requests even before the containers are available. |
There was a problem hiding this comment.
"false: The connection ..." (Colon, followed by cap, per IBM)
"true: The ..."
Suggest "on the same server. Use only one application on one server instance." Should avoid saying "recommend" anything. Just say do or don't do. If there is a genuine optional suggestion, say what the user can do and why.
| |`org.kie.server.startup.strategy` | ||
| |`ControllerBasedStartupStrategy`, `LocalContainersStartupStrategy` | ||
| |`ControllerBasedStartupStrategy` | ||
| |The Startup strategy of {KIE_SERVER} is used to control the KIE containers that are deployed and the order in which they are deployed. |
| |`org.kie.store.services.class` | ||
| |String | ||
| |`org.drools.persistence.jpa.KnowledgeStoreServiceImpl` | ||
| |Fully qualified name of the class that implements `KieStoreServices` which are responsible for bootstraping KieSession instances. |
There was a problem hiding this comment.
"that are responsible for bootstrapping KieSession instances." Correcting some typos and formatting.
| |The password of an alias for default REST {CONTROLLER}. | ||
| |=== | ||
|
|
||
| .Other system properties |
There was a problem hiding this comment.
Just a heads-up that this table is over expanded a bit in community. I think it has to do with the columns set as "2,1,1,3a" instead of "2,1,1,3". I typically just use percentage, for what it's worth, like "30%,20%,20%,30%" or something.
Not critical, just if it's an obvious fix.
…view and updated the cross reference links from extention chapter.
kaldesai
changed the title
kaldesai
changed the title
… in managing and monitoring kie server document. (#39) * BXMSDOC-3748-master: Uncommented the Bootstrap Switches section from assembly. * BXMSDOC-3748-master: Additional bootstrap swiches are added in the doc on the basis of QE review. * BXMSDOC-3748-master: Updated RHPAM specific system property. * BXMSDOC-3748-master: Added the properties on the basis of QE review. * BXMSDOC-3748-master: Single sourced the system properties section in the enterprise and community doc. * BXMSDOC-3748-master: Updated the single sourcing structure for system properties chapter. * BXMSDOC-3748-master: Updated the keystore properties description. * BXMSDOC-3748-master: Incorporated the changes on the basis os peer review and updated the cross reference links from extention chapter.
… in managing and monitoring kie server document. (#39) * BXMSDOC-3748-master: Uncommented the Bootstrap Switches section from assembly. * BXMSDOC-3748-master: Additional bootstrap swiches are added in the doc on the basis of QE review. * BXMSDOC-3748-master: Updated RHPAM specific system property. * BXMSDOC-3748-master: Added the properties on the basis of QE review. * BXMSDOC-3748-master: Single sourced the system properties section in the enterprise and community doc. * BXMSDOC-3748-master: Updated the single sourcing structure for system properties chapter. * BXMSDOC-3748-master: Updated the keystore properties description. * BXMSDOC-3748-master: Incorporated the changes on the basis os peer review and updated the cross reference links from extention chapter.
… in managing and monitoring kie server document. (#39) (apache#1871) * BXMSDOC-3748-master: Uncommented the Bootstrap Switches section from assembly. * BXMSDOC-3748-master: Additional bootstrap swiches are added in the doc on the basis of QE review. * BXMSDOC-3748-master: Updated RHPAM specific system property. * BXMSDOC-3748-master: Added the properties on the basis of QE review. * BXMSDOC-3748-master: Single sourced the system properties section in the enterprise and community doc. * BXMSDOC-3748-master: Updated the single sourcing structure for system properties chapter. * BXMSDOC-3748-master: Updated the keystore properties description. * BXMSDOC-3748-master: Incorporated the changes on the basis os peer review and updated the cross reference links from extention chapter.
… in managing and monitoring kie server document. (#39) (apache#1872) * BXMSDOC-3748-master: Uncommented the Bootstrap Switches section from assembly. * BXMSDOC-3748-master: Additional bootstrap swiches are added in the doc on the basis of QE review. * BXMSDOC-3748-master: Updated RHPAM specific system property. * BXMSDOC-3748-master: Added the properties on the basis of QE review. * BXMSDOC-3748-master: Single sourced the system properties section in the enterprise and community doc. * BXMSDOC-3748-master: Updated the single sourcing structure for system properties chapter. * BXMSDOC-3748-master: Updated the keystore properties description. * BXMSDOC-3748-master: Incorporated the changes on the basis os peer review and updated the cross reference links from extention chapter.
Hey @MarianMacik, @cristianonicolai
Can you please review and verify the chapter {KIE_SERVER} system properties?
The content is unified, single-sourced, renamed to {KIE_SERVER} system properties.
Please check Chapter 22. Process Server system properties in PAM and Chapter.17 Decision Server system properties in DM doc.
The same content can be back ported to v7.1, v7.2, v7.3 and v7.4, once the verification is done.
Thank you.