You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kie.apache.org by "wmedvede (via GitHub)" <gi...@apache.org> on 2024/05/28 15:12:47 UTC
[PR] [Draft PR, don't mind] Draft PR Changes [incubator-kie-kogito-docs]
wmedvede opened a new pull request, #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642
<!-- 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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "wmedvede (via GitHub)" <gi...@apache.org>.
wmedvede merged PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642
--
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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "wmedvede (via GitHub)" <gi...@apache.org>.
wmedvede commented on PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#issuecomment-2135743544
Hi @kaldesai , this Job Service section is related to the conversation we had in Monday's meeting.
Where we chatted about that Job Service should now go into the product documentation similar to what you did or are doing for the data-index.
--
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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "gmunozfe (via GitHub)" <gi...@apache.org>.
gmunozfe commented on code in PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#discussion_r1618421085
##########
serverlessworkflow/modules/ROOT/pages/job-services/core-concepts.adoc:
##########
@@ -49,42 +49,27 @@ Additionally, it can manage all the required configurations for every workflow t
To learn how to install and configure the Job Service in this case, you must read the xref:cloud/operator/supporting-services.adoc[Operator Supporting Services] section.
[#executing]
-== Executing
+== Custom Execution
-To execute the Job Service in your docker or Kubernetes environment, you must use the following image:
+To execute the Job Service in your docker or Kubernetes environment, you must use any of the following images, depending on the persistence mechanism to use <<job-service-postgresql, PostgreSQL>> or <<job-service-ephemeral, Ephemeral>>.
-* link:{jobs_service_image_allinone_url}[kogito-jobs-service-allinone]
+* `{jobs_service_image_postgresql}`
+* `{jobs_service_image_ephemeral}`
-In the next topics you can see the different configuration parameters that you must use, for example, to configure the <<job-service-persistence,persistence mechanism>>, the <<job-service-eventing-api, eventing system>>, etc.
-More information on this image can be found link:{jobs_service_image_usage_url}[here].
+In the next topics you can see how to configure them.
+
+[NOTE]
+====
+The <<job-service-global-configurations, common configurations>> and the <<job-service-eventing-api, eventing API configurations>> are the same for both images.
+====
We recommend that you follow this procedure:
-1. Identify the <<job-service-persistence,persistence mechanism>> to use and see the required configuration parameters.
+1. Identify the image to use depending on the persistence mechanism, and see the required configuration parameters specific for that image.
2. Identify if the <<job-service-eventing-api, Eventing API>> is required for your needs and see the required configuration parameters.
3. Identify if the project containing your workflows is configured with the appropriate xref:use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc#job-service-quarkus-extensions[Job Service Quarkus Extension].
Review Comment:
Wrong link
```suggestion
3. Identify if the project containing your workflows is configured with the appropriate xref:use-cases/advanced-developer-use-cases/quarkus-extensions.adoc#job-service-quarkus-extensions[Job Service Quarkus Extension].
```
--
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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "gmunozfe (via GitHub)" <gi...@apache.org>.
gmunozfe commented on code in PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#discussion_r1618407068
##########
serverlessworkflow/modules/ROOT/pages/job-services/core-concepts.adoc:
##########
@@ -94,7 +79,7 @@ To configure the image by using environment variables you must pass one environm
.Job Service image configuration for docker execution example
[source, bash,subs="attributes+"]
----
-docker run -it -e JOBS_SERVICE_PERSISTENCE=postgresql -e VARIABLE_NAME=value {jobs_service_image_allinone}:latest
+docker run -it -e QUARKUS_DATASOURCE_USERNAME=postgresql -e VARIABLE_NAME=value {jobs_service_image_postgresql}:latest
Review Comment:
This value "postgresql" differs from the one in the example below. It's probably better to align them
```suggestion
docker run -it -e QUARKUS_DATASOURCE_USERNAME=postgres -e VARIABLE_NAME=value {jobs_service_image_postgresql}:latest
```
##########
serverlessworkflow/modules/ROOT/pages/job-services/core-concepts.adoc:
##########
@@ -49,42 +49,27 @@ Additionally, it can manage all the required configurations for every workflow t
To learn how to install and configure the Job Service in this case, you must read the xref:cloud/operator/supporting-services.adoc[Operator Supporting Services] section.
[#executing]
-== Executing
+== Custom Execution
-To execute the Job Service in your docker or Kubernetes environment, you must use the following image:
+To execute the Job Service in your docker or Kubernetes environment, you must use any of the following images, depending on the persistence mechanism to use <<job-service-postgresql, PostgreSQL>> or <<job-service-ephemeral, Ephemeral>>.
-* link:{jobs_service_image_allinone_url}[kogito-jobs-service-allinone]
+* `{jobs_service_image_postgresql}`
+* `{jobs_service_image_ephemeral}`
-In the next topics you can see the different configuration parameters that you must use, for example, to configure the <<job-service-persistence,persistence mechanism>>, the <<job-service-eventing-api, eventing system>>, etc.
-More information on this image can be found link:{jobs_service_image_usage_url}[here].
+In the next topics you can see how to configure them.
+
+[NOTE]
+====
+The <<job-service-global-configurations, common configurations>> and the <<job-service-eventing-api, eventing API configurations>> are the same for both images.
+====
We recommend that you follow this procedure:
-1. Identify the <<job-service-persistence,persistence mechanism>> to use and see the required configuration parameters.
+1. Identify the image to use depending on the persistence mechanism, and see the required configuration parameters specific for that image.
2. Identify if the <<job-service-eventing-api, Eventing API>> is required for your needs and see the required configuration parameters.
3. Identify if the project containing your workflows is configured with the appropriate xref:use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc#job-service-quarkus-extensions[Job Service Quarkus Extension].
Review Comment:
Wrong link
```suggestion
3. Identify if the project containing your workflows is configured with the appropriate xref:use-cases/advanced-developer-use-cases/quarkus-extensions.adoc#job-service-quarkus-extensions[Job Service Quarkus Extension].
```
--
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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "wmedvede (via GitHub)" <gi...@apache.org>.
wmedvede commented on PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#issuecomment-2137608248
> Just align the value with the example
added
--
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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "domhanak (via GitHub)" <gi...@apache.org>.
domhanak commented on PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#issuecomment-2136721317
@gmunozfe please check, this is JS related
--
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] kie-kogito-docs-641: Remove Job Service All in one image from documentation [incubator-kie-kogito-docs]
Posted by "wmedvede (via GitHub)" <gi...@apache.org>.
wmedvede commented on PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#issuecomment-2135739744
This is not draft anymore, would you mind guys review?
@ricardozanini @domhanak @nmirasch @kaldesai
--
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] [Draft PR, don't mind] Draft PR Changes [incubator-kie-kogito-docs]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #642:
URL: https://github.com/apache/incubator-kie-kogito-docs/pull/642#issuecomment-2135485282
🎊 PR Preview b3651a7b3f868e7d65d5446d02180dcf98898995 has been successfully built and deployed. See the documentation preview: https://sonataflow-docs-preview-pr-642.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