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): platform deployment keycloak irsa update: add cam… #3460

Merged
merged 18 commits into from
Mar 28, 2024
Merged

docs(self-managed): platform deployment keycloak irsa update: add cam… #3460

merged 18 commits into from
Mar 28, 2024

Conversation

leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Mar 12, 2024 •
edited
Loading

Keycloak Image for AWS IRSA

Description

Replacement of the previous documentation that explained how to build a custom Keycloak image with new documentation that points to the Keycloak image maintained by Camunda.

When should this change go live?

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.

@leiicamundi leiicamundi requested a review from Langleu March 12, 2024 13:58
@github-actions GitHub Actions
Copy link
Contributor

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

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Mar 12, 2024
@Langleu Langleu requested a review from christinaausley March 13, 2024 10:10
Langleu
Langleu previously approved these changes Mar 13, 2024
View reviewed changes
Copy link
Member

@Langleu Langleu left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks content wise good from my side. Just a small suggestion as a previous line is not necessary anymore.
I've also assigned Christina as afaik everything should be reviewed by a technical writer.

@christinaausley
Copy link
Contributor

Hiya 👋 Is this still in draft as you wait on https://github.com/camunda/keycloak is public and camunda/keycloak#24, or because you have additional changes coming? If you're ready for final review, feel free to pull this out of draft and apply the hold label.

@leiicamundi leiicamundi added the hold This issue is parked, do not merge. label Mar 15, 2024
@leiicamundi
Copy link
Contributor Author

Hey @christinaausley ,

Thank you for your message. Indeed, we are awaiting the public release of the repo https://github.com/camunda/keycloak. I've added a hold label; I'll inform you as soon as we're ready.
Thank you.

@leiicamundi leiicamundi added hold This issue is parked, do not merge. and removed hold This issue is parked, do not merge. labels Mar 20, 2024
@leiicamundi leiicamundi requested a review from Langleu March 21, 2024 13:35
maxdanilov
maxdanilov requested changes Mar 25, 2024
View reviewed changes
Copy link
Member

@maxdanilov maxdanilov left a comment

Choose a reason for hiding this comment

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

(Reviewing instead of Lars)
Looks good overall, leaving minor edit suggestions.

docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md Outdated Show resolved Hide resolved
@maxdanilov maxdanilov removed the request for review from Langleu March 25, 2024 13:02
@leiicamundi leiicamundi removed the hold This issue is parked, do not merge. label Mar 26, 2024
leiicamundi and others added 8 commits March 26, 2024 15:50
@leiicamundi
docs(self-managed): platform deployment keycloak irsa update: add cam…
0dff036 
…unda keycloak image
@leiicamundi
docs(self-managed): platform deployment keycloak irsa update: add cam…
2800c01 
…unda keycloak image v8.4
@leiicamundi
doc(self-managed): applied suggested changes
12f5ff7
@leiicamundi
doc(self-managed): update keycloak image to use bitnami fork
f7e0635
@leiicamundi
doc(self-managed): update keycloak image to use bitnami fork
7551b22
@leiicamundi
doc(self-managed): add reference to official keycloak doc
256bed4
@leiicamundi @github-actions
Update docs/self-managed/platform-deployment/helm-kubernetes/platform…
ba5cc18 
…s/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi @github-actions
Update versioned_docs/version-8.4/self-managed/platform-deployment/he…
373ae82 
…lm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi leiicamundi force-pushed the feature/keycloak-camunda-image branch from 835fd2d to bbb97eb Compare March 26, 2024 14:50
@leiicamundi leiicamundi marked this pull request as ready for review March 26, 2024 14:51
maxdanilov
maxdanilov previously approved these changes Mar 27, 2024
View reviewed changes
@maxdanilov maxdanilov added the component:infex Issues related with InfEx project label Mar 27, 2024
@leiicamundi
Copy link
Contributor Author

Hey @christinaausley ,

This PR is now ready to be reviewed and merged! Thank you in advance for your review

christinaausley
christinaausley approved these changes Mar 27, 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.

Clean work here 👍

docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

#### Kubernetes configuration
##### Helm chart
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that H4 and H5 headers will render equal to, if not slightly smaller than the standard text.

Would love to avoid this if possible, but will also circle back to it in https://github.com/camunda/developer-experience/issues/257.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review, @christinaausley!
In my opinion, I believe it's acceptable; HTML is primarily intended to be semantic.
image
Though it's smaller, it doesn't render like text; the bold style and margins distinctly denote it as a section.

@leiicamundi leiicamundi merged commit 6d295fc into main Mar 28, 2024
6 checks passed
@leiicamundi leiicamundi deleted the feature/keycloak-camunda-image branch March 28, 2024 12:35
theburi pushed a commit that referenced this pull request Apr 3, 2024
@leiicamundi @github-actions
@maxdanilov @christinaausley @theburi
docs(self-managed): platform deployment keycloak irsa update: add cam… (
89a4581 
#3460)

* docs(self-managed): platform deployment keycloak irsa update: add camunda keycloak image

* docs(self-managed): platform deployment keycloak irsa update: add camunda keycloak image v8.4

* doc(self-managed): applied suggested changes

* doc(self-managed): update keycloak image to use bitnami fork

* doc(self-managed): update keycloak image to use bitnami fork

* doc(self-managed): add reference to official keycloak doc

* Update docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs(self-managed): remove mention of gradle

* docs(self-managed): add missing driver configuration for keycloak irsa

* docs(self-managed): add helm configuration for keycloak irsa

* Update docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs(self-managed): fix absolute links

* docs(self-managed): apply suggestion

* Update docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: Maxim Danilov <[email protected]>

* fix link

* style(formatting): technical review

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Maxim Danilov <[email protected]>
Co-authored-by: Christina Ausley <[email protected]>
theburi pushed a commit that referenced this pull request Jun 5, 2024
@leiicamundi @github-actions
@maxdanilov @christinaausley @theburi
docs(self-managed): platform deployment keycloak irsa update: add cam… (
491969e 
#3460)

* docs(self-managed): platform deployment keycloak irsa update: add camunda keycloak image

* docs(self-managed): platform deployment keycloak irsa update: add camunda keycloak image v8.4

* doc(self-managed): applied suggested changes

* doc(self-managed): update keycloak image to use bitnami fork

* doc(self-managed): update keycloak image to use bitnami fork

* doc(self-managed): add reference to official keycloak doc

* Update docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs(self-managed): remove mention of gradle

* docs(self-managed): add missing driver configuration for keycloak irsa

* docs(self-managed): add helm configuration for keycloak irsa

* Update docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs(self-managed): fix absolute links

* docs(self-managed): apply suggestion

* Update docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/irsa.md

Co-authored-by: Maxim Danilov <[email protected]>

* fix link

* style(formatting): technical review

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Maxim Danilov <[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

@github-actions github-actions[bot] github-actions[bot] left review comments

@christinaausley christinaausley christinaausley approved these changes

@Langleu Langleu Langleu left review comments

@maxdanilov maxdanilov maxdanilov left review comments

Assignees

@leiicamundi leiicamundi

Labels
component:infex Issues related with InfEx project 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
@leiicamundi @christinaausley @maxdanilov @Langleu