This is an automated email from the ASF dual-hosted git repository.
dhanak 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 03f0f490d NO-ISSUE: Clarify that `.spec.resources` is ignored in
gitops (#723)
03f0f490d is described below
commit 03f0f490d0f6705939400e218fd29ba748f87807
Author: Ricardo Zanini <[email protected]>
AuthorDate: Thu May 22 04:17:29 2025 -0300
NO-ISSUE: Clarify that `.spec.resources` is ignored in gitops (#723)
* NO-ISSUE: Clarify that is ignored in gitops
Signed-off-by: Ricardo Zanini <[email protected]>
* Fix profile naming
Signed-off-by: Ricardo Zanini <[email protected]>
---------
Signed-off-by: Ricardo Zanini <[email protected]>
---
.../cloud/operator/referencing-resource-files.adoc | 22 ++++++++++++++++++----
1 file changed, 18 insertions(+), 4 deletions(-)
diff --git
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/referencing-resource-files.adoc
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/referencing-resource-files.adoc
index be56488cf..8d2f4ac64 100644
---
a/serverlessworkflow/modules/ROOT/pages/cloud/operator/referencing-resource-files.adoc
+++
b/serverlessworkflow/modules/ROOT/pages/cloud/operator/referencing-resource-files.adoc
@@ -14,6 +14,15 @@ For example, when doing
xref:service-orchestration/orchestration-of-openapi-base
If these files are not in a remote location that can be accessed via the HTTP
protocol, you must describe in the `SonataFlow` CR where to find them within
the cluster. This is done via link:{kubernetes_configmap_url}[`ConfigMaps`].
+[IMPORTANT]
+====
+The `.spec.resources` section is **ignored in the `gitops` profile**.
+
+To use referenced external files like OpenAPI specs or schemas, make sure your
workflow is running under a supported profile such as `dev` or `preview`.
+
+See more in
xref:cloud/operator/deployment-profile.adoc#_profile_implications_for_customization[Deployment
Profile Implications].
+====
+
== Creating ConfigMaps with Workflow referencing additional files
.Prerequisites
@@ -55,7 +64,7 @@ spec:
end: true
----
-<1> The workflow defines an input schema
+<1> The workflow defines an input schema
<2> The workflow requires an OpenAPI specification file to make a REST
invocation
The `Hello Service` workflow in the example offers two options. You can either
create two `ConfigMaps`, each for one file, to have a clear separation of
concerns or group them into one.
@@ -77,7 +86,7 @@ Replace `<workflow-namespace>` with the namespace where you
are going to deploy
You should have a `ConfigMap` with two data entries similar to this one:
-.Example of a ConfigMap containing the data for the worflow
+.Example of a ConfigMap containing the data for the workflow
[source,yaml,subs="attributes+"]
----
kind: ConfigMap
@@ -93,6 +102,11 @@ data:
Now you can add reference to this `ConfigMap` into your `SonataFlow` CR:
+[NOTE]
+====
+The following example only works in profiles that support `.spec.resources`,
such as `dev` or `preview`. It **does not work** under the `gitops` profile.
+====
+
.SonataFlow CR referencing a ConfigMap resource
[source,yaml,subs="attributes+"]
----
@@ -127,8 +141,8 @@ spec:
end: true
----
-<1> Introduced a new attribute `.spec.resources` where you can bind the
`ConfigMap` to the `SonataFlow` CR
-<2> The name of the `ConfigMap` in the same namespace
+<1> Introduced a new attribute `.spec.resources` where you can bind the
`ConfigMap` to the `SonataFlow` CR
+<2> The name of the `ConfigMap` in the same namespace
<3> The path where we want to reference these files
Note that the `workflowPath` is `specs`. This is the path where you want to
reference the files within the `ConfigMap` in the workflow definition.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
