KIE-ISSUE #1056 - Introduce an Example to have a custom APISIX Ingress to SonataFlow deployments sec use cases

[ricardozanini]

Many thanks for submitting your Pull Request ❤️!

Closes apache/incubator-kie-issues#1056

Please make sure that your PR meets the following requirements:

WARNING! Please make sure you are opening your PR against main branch!

• You have read the contributors guide
• 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
• Pull Request contains link to the JIRA issue
• Pull Request contains link to any dependent or related Pull Request
• Pull Request contains description of the issue
• Pull Request does not include fixes for issues other than the main ticket

How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:

• for pull request checks
  Please add comment: Jenkins retest this

• for a specific pull request check
  Please add comment: Jenkins (re)run [kogito-examples] tests

• for quarkus branch checks
  Run checks against Quarkus current used branch
  Please add comment: Jenkins run quarkus-branch

• for a quarkus branch specific check
  Run checks against Quarkus current used branch
  Please add comment: Jenkins (re)run [kogito-examples] quarkus-branch

• for quarkus main checks
  Run checks against Quarkus main branch
  Please add comment: Jenkins run quarkus-main

• for a specific quarkus main check
  Run checks against Quarkus main branch
  Please add comment: Jenkins (re)run [kogito-examples] quarkus-main

• for quarkus lts checks
  Run checks against Quarkus lts branch
  Please add comment: Jenkins run quarkus-lts

• for a specific quarkus lts check
  Run checks against Quarkus lts branch
  Please add comment: Jenkins (re)run [kogito-examples] quarkus-lts

• for native checks
  Run native checks
  Please add comment: Jenkins run native

• for a specific native check
  Run native checks
  Please add comment: Jenkins (re)run [kogito-examples] native

• for native lts checks
  Run native checks against quarkus lts branch
  Please add comment: Jenkins run native-lts

• for a specific native lts check
  Run native checks against quarkus lts branch
  Please add comment: Jenkins (re)run [kogito-examples] native-lts

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.

[tomasdavidorg]

I went through the example and I added some comments. I just did rough testing but I the plan is test it more.

[ricardozanini]

@tomasdavidorg this is still a draft. many of your comments have been addressed locally. Once I change to "ready for review" I give you guys a heads up. Thank you for preemptively reviewing it though. cc @domhanak

[ricardozanini]

@tomasdavidorg also please wait for my guide to be online so you can review both at once and save some time!

[tomasdavidorg]

@ricardozanini Sorry 😅. I will review when it is ready. But thanks for sharing the draft, it is good material for a quick look. 🙂

[ricardozanini]

@tomasdavidorg @wmedvede feel free to try the example locally :)

[tomasdavidorg]

Second review round... Just a small suggestions + formatting (I checked by VS Code YAML Red Hat plugin and I saw some indentation issues)

Still need to do another round to test the example together with the docs.

[ricardozanini]

@tomasdavidorg thank you, I've rerun the formatter. I don't use RH's formatting but that should be fine now. One thing to keep an eye on is that these formatters usually remove the \" from the jq expressions. That might impact the image build. Let me know if you find any issues.

[tomasdavidorg]

@ricardozanini Thanks a lot for all the changes 😊!

[ricardozanini]

@tomasdavidorg have you successfully run the example?

[tomasdavidorg]

@tomasdavidorg have you successfully run the example?

Yes. I just add some small comments to the docs PR.

[wmedvede]

LGTM, and I was able to execute the example by following the corresponding guide.
Thanks!