planetscale
Documentation Request
Hello, I'm putting this issue up to request more comprehensive documentation, particularly as it relates to understanding Vitess and running in production on EKS. I've been using OpenTofu to provision everything and its not intuitive how it all comes together. Using ChatGPT is also limited due to the lack of available information on Vitess. Are there other ways anyone would recommend learning this system in the meantime?
The Vitess documentation is on the website: https://vitess.io/docs/
How does EKS and OpenTofu come into play here?
Please be aware that there's a small group of Vitess maintainers that do everything for the project (including the vitess-operator): project/program management, development (bugs and new features), support/DevRel, documentation, releases, builds, etc.
You'll need to be much more specific about what you'd like to see, and contributions are most appreciated. You are using this FOSS product in production, in your specific environment, so in some ways you have more knowledge than the Vitess developers do.
For more general community help, you should explore the community: https://vitess.io/community/
Thanks for the quick response. I see there are serious constraints on developer time. I will contribute some articles and documentation myself to help the effort if I can make the time.
For more specifics, I am currently setting up test and production environments in code with test driven OpenTofu for the EKS infrastructure. My objective is to have a one command start-up for all the AWS infrastructure necessary to host Django applications (in AppRunner) that connect to Vitess dbs behind a private subnet. This is to help my university with an application migration project.
My current progress can be found on the vitess branch in github.com/UCF/terraform
Once I've completed this I will try to contribute back to the community. This issue was started as a general request for more comprehensive documentation. My learning style tends to lean towards reading textbooks or full documentation on subjects, but unfortunately there are no Vitess specific books out yet. I have many gaps in my knowledge so it's hard to even know the right questions to ask. I will come back with better tailored questions once I run into more problems/solutions.
Thanks for the community link and your time
As @mattlord said, @ucfchandra there are other means to contact us, including our Slack (https://vitess.io/slack). There are many discussions about vitess-operator there that can be found, that should help you out! You can also ask questions there either in #general or #operator.
On top of all of that, there are already a lot of resources (blog post, talks, conference, etc) that were done about Vitess and the operator. This link will help you out: https://vitess.io/docs/learning-resources/
