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

Guide for DB interceptor plugins #4171

Merged
merged 9 commits into from
Aug 28, 2024
Merged

Conversation

igpetrov
Copy link
Contributor

Description

Related to epic: https://github.com/camunda/product-hub/issues/563

When should this change go live?

The PR should be merged after this PR: camunda/camunda#20794 which we anticipate to happen during the week of August 19th. We're targeting 8.6.0-alpha5 release.

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR): will be merged after feat: initial code for plugin architecture camunda#20794 approved.
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

⚠️ The feature will be modified in the nearest future due to architecture streamlining changes. Therefore I have included a warning note in the documentation itself.

  • My changes are for an already released minor and are in /versioned_docs directory.

  • My changes are for the next minor and are in /docs directory (aka /next/).

  • I included my new page in the sidebar file(s).

  • I added a redirect for a renamed or deleted page to the .htaccess file.

@igpetrov igpetrov added component:zeebe Issues related with Zeebe project component:operate Issues related with Operate project component:tasklist Issues related with Tasklist project hold This issue is parked, do not merge. component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed 8.6.0-alpha5 September 2024 alpha release labels Aug 19, 2024
@igpetrov igpetrov requested review from npepinpe, akeller, felix-mueller and a team August 19, 2024 15:36
@igpetrov igpetrov self-assigned this Aug 19, 2024
Copy link
Contributor

github-actions bot commented Aug 19, 2024

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/self-managed/setup/guides/configure-db-custom-headers.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

```xml
<dependency>
<groupId>io.camunda</groupId>
<artifactId>camunda-search-plugins</artifactId>
Copy link
Member

Choose a reason for hiding this comment

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

I found it confusing at first that it's "search" plugin. Do you refer to OpenSearch and Elastic or why search? Isn't it more about the database? camunda-db-plugins e.g.?

@felix-mueller
Copy link
Member

generally lgtm, pre-approving, just one comment
one question in addition: is this really an operational guide? isn't it more about advanced config / installation?
@theburi FYI

@felix-mueller felix-mueller self-requested a review August 20, 2024 06:45
felix-mueller
felix-mueller previously approved these changes Aug 20, 2024
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

I restructured this page and made some edits, and will pre-approve if these changes look good to you. 👍 I also agree with @felix-mueller that this should live in the config/install guides at the moment.

@igpetrov
Copy link
Contributor Author

@felix-mueller @conceptualshark

Fair point, and that was my thought as well and the only alternative I considered was Self-Managed/Guides/Configure custom headers.

@igpetrov
Copy link
Contributor Author

The Install page is dedicated more to Helm charts and might be confusing to add it there

@conceptualshark
Copy link
Contributor

@igpetrov Is this ready for another review, or still in progress?

@igpetrov
Copy link
Contributor Author

Hi @conceptualshark

Please, give me few more moments, I'll need to move the page and then we can merge.

@igpetrov
Copy link
Contributor Author

igpetrov commented Aug 27, 2024

@conceptualshark

ah, okay, page is on the right spot. Then all good! Let's go with the final review and ready to merge

@igpetrov igpetrov removed the hold This issue is parked, do not merge. label Aug 27, 2024
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

Custom HTTP headers can be added to a component's Elasticsearch and OpenSearch HTTP clients by creating a new Java plugin, and adding the plugin to your Camunda 8 Self-Managed installation. Using custom HTTP headers may be helpful for adding authentication, tracking, or debugging to your database requests.
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to add for now that it's not supported for Optimize???

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was expecting for onboarding Optimize before 8.6. For now, we do not include Optimize config value. @felix-mueller do you think, we should explicitly mention Optimize not included?

@felix-mueller
Copy link
Member

felix-mueller commented Aug 27, 2024 via email

@igpetrov igpetrov merged commit d153695 into main Aug 28, 2024
7 checks passed
@igpetrov igpetrov deleted the guide-for-db-interceptor-plugins branch August 28, 2024 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha5 September 2024 alpha release component:operate Issues related with Operate project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:tasklist Issues related with Tasklist project component:zeebe Issues related with Zeebe project
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants