Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note about Knative deployment model in the operator #624

Merged
merged 3 commits into from
May 9, 2024

Conversation

ricardozanini
Copy link
Member

Closes apache/incubator-kie-kogito-serverless-operator#385

Description:
In this PR, we add a brief explanation about deploying workflows as Knative Services.

Depends on apache/incubator-kie-kogito-serverless-operator#447

Please make sure that your PR meets the following requirements:

  • You have read the contributions doc
  • 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
How to backport a pull request to a different branch?

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.

Copy link
Contributor

github-actions bot commented Apr 18, 2024

🎊 PR Preview 9a25a3f has been successfully built and deployed. See the documentation preview: https://sonataflow-docs-preview-pr-624.surge.sh

Copy link
Contributor

@jakubschwan jakubschwan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just spot one typo. The rest LGTM

@ricardozanini ricardozanini added the DO_NOT_MERGE 🙅 don't merge this PR label May 8, 2024
@ricardozanini
Copy link
Member Author

Need to add a note about Knative not supporting initContainers.

@ricardozanini ricardozanini removed the DO_NOT_MERGE 🙅 don't merge this PR label May 8, 2024
@ricardozanini
Copy link
Member Author

@wmedvede can you PTAL?


The exception are workflows that have callback states. In this case, you must configure xref:cloud/operator/using-persistence.adoc[persistence]. This is required because once the workflow waits for the event to resume the execution, Knative will kill the pod. Since the workflow has persistence, it will resume the execution once it receives the callback event.

Knative **does not support** link:{kubernetes_init_containers}[`initContainers`] by default. If your workflow requires it, you must first enable the extension in the Knative installation. See more information on the link:{knative_serving_initcontainer}[Knative documentation].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, didn't know that

@ricardozanini ricardozanini merged commit 70426a5 into apache:main May 9, 2024
2 checks passed
@ricardozanini ricardozanini deleted the operator-385 branch May 9, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Opt-in deploy SonataFlow as Knative Serving service instead of k8s Deployments
4 participants