This is an automated email from the ASF dual-hosted git repository.
ricardozanini pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-kogito-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 396880b1b adding managed properties (#527)
396880b1b is described below
commit 396880b1b7ec2dc16ea78f2e892b0cd7f95a46b4
Author: Daniele Martinoli <[email protected]>
AuthorDate: Fri Mar 8 17:50:18 2024 +0100
adding managed properties (#527)
* adding managed properties
* Update
serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-workflows.adoc
Co-authored-by: Ricardo Zanini
<[email protected]>
* updating managed props suffix
* Fixing CI reference errors
---------
Co-authored-by: Ricardo Zanini
<[email protected]>
---
.../cloud/operator/configuring-workflows.adoc | 25 ++++++++++++++++++----
.../pages/cloud/operator/customize-podspec.adoc | 4 ++--
2 files changed, 23 insertions(+), 6 deletions(-)
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-workflows.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-workflows.adoc
index 89fa264aa..e83643ee1 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-workflows.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/configuring-workflows.adoc
@@ -8,7 +8,15 @@ This document describes how to configure a Workflow service
with the {operator_n
== Editing the Workflow Configuration
-When the operator deploys the Workflow service, it also creates a `ConfigMap`
named after the `SonataFlow` object with the suffix `-props`. For example, if
your Workflow name is `greeting`, then the `ConfigMap` name is `greeting-props`.
+When the operator deploys the Workflow service, it also creates two
`ConfigMap`s to store the runtime properties:
+
+* The user properties are defined in a `ConfigMap` named after the
`SonataFlow` object with the suffix `-props`. For example, if your Workflow
name is `greeting`, then the `ConfigMap` name is `greeting-props`.
+* The xref:#managed-props[Managed Properties] are defined in a `ConfigMap`
named after the `SonataFlow` object with the suffix `-managed-props`. For
example, if your Workflow name is `greeting`, then the `ConfigMap` name is
`greeting-managed-props`.
+
+[IMPORTANT]
+====
+Managed properties always override any user property using the same key name
and cannot be edited by the user. Any change would be overwritten by the
operator at the next reconciliation cycle.
+====
You can use the Kubernetes object editor of your preference to add or edit the
link:https://en.wikipedia.org/wiki/.properties[properties] in the Workflow
configuration. Using `kubectl` you can do:
@@ -41,11 +49,12 @@ The underlying runtime engine that executes the Workflow
service is based on lin
Any xref:core/configuration-properties.adoc[{product_name} configuration that
the documentation describes] or general Quarkus application property can be
configured using this method.
-== Immutable properties
+[#managed-props]
+== Managed properties
-A few properties cannot be changed in this configuration. Usually, they are
already defined in the properties file. The table below lists them.
+A few properties cannot be changed in this configuration and they are defined
in the managed properties file. The table below lists them.
-.List of immutable properties
+.List of managed properties
[cols="2,1,1"]
|===
|Property Key | Immutable Value | Profile
@@ -64,10 +73,18 @@ A few properties cannot be changed in this configuration.
Usually, they are alre
|===
+Other managed properties include:
+
+* The
xref:use-cases/advanced-developer-use-cases/service-discovery/kubernetes-service-discovery.adoc[Kubernetes
service discovery] properties
+* The
xref:use-cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc[Data
Index location properties]
+* The
xref:use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc[Job
Service location properties]
+
+
If you try to change any of them, the operator will override them with the
default, but preserving your changes in other property keys.
== Additional resources
+* https://quarkus.io/guides/config-reference#profile-aware-files[Quarkus -
Profile aware files]
* xref:core/configuration-properties.adoc[]
* xref:cloud/operator/known-issues.adoc[]
* xref:cloud/operator/developing-workflows.adoc[]
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
index 14049ef81..87892969f 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/customize-podspec.adoc
@@ -63,12 +63,12 @@ Besides customizing the default container, you can add more
`containers`, `initC
| workflow-properties
| `ConfigMap`
-| `/deployments/config/application.properties`
+| `/deployments/config/application.properties`,
`/deployments/config/application-prod.properties`
| prod
| workflow-properties
| `ConfigMap`
-| `$\{PROJECT_ROOT\}/src/main/resources/application.properties`
+| `$\{PROJECT_ROOT\}/src/main/resources/application.properties`,
`$\{PROJECT_ROOT\}/src/main/resources/application-dev.properties`
| dev
| resources
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
