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

Update docs for officially supported helm charts #609

Closed
Tracked by #123
Hafflgav opened this issue Feb 15, 2022 · 11 comments
Closed
Tracked by #123

Update docs for officially supported helm charts #609

Hafflgav opened this issue Feb 15, 2022 · 11 comments
Assignees

Comments

@Hafflgav
Copy link

Since @Zelldon is currently working on officially supporting the helm charts for camunda cloud self-managed the documentation needs to be updated as well.
The goal is to update https://docs.camunda.io/docs/self-managed/zeebe-deployment/kubernetes/index/

Related epic:
camunda/camunda-platform-helm#123

@Hafflgav
Copy link
Author

What do you think about changing the structure of the content @Zelldon?
I am thinking about combining Kubernetes Overview & Helm overview so we would end up with one hierarchy less.

image

@Zelldon
Copy link
Member

Zelldon commented Feb 16, 2022

Sorry for the late response @Hafflgav

Yeah I was generally interested in revisting the current structure. For me it would make sense to have instead of

SelfManaged:

  • Zeebe
    • Docker
    • K8
  • Tasklist
  • Operate

Something Like:

SelfManaged:
* Kubernetes
  * Zeebe
  * Operate
  * Tasklist
* Docker
  * Zeebe
  * Operate
  * Tasklist

Would like to hear the opinion of @akeller

@akeller
Copy link
Member

akeller commented Feb 16, 2022

My understanding of Kubernetes/Helm was we would have a single chart for all the components, so would we need to split out the components under the Kubernetes section individually?

I like your approach here @Zelldon. And I definitely appreciate one less hierarchy as @Hafflgav suggests! Great mindset to bring to these docs!

@Hafflgav
Copy link
Author

Even though I like the structure proposed by @Zelldon a lot I have problems splitting up the content properly. In my opinion it will be quite an effort to achieve this structure

Due to this I wanted to propose this structure:

  • Deployment
    • Kubernetes
    • Docker
    • LocalInstallation
  • Zeebe
    • Configuration
    • Security
    • Operation
  • Operate
  • Tasklist
  • Optimize
  • IAM
  • Troubleshooting

By doing so we will have one chapter for deployment options and the others for configuration options of the different tools.
Any other opinions or remarks @Zelldon, @akeller & @felix-mueller?

@felix-mueller
Copy link
Member

Like what you are suggesting

@Zelldon
Copy link
Member

Zelldon commented Feb 23, 2022

Not 100% sure how it will look like in real since the configuration differs based on the deployment strategy i would say? 🤔

For example with docker you set everything over env vars. In helm you have the values file where you set properties. Or do we just link to the different repos then (helm has a good readme which describes all values)? And in Zeebe, Operate section we explain in general the configuration which exist?

What is the blocker you see with restructuring the docs?

@Hafflgav
Copy link
Author

That is true - But to me it seems that all the other pages do not have a clear separation between the deployment strategy. As far as my (still limited) knowledge goes, we would need to rip them apart and recreate them accordingly so it makes sense.
Since this seems like a lot of work (and I do have limited capacities) I wanted to find a quicker fix for the first solution.

But I agree with you -> In the ultimate goal is to have a structure which you have shown above.

@Zelldon
Copy link
Member

Zelldon commented Feb 23, 2022

Might be better to do it in iterations then, and open more issues for potential improvements and ideas etc This would also fit better in situations where we have time-constraints and we can might distribute the issues if they are clear enough :) So like first merge the changes you did and then we (me or you or whoever has time and need) can continue to work on them.

@Hafflgav
Copy link
Author

Agreed! Let's proceed this way. @akeller or @christinaausley will close the PR #614 soon and I will create a new issue for the structure of the self-managed section in our documentation.
I will ping you once this is done. Somehow splitting up the work seems promising! Happy to help - as always 👍

@berndruecker
Copy link
Member

Can we close this now with the new self-managed installations section @Hafflgav

@Hafflgav
Copy link
Author

Hafflgav commented Apr 7, 2022

Yes, we can do :)
Thanks @berndruecker for taking care of it!

@Hafflgav Hafflgav closed this as completed Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants