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 a requirement and installation doc for K3s #1624

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

ernestoteo
Copy link

@ernestoteo ernestoteo commented Oct 16, 2024

@ernestoteo
Copy link
Author

@mrjones-plip and @esthermmoturi ,
Would you check this update and confirm that I am on the right track.

Copy link
Contributor

Choose a reason for hiding this comment

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

This image is too small to be useful and I can't tell what it is. If you'd like to keep it, please move it to the new location under production 4.x k8s directory, make it higher resolution and ensure it's applicable for how to install CHT Core on k3s (and not a generic k3s architecture diagram).

Copy link
Contributor

@mrjones-plip mrjones-plip left a comment

Choose a reason for hiding this comment

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

Thanks for checking in @ernestoteo ! Nice to see some forward momentum on the ticket \o/

Feedback is:

  • per the parent ticket:

    this ticket does not mean adding steps for setting up k3s from scratch

    Unfortunately this means much of the content you've written needs to be remove 😢 . Replacing this with an intro sentence or two with something like "Please ensure your k3s cluster is set up and meets our requirements", but being sure to mention any extra configurations that deploy script needs or however you plan on pushing CHT Core to the cluster.

  • The requirements page was edited in this PR to massively reduce the hardware requirements - I suspect they're the bare minimum requirements of k3s, not of CHT. Please revert to what it is currently.

  • the image you've added needs some fixes - see my other comment

  • Please move your content to be the _index.md page inside the 4.x production k8s folder:
    image

@esthermmoturi
Copy link
Contributor

@mrjones-plip , are we going to encourage people to use K3s for local/dev hosting or is it just for production hosting?

@mrjones-plip
Copy link
Contributor

mrjones-plip commented Oct 17, 2024

For sure no k3s for dev hosting - it's just way too complicated when you don't need most of what it offers. current docs recommend docker helper which is a best practice and has everything you need for app development. Docker is used for smaller production hosting too!

@esthermmoturi
Copy link
Contributor

esthermmoturi commented Oct 18, 2024

Thanks @mrjones-plip for clarifying. @ernestoteo , you can incorporate the requested changes. Once the PR is ready you can convert it from 'draft' to 'ready for review'.

@ernestoteo
Copy link
Author

@mrjones-plip, from your comment, I should only document how to install K3s and what its component are ?

@mrjones-plip
Copy link
Contributor

@ernestoteo - nope - do not document how to install k3s. That is well covered in their docs.

What we're looking for is the happy path installation for CHT Core on an existing k3s deployment. You can look at the current production docker docs for a good example of what we hope to write for k3s.

This might include: What specifics steps do you need to take? Can you use the deploy script or do you need to do manual steps? Is ingres set up for you? Is the PVC and PV for couch set up by default or do you need to provision it? How do you generate a TLS cert for the static IP and DNS entry? What are the common trouble shooting issues you might face after you tried, but failed, to deploy CHT to k3s?

This means you're going to literally deploy k3s as the prerequisite and then literally deploy the CHT to it. Document the steps, tear it all down and then follow your own docs to make sure they work!

I'm happy to jump on a call if you still have more questions on what to do next

@mrjones-plip
Copy link
Contributor

@ernestoteo - there's a good example of what we're looking for with CHT Sync and their steps to deploy to k3s. Possibly reach out to @witash who did a lot of work on k3s & CHT Sync.

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

Successfully merging this pull request may close these issues.

3 participants