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.

Sign up for GitHub

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

Jump to bottom

docs(self-managed): external-elasticsearch configuration #3521

Merged
merged 32 commits into from
Apr 5, 2024
Merged

docs(self-managed): external-elasticsearch configuration #3521

merged 32 commits into from
Apr 5, 2024

Conversation

hamza-m-masood
Copy link
Contributor

@hamza-m-masood hamza-m-masood commented Mar 25, 2024 •
edited
Loading

Description

related to:
epic: https://github.com/camunda/distribution/issues/179
product-hub issue: https://github.com/camunda/product-hub/issues/1946
I am creating docs on how to setup external elasticsearch and aws managed opensearch.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@hamza-m-masood hamza-m-masood added the hold This issue is parked, do not merge. label Mar 25, 2024
@hamza-m-masood hamza-m-masood self-assigned this Mar 25, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 25, 2024 •
edited
Loading

👋 🤖 🤔 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.4/.

  • docs/self-managed/setup/deploy/amazon/amazon-eks/irsa.md
  • docs/self-managed/setup/guides/using-existing-elasticsearch.md
  • docs/self-managed/setup/guides/using-existing-opensearch.md
  • docs/self-managed/setup/upgrade.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.

@hamza-m-masood
Copy link
Contributor Author

I will create a similar file like this for opensearch.

@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Mar 27, 2024
@christinaausley
Copy link
Contributor

Is this in draft because there are additional changes coming? If not, happy to review 👍

aabouzaid
aabouzaid requested changes Mar 28, 2024
View reviewed changes
Copy link
Member

@aabouzaid aabouzaid left a comment

Choose a reason for hiding this comment

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

@hamza-m-masood
I've left some major and minor comments.

Also, please don't forget to add the migration steps since the new syntax has a breaking change (also reflect that in the other guides in the docs).

@christinaausley
Copy link
Contributor

@hamza-m-masood I believe you'll just need to add these files to the optimize_sidebars.js and sidebars.js files.

aabouzaid
aabouzaid previously approved these changes Apr 5, 2024
View reviewed changes
christinaausley
christinaausley requested changes Apr 5, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Add to sidebars 👍

@hamza-m-masood
Copy link
Contributor Author

Add to sidebars 👍

Apologies for the messy commits. I reverted the accidental merge.
I added in my files.

christinaausley
christinaausley previously approved these changes Apr 5, 2024
View reviewed changes
christinaausley
christinaausley previously approved these changes Apr 5, 2024
View reviewed changes
christinaausley
christinaausley previously approved these changes Apr 5, 2024
View reviewed changes
@christinaausley christinaausley enabled auto-merge (squash) April 5, 2024 17:44
@christinaausley christinaausley merged commit 288b4d7 into main Apr 5, 2024
6 checks passed
@christinaausley christinaausley deleted the external-elasticsearch-docs branch April 5, 2024 19:00
theburi pushed a commit that referenced this pull request Jun 5, 2024
@hamza-m-masood @christinaausley @theburi
docs(self-managed): external-elasticsearch configuration (#3521)
012ccb4 
* first draft of external-elasticsearch documentation

* changing wording of first paragraph

* changed wording

* added opensearch document page

* updated elasticsearch doc

* updated elasticsearch doc with new layout

* from opensearch to Opensearch

* from opensearch to OpenSearch

* es doc changes

* opensearch changes

* linking to specific opensearch section

* aws iam

* change opensearch file name and added upgrade guide

* fixed typo in upgrade guide

* upgrade guide es breaking changes

* added irsa doc, fixed few typos

* added requested changes

* changed link

* style(formatting): technical review

* added in sidebar files

* Revert "Merge branch 'external-elasticsearch-docs' of https://github.com/camunda/camunda-docs into external-elasticsearch-docs"

This reverts commit 1577a62, reversing
changes made to a7fe264.

* added sidebar files

* fixed typo

* fix sidebar ids

* resolve broken links

---------

Co-authored-by: christinaausley <[email protected]>
Co-authored-by: Christina Ausley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hisImminence hisImminence hisImminence left review comments

@christinaausley christinaausley christinaausley approved these changes

@aabouzaid aabouzaid aabouzaid left review comments

Assignees

@hamza-m-masood hamza-m-masood

Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@hamza-m-masood @christinaausley @aabouzaid @hisImminence