-
Notifications
You must be signed in to change notification settings - Fork 203
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
adding in freshdesk faqs #1430
base: prod
Are you sure you want to change the base?
adding in freshdesk faqs #1430
Conversation
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Thank you so much for doing this! Can you..
|
I will indeed fix the DCO and remove all the .DS_Stores ... I used a git commit -s ... so I wonder what went wrong but I'll be sure to get the DCO passing before my last commit. I've still got another round of text to add and then all the formatting to do but I'm hoping I'll be ready for review by EOW next week. |
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
Ok at a good spot now. Next week will be formatting and adjusting some wording. |
|
||
Secondary Vindexes are additional Vindexes against other columns of a table offering optimizations for WHERE clauses that do not use the Primary Vindex. Secondary Vindexes return a single or a limited set of keyspace IDs which will allow VTGate to only target shards where the relevant data is present. In the absence of a Secondary Vindex, VTGate would have to send the query to all shards (called a scatter query). | ||
|
||
It is important to note that Secondary Vindexes are only used for making routing decisions. The underlying database shards will need traditional indexes on those same columns, to allow efficient retrieval from the table on the underlying MySQL instances. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@deepthi - Would love to get some help adjusting the context here if anyone one has time. This one had two 'unhelpful' marks in Freshdesk so I'd love to make adjustments while doing this transition if possible?
|
||
The CreateLookupVindex process uses VReplication for the backfill process, until the lookup Vindex is “in sync”. Then the normal process for adding/deleting/updating rows in the lookup Vindex via the standard transactional flow when updating the “owner” table for the Vindex takes over. | ||
|
||
You can read more about how to make a CreateLookupVindex [here](https://vitess.io/docs/user-guides/configuration-advanced/createlookupvindex/). If you are unfamiliar with Vindexes we recommend that you first read the information [here](https://vitess.io/docs/reference/features/vindexes). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@deepthi - This one was also marked as 'unhelpful' so same request as above if at all possible. Thanks!
Signed-off-by: hallaroo <marla@planetscale.com>
Signed-off-by: hallaroo <marla@planetscale.com>
@hallaroo There are some edits I want to make to the FAQs as I review them. I will get these "unhelpful" Q&A's rewritten during that process as well. JFYI that I'm planning to push commits to the branch with these changes. |
Signed-off-by: deepthi <deepthi@planetscale.com>
|
||
## Examples of how to use Vitess components | ||
|
||
We have a couple of step through examples in Github [here](https://github.com/aquarapid/vitess_examples). Currently, these cover Operator Backup and Restore, Create Lookup Vindex, and VStream. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either we should move these examples into their own pages on the website, or remove this section.
|
||
## What Grafana dashboards are available? | ||
|
||
There are a set of Grafana dashboards and Prometheus alerts available on the Vitess tree in GitHub [here](https://github.com/vitessio/vitess/tree/master/vitess-mixin). You can get some additional context on these dashboards [here](https://github.com/vitessio/vitess/pull/5609). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a set of Grafana dashboards and Prometheus alerts available on the Vitess tree in GitHub [here](https://github.com/vitessio/vitess/tree/master/vitess-mixin). You can get some additional context on these dashboards [here](https://github.com/vitessio/vitess/pull/5609). | |
There are a set of Grafana dashboards and Prometheus alerts available on the Vitess tree in GitHub [here](https://github.com/vitessio/vitess/tree/main/vitess-mixin). You can get some additional context on these dashboards [here](https://github.com/vitessio/vitess/pull/5609). |
|
||
## How do I create a unique index for a column in Vitess? | ||
|
||
Unique index is a distinct MySQL option. For Vitess just normal MySQL DDL will do. You have a couple other options as well either to use `ApplySchema` or directly apply the index to MySQL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unique index is a distinct MySQL option. For Vitess just normal MySQL DDL will do. You have a couple other options as well either to use `ApplySchema` or directly apply the index to MySQL. | |
Unique index is a MySQL feature. As such it can be applied like any other DDL using an ALTER statement. |
|
||
You can read more about how to make a CreateLookupVindex [here](https://vitess.io/docs/user-guides/configuration-advanced/createlookupvindex/). If you are unfamiliar with Vindexes we recommend that you first read the information [here](https://vitess.io/docs/reference/features/vindexes). | ||
|
||
MARKED NOT HELPFUL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: Move CreateLookupVindex content into the first question. Write a proper answer to "What is a lookup vindex?" and put it before the CreateLookupVindex question.
weight: 7 | ||
--- | ||
|
||
## What is semi-sync replication? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should move this under vttablet, it doesn't belong under VReplication.
|
||
* MySQL and Percona | ||
* Vitess supports the core features of MySQL versions 5.6 to 8.0, with some limitations. | ||
* Vitess also supports Percona Server for MySQL versions 5.6 to 8.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Vitess also supports Percona Server for MySQL versions 5.6 to 8.0. | |
* Vitess also supports Percona Server for MySQL versions 5.7 to 8.0. |
* Vitess also supports Percona Server for MySQL versions 5.6 to 8.0. | ||
|
||
{{< info >}} | ||
Please do note that with MySQL 5.6 reaching end of life in February 2021, it is recommended to deploy MySQL 5.7 and later. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please do note that with MySQL 5.6 reaching end of life in February 2021, it is recommended to deploy MySQL 5.7 and later. | |
Please do note that with MySQL 5.7 reaching end of life in October 2023, it is recommended to deploy MySQL 8.0. |
* Vitess supports the core features of MariaDB versions 10.0 to 10.3. | ||
* Vitess does not yet support version 10.4 of MariaDB. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Vitess supports the core features of MariaDB versions 10.0 to 10.3. | |
* Vitess does not yet support version 10.4 of MariaDB. | |
* In the past, Vitess has supported MariaDB versions 10.0 to 10.3. | |
* Vitess does not currently support running MariaDB as the backing database. However, importing data from existing MariaDB instances into MySQL-backed Vitess clusters is supported. |
Vitess can run on-premise or in the cloud. It can be run on bare metal, VMs, kubernetes, or as managed service provided by PlanetScale. | ||
|
||
RDS is only available as a managed service from AWS. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unlike RDS, Vitess is horizontally scalable through sharding. Hence, it is not limited by individual server hardware capacity. There is no need to provision ever-larger expensive machines for scaling, instead it can run on a fleet of cheap commodity hardware.
|
||
On the other hand, Vitess is a database clustering system to be used for scaling MySQL. It is a database solution for deploying, scaling and managing large clusters of MySQL instances. | ||
|
||
In other words, Vitess runs on top of MySQL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In other words, Vitess runs on top of MySQL. | |
In other words, Vitess runs on top of MySQL and can provide scalability and availability that you cannot get with a single MySQL server. |
Working to move the FAQs from Freshdesk to vitess.io
Fixes #1273