Improving documentation about creating Sharded Keyspace. #1817
Conversation
Signed-off-by: Satarupa Deb <[email protected]>
|
@mattlord please look into this. Thanks. |
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
This has to be done in 21.0 docs at a minimum, as that is what will become 22.0 ...
|
|
||
| 1. Create the keyspace | ||
| 2. Define and apply the VSchema | ||
| 3. Create physical shards | ||
| 4. Create tablets (instances) for each shard | ||
| 5. Initialize the schema on each shard | ||
| 6. (Optional) Migrate data from an unsharded keyspace | ||
|
|
||
| Each of these steps is crucial for a fully functional sharded keyspace. This guide will walk you through these steps, with a focus on VSchema definition and usage. | ||
|
|
||
| {{< info >}} | ||
| **Note**: Applying the VSchema (step 2) only defines the logical structure of your sharded keyspace. It does not create physical shards, tablets, or initialize the schema. Attempting to query the database after only applying the VSchema will result in errors such as "no healthy tablet available". Ensure you complete all the steps listed above before attempting to use your sharded keyspace. | ||
| {{< /info >}} |
There was a problem hiding this comment.
I don't think that this helps resolve the issue. It attempts to explain Vitess concepts when that is done elsewhere (it's assumed that you have some basic concepts in mind before you ever get to this point). It is also a bit confusing to me as I'm not sure what a physical shard is, how that is that not made up of tablets and mysqld pairs, etc.
I believe that the issue would be resolved by noting here that it's assumed you have run the local examples steps 101 - 307 and linking to the source code for those or other relevant docs.
There was a problem hiding this comment.
Thank you for pointing it out. I will check the existing documentation and create a new PR.
Adding this section would simplify the process for the users.
Resolves #1434