|
2 | 2 | title: Getting Started |
3 | 3 | description: Learn how to effectively manage your organizations, teams, users, workspaces, environments, and more. |
4 | 4 | weight: 1 |
| 5 | +draft: false |
5 | 6 | --- |
6 | | -<!-- {{% pageinfo %}} |
7 | | -Page under construction. |
8 | | -{{% /pageinfo %}} --> |
9 | | -<!-- Information in this section helps your user try your project themselves. |
10 | 7 |
|
11 | | -* What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements. |
| 8 | +The Layer5 Cloud provides a centralized management plane for your cloud-native infrastructure. This guide will help you set up your account and deploy your first design. |
12 | 9 |
|
13 | | -* Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section. |
| 10 | +## Prerequisites |
14 | 11 |
|
15 | | -Consider using the headings below for your getting started page. You can delete any that are not applicable to your project. |
| 12 | +Before you begin, ensure you have the following: |
| 13 | +* A [Layer5 Cloud account](https://cloud.layer5.io). |
| 14 | +* A running Kubernetes cluster (local or cloud-based). |
| 15 | +* [Meshery](https://docs.meshery.io/installation) installed and connected to your cluster. |
16 | 16 |
|
17 | | -## Prerequisites |
| 17 | +## Installation and Setup |
| 18 | + |
| 19 | +Layer5 Cloud functions as a Remote Provider for Meshery. To get started: |
18 | 20 |
|
19 | | -Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed? |
| 21 | +1. **Log in:** Navigate to your Meshery UI (usually `http://localhost:9081`). |
| 22 | +2. **Select Provider:** On the login screen, select **Layer5 Cloud** from the provider dropdown. |
| 23 | +3. **Authenticate:** You will be redirected to the Layer5 Cloud authentication page. Log in with your preferred identity provider (GitHub, Google, etc.). |
20 | 24 |
|
21 | | -## Installation |
| 25 | + |
22 | 26 |
|
23 | | -Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them? |
| 27 | +## Core Workflow |
24 | 28 |
|
25 | | -## Setup |
| 29 | +Once authenticated, you can begin organizing your infrastructure using the following hierarchy: |
26 | 30 |
|
27 | | -Is there any initial setup users need to do after installation to try your project? |
| 31 | +* **Organizations:** Create an Organization to manage your teams and billing. |
| 32 | +* **Workspaces:** Group your projects and resources logically. |
| 33 | +* **Environments:** Map your Kubernetes clusters to specific environments (e.g., Staging, Production). |
28 | 34 |
|
29 | 35 | ## Try it out! |
30 | 36 |
|
31 | | -Can your users test their installation, for example by running a command or deploying a Hello World example? --> |
| 37 | +To verify your setup, try deploying a sample design: |
| 38 | + |
| 39 | +1. Navigate to the **Designs** section in the sidebar. |
| 40 | +2. Click on **Import** and select a sample pattern from the Meshery Catalog. |
| 41 | +3. Click **Deploy** and select your target Environment. |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +### Need Help? |
| 46 | +If you run into issues during setup, join our [Slack Community](http://slack.layer5.io) or check the [Troubleshooting Guide](/docs/troubleshooting). |
| 47 | + |
32 | 48 | {{< alert type="info" title="Follow Along with Five" >}} |
33 | 49 | Throughout these docs you'll follow Five — a Platform Engineer at Orbital Labs — and his colleagues as they set up organizations, configure workspaces, deploy designs, and navigate the occasional Friday-afternoon incident. [Meet Five and the full cast →]({{< relref "/cloud/about/_index.md" >}}) |
34 | 50 | {{< /alert >}} |
35 | | - |
36 | | - |
|
0 commit comments