You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kie.apache.org by "ricardozanini (via GitHub)" <gi...@apache.org> on 2024/03/06 20:54:42 UTC
[PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
ricardozanini opened a new pull request, #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562
<!-- Please don't forget your Issue link -->
Closes/Fixes/Resolves #ISSUE-NUMBER
<!-- Please provide a short description of what this PR does -->
**Description:**
<!-- Link to related PRs: -->
Please make sure that your PR meets the following requirements:
- [ ] You have read the [contributions doc](https://github.com/apache/incubator-kie-kogito-docs/blob/main/CONTRIBUTING.md)
- [ ] Pull Request title is properly formatted: `Issue-XYZ Subject`
- [ ] Pull Request title contains the target branch if not targeting main: `[0.9.x] Issue-XYZ Subject`
- [ ] The nav.adoc file has a link to this guide in the proper category
- [ ] The index.adoc file has a card to this guide in the proper category, with a meaningful description
<details>
<summary>
How to backport a pull request to a different branch?
</summary>
In order to automatically create a **backporting pull request** please add one or more labels having the following format `backport-<branch-name>`, where `<branch-name>` is the name of the branch where the pull request must be backported to (e.g., `backport-7.67.x` to backport the original PR to the `7.67.x` branch).
> **NOTE**: **backporting** is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.
Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.
If something goes wrong, the author will be notified and at this point a manual backporting is needed.
> **NOTE**: this automated backporting is triggered whenever a pull request on `main` branch is labeled or closed, but both conditions must be satisfied to get the new PR created.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "ricardozanini (via GitHub)" <gi...@apache.org>.
ricardozanini commented on PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562#issuecomment-1986051171
Merge only after:
https://github.com/apache/incubator-kie-kogito-serverless-operator/pull/416
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "domhanak (via GitHub)" <gi...@apache.org>.
domhanak commented on code in PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562#discussion_r1517287621
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/global-configuration.adoc:
##########
@@ -0,0 +1,95 @@
+= Global Configuration Settings
+:compat-mode!:
+// Metadata:
+:description: Global Configuration {operator_name} for cluster admins
+:keywords: sonataflow, workflow, serverless, operator, kubernetes, minikube, openshift, containers, configuration
+// links
+
+This document describes how to set global configuration options for the {operator_name}.
+
+.Prerequisites
+* You have installed the operator in the target cluster. You can find more information at the xref:cloud/operator/install-serverless-operator.adoc[] guide.
+
+== Modifying configuration options
+
+After installing the operator, you can access the ConfigMap named `sonataflow-operator-controllers-config` in the namespace `{operator_installation_namespace}`.
Review Comment:
`sonataflow-operator-controllers-config`
could we make this a variable? Thinking if we ever update the name, we then just change one variable in docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "ricardozanini (via GitHub)" <gi...@apache.org>.
ricardozanini commented on PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562#issuecomment-1984256397
@kaldesai can you please take a look?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562#issuecomment-2030404263
🎊 PR Preview 74d748c65994f884082abc5ad89b0b8f868f2753 has been successfully built and deployed. See the documentation preview: https://sonataflow-docs-preview-pr-562.surge.sh
<!-- Sticky Pull Request Comment -->
<!-- Sticky Pull Request Comment -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "kaldesai (via GitHub)" <gi...@apache.org>.
kaldesai commented on code in PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562#discussion_r1517690347
##########
serverlessworkflow/modules/ROOT/pages/cloud/operator/global-configuration.adoc:
##########
@@ -0,0 +1,95 @@
+= Global Configuration Settings
+:compat-mode!:
+// Metadata:
+:description: Global Configuration {operator_name} for cluster admins
+:keywords: sonataflow, workflow, serverless, operator, kubernetes, minikube, openshift, containers, configuration
+// links
+
+This document describes how to set global configuration options for the {operator_name}.
+
+.Prerequisites
+* You have installed the operator in the target cluster. You can find more information at the xref:cloud/operator/install-serverless-operator.adoc[] guide.
+
+== Modifying configuration options
+
+After installing the operator, you can access the ConfigMap named `{operator_controller_config}` in the namespace `{operator_installation_namespace}`.
+This configuration file governs the operator's behavior when creating new resources in the cluster. Existing resources won't be changed after this configuration.
+See the section <<config-changes>> for more information.
+
+You can freely edit any of the options in the key `controllers_cfg.yaml` entry. The table bellow lists each possible entry.
+
+.Description of Global Configuration
+[cols="1,1,2"]
+|===
+|Configuration Key | Default Value | Description
+
+| `defaultPvcKanikoSize` | 1Gi | The default size of Kaniko PVC when using the internal operator builder manager.
+| `healthFailureThresholdDevMode` | 50 | How much time (in seconds) to wait for a devmode workflow to start. This information is used for the controller manager to create new devmode containers and setup the healthcheck probes.
+| `kanikoDefaultWarmerImageTag` | gcr.io/kaniko-project/warmer:v1.9.0 | Default image used internally by the Operator Managed Kaniko builder to create the warmup pods.
+| `kanikoExecutorImageTag` | gcr.io/kaniko-project/executor:v1.9.0 | Default image used internally by the Operator Managed Kaniko builder to create the executor pods.
+| `jobsServicePostgreSQLImageTag` | empty | The Jobs Service image for PostgreSQL to use, if empty the operator will use the default Apache Community one based on the current operator's version.
+| `jobsServiceEphemeralImageTag` | empty | The Jobs Service image without persistence to use, if empty the operator will use the default Apache Community one based on the current operator's version.
+| `dataIndexPostgreSQLImageTag` | empty | The Data Index image for PostgreSQL to use, if empty the operator will use the default Apache Community one based on the current operator's version.
+| `dataIndexEphemeralTag` | empty | The Data Index image without persistence to use, if empty the operator will use the default Apache Community one based on the current operator's version.
+| `sonataFlowBaseBuilderImageTag` | empty | {product_name} base builder image used in the internal Dockerfile to build workflow applications in preview profile. If empty the operator will use the default Apache Community one based on the current operator's version.
+| `sonataFlowDevModeImageTag` | empty | The image to use to deploy {product_name} workflow images in devmode profile. If empty the operator will use the default Apache Community one based on the current operator's version.
+
+|===
+
+To edit this file, update the ConfigMap `sonataflow-operator-controllers-config` using your preferred tool such as `kubectl`.
+
+[#config-changes]
+== Configuration Changes Impact
+
+When updating the global configuration, the changes will be taken impact immediately for *newly* created resources only.
+For example, if you change `sonataFlowDevModeImageTag` property, given that you already have a workflow deployed in _devmode_, the operator won't rollout a new one with the new image configuration. Only new deployments will be affected.
Review Comment:
```suggestion
For example, suppose you change the `sonataFlowDevModeImageTag` property, given that you already have a workflow deployed in _devmode_. In that case, the operator won't roll out a new one with the new image configuration. Only new deployments will be affected.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "ricardozanini (via GitHub)" <gi...@apache.org>.
ricardozanini merged PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org
Re: [PR] Issue #560 - Introduce Global Configuration for Operator section [incubator-kie-kogito-docs]
Posted by "domhanak (via GitHub)" <gi...@apache.org>.
domhanak commented on PR #562:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/562#issuecomment-1985197082
Imho this also Resolves https://github.com/apache/incubator-kie-kogito-docs/issues/548
Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@kie.apache.org
For additional commands, e-mail: commits-help@kie.apache.org