|
1 | 1 | --- |
2 | 2 | title: Get Started |
3 | | -description: Deploy Vitess on your favorite platform |
| 3 | +description: Quick Setup - Install, configure, and try Vitess |
4 | 4 | weight: 2 |
5 | 5 | aliases: ['/docs/tutorials/'] |
6 | 6 | --- |
7 | 7 |
|
8 | | -Vitess supports binary deployment on the following platforms. See also [Build On CentOS](../../contributing/build-on-centos), [Build on MacOS](../../contributing/build-on-macos), or [Build on Ubuntu](../../contributing/build-on-ubuntu) if you are interesting in building your own binary, or contributing to Vitess. |
| 8 | +Vitess is a database clustering system for MySQL. It provides horizontal scaling, resilience, and query routing while preserving MySQL semantics. See: [Overview](../overview/whatisvitess) |
| 9 | + |
| 10 | +This page outlines a beginner friendly quick guide to **evaluate** Vitess. It describes how to install a small test environment. So you can explore Vitess’s core features and get comfortable with its architecture or start building against it. |
| 11 | + |
| 12 | +## Who this is for |
| 13 | + |
| 14 | +* **Evaluators** who want a low‑effort try‑out system. |
| 15 | +* **Administrators** who prefer to learn the basics before planning a production install. |
| 16 | +* **Developers** who need a disposable test environment to build against. |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +## Install for testing |
| 21 | + |
| 22 | +Pick one of the lightweight test options: |
| 23 | + |
| 24 | +* **Local Install (Linux)** — precompiled binaries and local example scripts |
| 25 | + [./local/](./local/) |
| 26 | +* **Local Install via source for macOS** — build from source, then run the local examples |
| 27 | + [./local-mac/](./local-mac/) |
| 28 | +* **Vttestserver Docker Image** — single‑container test instance (fastest path & **recommended**) |
| 29 | + [./vttestserver-docker-image/](./vttestserver-docker-image/) |
| 30 | + |
| 31 | +**Advanced (closer to production):** If you want to exercise more components or practice ops tasks, use the **Vitess Operator for Kubernetes** in a local or dev cluster. It’s more involved and mirrors production patterns. |
| 32 | +[./operator/](./operator/) |
| 33 | + |
| 34 | +> We recommend that to read the overview Docs first like Architecture Overview to understand the components you are installing: [../overview/architecture/](../overview/architecture/) |
| 35 | +
|
| 36 | +### Schema & VSchema (use the demo) |
| 37 | + |
| 38 | +To explore schemas and VSchema quickly, use the **VSchema demo**. It runs a single‑process **vtcombo** instance that behaves like a full cluster for learning. |
| 39 | + |
| 40 | +* **Run the demo**, see: [../user-guides/vschema-guide/overview/#demo](../user-guides/vschema-guide/overview/#demo) |
| 41 | + |
| 42 | + * `go run demo.go` |
| 43 | + * Open **[http://localhost:8000](http://localhost:8000)** to view tables, run queries, and see effects. |
| 44 | + * Or connect with a MySQL client: `mysql -h 127.0.0.1 -P 12348`. |
| 45 | + * The demo focuses on VSchema concepts similar to Getting Started, but with more detail. |
| 46 | + See: *VSchema Overview → Demo*. |
| 47 | + |
| 48 | +* **Iterate on the schema** |
| 49 | + |
| 50 | + * Start with the demo’s baseline schema/VSchema. |
| 51 | + * Empty the files under `schema/product` and `schema/customer`, then add definitions step by step to mirror the guide’s examples. |
| 52 | + * Use VSchema DDL where applicable, or apply JSON directly if you prefer. (Knowing the JSON format helps with troubleshooting.) |
| 53 | + |
| 54 | +> Tip: The demo is great for trying sharded vs. unsharded keyspaces and understanding how VTGate routes queries based on VSchema. |
| 55 | +
|
| 56 | +### Alternative: your chosen test setup |
| 57 | + |
| 58 | +If you used **Local Install**, **Local (macOS source)**, or **vttestserver**, apply your schema and VSchema in that environment and connect your app through **VTGate** using your normal MySQL driver. |
| 59 | + |
| 60 | +Use the examples provided in the respective test guide to apply schema and VSchema. |
| 61 | + |
| 62 | +## Test |
| 63 | + |
| 64 | +* Connect to **VTGate** and run simple reads/writes to verify connectivity. |
| 65 | +* In the **VSchema demo**, use the web UI at `http://localhost:8000` to inspect tables and issue queries; observe how VSchema affects routing. |
| 66 | +* (Optional) Try safe demo operations in a test setup (e.g., MoveTables, tiny reshard, planned failover) only if your chosen guide includes them. |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +## Next steps: Move to production |
| 71 | + |
| 72 | +The Docker test image is for evaluation only. When you’re ready to take the next step, use these task‑oriented guides to plan and operate a production cluster: |
| 73 | + |
| 74 | +* **Planning** — capacity, topology, cells, and prerequisites |
| 75 | + [../user-guides/configuration-basic/planning/](../user-guides/configuration-basic/planning/) |
| 76 | +* **Backups & restores** — choose storage, configure backup flags, and test restores |
| 77 | + [../user-guides/configuration-basic/backups-restores/](../user-guides/configuration-basic/backups-restores/) |
| 78 | +* **Monitoring** — metrics, dashboards, and health checks for Vitess components |
| 79 | + [../user-guides/configuration-basic/monitoring/](../user-guides/configuration-basic/monitoring/) |
| 80 | +* **Troubleshooting** — common issues and diagnostic steps |
| 81 | + [../user-guides/configuration-basic/troubleshooting/](../user-guides/configuration-basic/troubleshooting/) |
| 82 | +* **Migrating data (if needed)** — options for bringing existing MySQL data into Vitess (dump/restore vs. online VReplication) |
| 83 | + [../user-guides/migration/migrate-data/](../user-guides/migration/migrate-data/) |
0 commit comments