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-9971: [Guides] Dataindex deployment use cases with operator #519

Merged
merged 6 commits into from
Dec 12, 2023

Conversation

nmirasch
Copy link
Contributor

jira: https://issues.redhat.com/browse/KOGITO-9971

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.

@tchughesiv
Copy link
Contributor

tchughesiv commented Nov 29, 2023

does this use the new built-in data index deployment capabilities we've added to the operator? fyi, in case you hadn't seen or used it yet.
#518

granted, not sure when a new release will occur that would make this feature available

@nmirasch
Copy link
Contributor Author

does this use the new built-in data index deployment capabilities we've added to the operator? fyi, in case you hadn't seen or used it yet. #518

granted, not sure when a new release will occur that would make this feature available

This use cases were done before that new feature, so the answer is no. For the moment they are showing a way to see that deployments working, and I think those use cases will need to be updated including that new feature you commented and that will be reflected in the doc as well. @ricardozanini WDYT?

@ricardozanini
Copy link
Member

@nmirasch this is the reason why I mentioned you in #518 last week. Your guides should reflect that feature since we are going to release it together.

@ricardozanini
Copy link
Member

Just to rectify my comment, we should merge this, then #518, and then open another to change this guide to link to #518. So we will have a version of this guide that won't include DI in the operator.

Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

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

Now we need to be creative and incorporate the use cases' sandbox repo here instead of linking to it.


* kogito-addons-quarkus-data-index-persistence-postgresql
* kogito-addons-quarkus-data-index-persistence-infinispan
* kogito-addons-quarkus-data-index-persistence-mongodb
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a little description of each?

@nmirasch
Copy link
Contributor Author

nmirasch commented Dec 1, 2023

@ricardozanini removed the ref to usecases repo and put the dataindex deployment related kustomization resources in detail. While we are waiting for the change the doc to link the new feature about the dataindex deployment reference. could you take a look? Thanks!

Copy link
Contributor

@domhanak domhanak left a comment

Choose a reason for hiding this comment

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

There are some steps that are expecting something that does not exist, we need to include these in the guides.

@nmirasch
Copy link
Contributor Author

nmirasch commented Dec 7, 2023

I've added the referenced use cases to our official example here apache/incubator-kie-kogito-examples#1839 and modified the guides links to that.

@domhanak domhanak removed the request for review from MarianMacik December 7, 2023 14:55
@LuboTerifaj LuboTerifaj self-requested a review December 7, 2023 17:49
Copy link
Contributor

@LuboTerifaj LuboTerifaj left a comment

Choose a reason for hiding this comment

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

Hello @nmirasch ,

I checked Data Index Quarkus extensions section (data-index-quarkus-extension.adoc file) and I have a few minor comments.

There is missing an explanation, what is the difference between "Quarkus Data Index" and "Quarkus Data Index persistence" extensions.

The referenced "PostgreSQL Configuration" section does not contain all necessary information about how to configure the database properly.

Thanks!

@domhanak domhanak merged commit ea6e22d into apache:main Dec 12, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants