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

adding in freshdesk faqs #1430

Open
wants to merge 13 commits into
base: prod
Choose a base branch
from
Open

adding in freshdesk faqs #1430

wants to merge 13 commits into from

Conversation

hallaroo
Copy link
Member

@hallaroo hallaroo commented Mar 31, 2023

Working to move the FAQs from Freshdesk to vitess.io

Fixes #1273

@netlify
Copy link

netlify bot commented Mar 31, 2023

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 1a26623
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/64a1d2fa61785600086015bb
😎 Deploy Preview https://deploy-preview-1430--vitess.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@deepthi
Copy link
Member

deepthi commented Apr 12, 2023

Thank you so much for doing this! Can you..

  • first, fix the DCO
  • do another commit removing all the .DS_Store files?

git commit -s will add the sign-off properly.

@hallaroo
Copy link
Member Author

hallaroo commented Apr 13, 2023

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>
@hallaroo
Copy link
Member Author

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.
Copy link
Member Author

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).
Copy link
Member Author

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>
@deepthi
Copy link
Member

deepthi commented Jul 2, 2023

@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.
Copy link
Member

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).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Member

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?
Copy link
Member

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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* 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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.

Comment on lines +28 to +29
* Vitess supports the core features of MariaDB versions 10.0 to 10.3.
* Vitess does not yet support version 10.4 of MariaDB.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* 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.

Copy link
Member

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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Review] PS Vitess Support
2 participants