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 Camunda Exporter to Announcements page #4715

Closed
wants to merge 9 commits into from

Conversation

ChrisKujawa
Copy link
Member

@ChrisKujawa ChrisKujawa commented Dec 5, 2024

Description

When should this change go live?

  • 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)
  • 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

  • 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/).

Copy link
Contributor

github-actions bot commented Dec 5, 2024

👋 🤖 🤔 Hello, @mesellings! 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.6/.

  • docs/reference/announcements.md
  • docs/reference/img/camunda-exporter-target.png
  • docs/reference/img/harmonized-indices-miro.png
  • docs/reference/img/harmonized-indices-schema.png
  • docs/reference/img/target-camunda-exporter.png

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.

@ChrisKujawa ChrisKujawa requested review from akeller and MaxTru December 5, 2024 08:39
@ChrisKujawa ChrisKujawa added the 8.7.0-alpha2 December 2024 alpha release label Dec 5, 2024
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@ChrisKujawa ChrisKujawa marked this pull request as ready for review December 5, 2024 08:40
@mesellings
Copy link
Contributor

Hi @ChrisKujawa we already have a new draft Announcements PR in progress for alpha 2 #4679 - can I just pull this content out from your PR and add it into this existing PR please?

@mesellings
Copy link
Contributor

As agreed with @ChrisKujawa, I'll review this PR then bring the approved content into the draft Announcements PR

@mesellings mesellings self-requested a review December 5, 2024 09:29
@mesellings mesellings added the hold This issue is parked, do not merge. label Dec 5, 2024
mesellings
mesellings previously approved these changes Dec 5, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

@ChrisKujawa I've reviewed and made amends directly to the text, I'm going to look at the images next, but looks good - I assume we are allowed/it is okay to expose our architecture to users like this?

@mesellings mesellings changed the title Add Camunda Exporter to Announcements page DO NOT MERGE Add Camunda Exporter to Announcements page Dec 5, 2024
@ChrisKujawa
Copy link
Member Author

I assume we are allowed/it is okay to expose our architecture to users like this?

In my opinion we should. I actually wanted to have anyway a better overview for our architecture. I would see this as first step

@mesellings
Copy link
Contributor

mesellings commented Dec 5, 2024

@ChrisKujawa I've modified the Miro diagram for the harmonized schema - it's just a quick alignment on colours, accessibility (e.g. text on block colours is bad for accessibility), but will do until i can take a look at our diagramming standards across the board (it's on the wishlist).

image

@ChrisKujawa
Copy link
Member Author

Love it ! Thank you 🙏🏼

@ChrisKujawa
Copy link
Member Author

@mesellings We need to update the image and miro board, we realized a flaw in the index naming.

I will change the miro board, can you upload an new screenshot?

@mesellings
Copy link
Contributor

@ChrisKujawa I've added the second diagram now as well - let me know when you have made your changes.

image

Note: I've locked these two diagrams on the Miro board so we don't change accidentally - Miro can be a bit flaky sometimes).

@ChrisKujawa
Copy link
Member Author

Thanks @mesellings for your efforts 👍🏼

@mesellings
Copy link
Contributor

@ChrisKujawa Are you happy for me to port the content over into the Announcements PR, or are you waiting for any other reviewer?

@ChrisKujawa
Copy link
Member Author

ChrisKujawa commented Dec 5, 2024

I think we fine now @mesellings. I also got positive feedback from Amara so I think we are good.

We anyway can always iterate 👍🏼

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

Approving despite two somewhat nitpicky comments that can be handled on the overall announcements PR. Your choice :)

Since this discussion is on a private channel, this high-level overview is perfect for announcements, but we should come back and add links to other pages or a blog when more info is available.


- For example, Tasklist and Operate Importers are still required for old data to be imported, but the Camunda exporter writes all new data into ES/OS. After old indices are drained, importers can be turned off.

- The Archiver, which takes care of the archiving of completed process instances, will be moved into the Zeebe system as well, to reduce the installation complexity and provide a better scaling and replication factor (based on partitions).
Copy link
Member

Choose a reason for hiding this comment

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

Should "Archiver" really be capitalized?


![camunda-exporter-target](./img/target-camunda-exporter.png)

- For example, Tasklist and Operate Importers are still required for old data to be imported, but the Camunda exporter writes all new data into ES/OS. After old indices are drained, importers can be turned off.
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 one use of ES/OS in the docs today, but in line 32 can we adjust this to "ElasticSearch (ES) or Opensearch (OS)" so the rest of the announcement we can say ES/OS without creating potential confusion?

@akeller
Copy link
Member

akeller commented Dec 5, 2024

I think we fine now @mesellings. I also got positive feedback from Amara so I think we are good.

🧠 🤝 🧠 (even if I'm slower, by 2 min 😆)

@mesellings mesellings mentioned this pull request Dec 5, 2024
9 tasks
@mesellings
Copy link
Contributor

@ChrisKujawa I've taken the content from this PR now, so it can be closed - thanks for your help with this, great work 👍 🚀

@mesellings mesellings closed this Dec 5, 2024
@mesellings
Copy link
Contributor

Closed as this content was added into #4679

@mesellings mesellings changed the title DO NOT MERGE Add Camunda Exporter to Announcements page Add Camunda Exporter to Announcements page Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha2 December 2024 alpha release hold This issue is parked, do not merge.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants