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

doc(self-managed): improve opensearch and irsa doc with placeholders and role mapping #4302

Merged
merged 7 commits into from
Sep 18, 2024

Conversation

leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Sep 13, 2024

Description

This PR improves the IRSA instructions for Self-managed installation with the addition of placeholders and a missing instruction for OpenSearch.

it also introduces the alternative aws cli in tabs instead of terraform for user convenience

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

@leiicamundi leiicamundi self-assigned this Sep 13, 2024
@leiicamundi leiicamundi added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Sep 13, 2024
@leiicamundi leiicamundi requested a review from a team September 13, 2024 15:46
@leiicamundi
Copy link
Contributor Author

Note for the reviewer, I still need to test the commands with a real infra, otherwise the content and the form is ready to be review

@Langleu Langleu added the deploy Stand up a temporary docs site with this PR label Sep 16, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs September 16, 2024 08:18 Destroyed
Copy link
Member

@Langleu Langleu left a comment

Choose a reason for hiding this comment

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

only reviewed the next docs, but left some smaller comments.
Overall, looks like a nice addition!

@christinaausley
Copy link
Contributor

Is this in draft because there are additional changes coming, or is this ready for a final review? 😄

@leiicamundi
Copy link
Contributor Author

Hello @christinaausley, after internal review, we will add additional things, I'll send you an update when it's ready to be reviewed.
Thank you

@github-actions github-actions bot temporarily deployed to camunda-docs September 17, 2024 18:20 Destroyed
Copy link
Member

@Langleu Langleu left a comment

Choose a reason for hiding this comment

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

Looks good from my side 👍, thanks for the adjustments 🚀

@leiicamundi
Copy link
Contributor Author

I've double-checked the CLI commands, and everything is working.

@christinaausley, could you please perform a final review? After that, we'll be good to merge.

Thank you in advance!

@leiicamundi leiicamundi marked this pull request as ready for review September 18, 2024 12:59
@leiicamundi leiicamundi enabled auto-merge (squash) September 18, 2024 12:59
@github-actions github-actions bot temporarily deployed to camunda-docs September 18, 2024 13:08 Destroyed
@leiicamundi leiicamundi merged commit afa4a6f into main Sep 18, 2024
7 checks passed
@leiicamundi leiicamundi deleted the feature/improve-opensearch-irsa branch September 18, 2024 13:15
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

@leiicamundi leiicamundi restored the feature/improve-opensearch-irsa branch September 18, 2024 14:20
@leiicamundi
Copy link
Contributor Author

@christinaausley The auto-merge feature merged the branch automatically—my mistake. Could you please review the changes and let me know if any further adjustments are needed? I've re-opened the branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants