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

[KOGITO-9265] Add PodSpec customization guide #506

Merged
merged 3 commits into from
Sep 29, 2023

Conversation

ricardozanini
Copy link
Member

JIRA:
https://issues.redhat.com/browse/KOGITO-9265

Description:
In this PR, we add a new guide to explain the new feature able to customize PodSpec in SonataFlow CR.

Depends on:

Please make sure that your PR meets the following requirements:

  • You have read the contributions doc
  • Pull Request title is properly formatted: KOGITO-XYZ Subject
  • Pull Request title contains the target branch if not targeting main: [0.9.x] KOGITO-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.

sonataflow.org/version: 0.0.1
spec:
podTemplate: <1>
container: <2>
Copy link
Contributor

Choose a reason for hiding this comment

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

so the container instead of containers is a deviation on purpose from k8s podTemplate right?


=== Setting a custom image in production

When xref:cloud/operator/build-and-deploy-workflows.adoc[deploying in production], you can opt in to have the operator to handle the build process for you. However, in more complex scenarios it's expected that the user owns and controls the build process. For this reason, when overriding the image the operator won't build the workflow. The operator will try to deploy the workflow using the given image.
Copy link
Contributor

Choose a reason for hiding this comment

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

will the rest of the spec.resources be mounted into that container at runtime? this is defintely the expectation.
In other words it should automatically populate the volumes list in the template.

Copy link
Member Author

@ricardozanini ricardozanini Sep 27, 2023

Choose a reason for hiding this comment

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

Hey @rgolangh! We can, though it won't at this moment. We should discuss this use case since we don't have a build, hence the resource won't be in the application's classpath (included in the jar). We should definitely understand where to mount these resources in this situation.

I'll add a note about this in this PR.

I've opened a JIRA for us to discuss: https://issues.redhat.com/browse/KOGITO-9845

Copy link
Member

@MarianMacik MarianMacik left a comment

Choose a reason for hiding this comment

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

Looks good!

@ricardozanini ricardozanini merged commit 87e857b into apache:main Sep 29, 2023
@ricardozanini ricardozanini deleted the kogito-9265 branch September 29, 2023 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.

5 participants