Skip to content

Commit 7855ea1

Browse files
committed
docs: make cloud overview more descriptive
Improves cloud overview, concepts, identity, getting-started, and security pages with descriptive content replacing placeholder boilerplate. - overview: adds What is Layer5 Cloud, Why use it, Next Steps sections - concepts: adds Core Entities, Understanding Relationships table - getting-started: adds Prerequisites, Installation and Setup, Core Workflow - identity: adds descriptive content for Organizations, Teams, Users - security: adds IAM model, Roles/RBAC, Key Management, Tokens sections Preserves master's Five narrative callout in getting-started. Resolves conflict from PR #910. Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
1 parent d14e4dc commit 7855ea1

5 files changed

Lines changed: 135 additions & 48 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,39 @@
11
---
22
title: Concepts
33
weight: 2
4+
draft: false
45
description: >
56
An overview of Layer5 Cloud concepts and their relationships.
67
---
78

9+
The Layer5 Cloud provides a comprehensive suite of management tools for cloud-native infrastructure. Understanding the core entities and how they interact is essential for effectively managing your service meshes, clusters, and designs.
10+
11+
## Core Entities
12+
13+
The following concepts form the foundation of the Layer5 Cloud ecosystem:
14+
15+
* **Workspaces:** Logical isolation boundaries for organizing team members, environments, and resources.
16+
* **Environments:** Specific deployment targets (e.g., Development, Staging, Production) within a Workspace.
17+
* **Designs:** Visual representations of your infrastructure patterns and service mesh configurations.
18+
* **Catalogs:** Repositories of reusable patterns and best practices shared across the community or organization.
19+
820
![concepts-overview](images/concepts-overview.svg "image-center-shadow")
921

1022
This section explains the underlying concepts of Layer5 Cloud — the building blocks that the rest of the documentation assumes you understand.
1123

1224
- [Meshery Server Registration](meshery-server-registration) — How a Meshery Server registers itself with Layer5 Cloud as its Remote Provider, how Cloud identifies an existing registration, and what fields are preserved across re-registration.
25+
26+
---
27+
28+
### Understanding Relationships
29+
30+
To get the most out of Layer5 Cloud, it is important to understand how these components interact:
31+
32+
| Concept | Relationship | Purpose |
33+
| :--- | :--- | :--- |
34+
| **User to Workspace** | Many-to-Many | Users can collaborate across multiple isolated workspaces. |
35+
| **Workspace to Environment** | One-to-Many | A single workspace can host multiple environments for lifecycle management. |
36+
| **Design to Catalog** | Many-to-One | Designs can be published to a catalog for broader consumption and version control. |
37+
38+
### Next Steps
39+
For a deeper dive into the technical implementation of these concepts, please refer to our [Architecture Documentation](/docs/architecture).

content/en/cloud/getting-started/_index.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,49 @@
22
title: Getting Started
33
description: Learn how to effectively manage your organizations, teams, users, workspaces, environments, and more.
44
weight: 1
5+
draft: false
56
---
6-
<!-- {{% pageinfo %}}
7-
Page under construction.
8-
{{% /pageinfo %}} -->
9-
<!-- Information in this section helps your user try your project themselves.
107

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.
129

13-
* Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.
10+
## Prerequisites
1411

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.
1616

17-
## Prerequisites
17+
## Installation and Setup
18+
19+
Layer5 Cloud functions as a Remote Provider for Meshery. To get started:
1820

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.).
2024

21-
## Installation
25+
![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow")
2226

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
2428

25-
## Setup
29+
Once authenticated, you can begin organizing your infrastructure using the following hierarchy:
2630

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).
2834

2935
## Try it out!
3036

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+
3248
{{< alert type="info" title="Follow Along with Five" >}}
3349
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" >}})
3450
{{< /alert >}}
35-
36-
![layer5-cloud-provider](images/layer5-cloud-provider.svg "image-center-shadow")

content/en/cloud/identity/_index.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,23 @@ description: >
44
Organizations, Teams, Users
55
weight: 3
66
categories: [Identity]
7-
---
7+
---
8+
9+
Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. The identity structure is highly flexible: organizations can have any number of teams, teams can have any number of users, and users can belong to any number of teams and organizations.
10+
11+
Below is an overview of the core identity components within the Layer5 Cloud.
12+
13+
## [Organizations](organizations)
14+
Organizations serve as the fundamental component of multi-tenancy within the Layer5 Cloud.
15+
16+
They act as the top-level parent entity. All users and teams ultimately roll up to an organization. While Free plan users are limited to a single default organization, enterprise environments can leverage organizations to strictly isolate resources, billing, and access control across entirely different business units.
17+
18+
## [Teams](teams)
19+
Outside of grouping users together, teams offer controlled access to workspaces and to workspace resources such as environments and managed and unmanaged connections.
20+
21+
Administrators can create teams as child units below the top-level organization. This allows you to apply unique settings, permissions, and workspace access to a specific set of users without altering the parent organization's settings.
22+
23+
## [Users](users)
24+
Each user account represents an individual collaborator. Individual user accounts exist beyond the bounds of organizations.
25+
26+
Anyone who uses Layer5 Cloud signs into a user account, which acts as your sovereign identity. Your user account can independently own resources such as workspaces, designs, connections, and tokens. Any action taken on the platform—such as creating a design or reviewing a deployment request—is directly attributed to your individual user account, regardless of which teams or organizations you belong to.
Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,27 @@
11
---
22
title: Overview
3-
description: Here's where your user finds out if your project is for them.
4-
weight: 2
5-
categories: [Examples, Placeholders]
6-
tags: [test, docs]
7-
draft: true
3+
description: Learn how Layer5 Cloud centralizes management, visualization, and collaboration for your multi-cloud infrastructure.
4+
weight: 1
5+
categories: [Reference, Cloud]
6+
tags: [Cloud, Architecture, Governance]
7+
draft: false
88
---
9-
<!--
9+
1010
{{% pageinfo %}}
11-
Page under construction.
11+
Layer5 Cloud is the control plane for your cloud-native infrastructure, providing deep insights and collaborative management across all your clusters.
1212
{{% /pageinfo %}}
1313

14+
## What is Layer5 Cloud?
1415

15-
The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or put your overview contents in the Documentation landing page (like in the Docsy User Guide).
16-
17-
Try answering these questions for your user in this page:
18-
19-
## What is it?
20-
21-
Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want.
22-
23-
## Why do I want it?
24-
25-
Help your user know if your project will help them. Useful information can include:
26-
27-
* **What is it good for?**: What types of problems does your project solve? What are the benefits of using it?
28-
29-
* **What is it not good for?**: For example, point out situations that might intuitively seem suited for your project, but aren't for some reason. Also mention known limitations, scaling issues, or anything else that might let your users know if the project is not for them.
16+
Layer5 Cloud serves as the centralized management console and identity provider for the Layer5 ecosystem, specifically for **Kanvas** and **Meshery** deployments. It provides an extensible authorization framework that allows organizations to manage complex infrastructure with confidence.
3017

31-
* **What is it *not yet* good for?**: Highlight any useful features that are coming soon.
18+
## Why use Layer5 Cloud?
3219

33-
## Where should I go next?
20+
* **Collaborative Design**: Similar to Google Workspace or Figma, multiple team members can design and review infrastructure patterns in real-time.
21+
* **Unified Identity**: Manage organizations, teams, and users with granular Role-Based Access Control (RBAC).
22+
* **Content Catalog**: Host and share cloud-native patterns publicly or keep them private within your organization.
3423

35-
Give your users next steps from the Overview. For example:
24+
## Next Steps
3625

37-
* [Getting Started](/docs/getting-started/): Get started with $project
38-
* [Examples](/docs/examples/): Check out some example code!
39-
-->
26+
* [**Identity**](/cloud/identity): Learn about Organizations, Teams, and Users.
27+
* [**Security**](/cloud/security): Understand tokens, keychains, and permissions.
Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,49 @@
11
---
22
title: Security
3-
description: Tokens, Keychains, Keys, Roles
3+
description: Manage identity and access through Tokens, Keychains, Keys, and RBAC Roles.
44
weight: 4
5+
draft: false
56
categories: [Security]
6-
tags: [permissions]
7+
tags: [permissions, identity, authentication]
78
---
9+
Layer5 Cloud provides a multi-tenant security model designed to manage access across complex organizational structures. This section covers the core components of our Identity and Access Management (IAM) system.
810

11+
## Security Architecture
912

10-
![permission](/cloud/security/images/permissions.svg "image-center-shadow")
13+
The following diagram illustrates the relationship between Organizational Units, Roles, and the underlying Permissions:
14+
15+
![permission](/cloud/security/images/permissions.svg "image-center-shadow")
16+
17+
---
18+
19+
## Organizational Units
20+
Layer5 Cloud uses a hierarchical structure to isolate resources and manage users at scale:
21+
* **Provider Organizations:** The top-level entity that can manage multiple tenant organizations.
22+
* **Tenant Organizations:** Individual customer or project-specific organizations (e.g., Layer5, Intel).
23+
* **Teams:** Logical groupings of users within an organization to facilitate collaborative management.
24+
* **Users:** Individual accounts that are members of teams and organizations.
25+
26+
## Roles and Access Control
27+
Access is granted through Role-Based Access Control (RBAC). Roles are assigned at different levels of the organizational hierarchy:
28+
* **Organization Administrators:** Full control over an entire tenant organization.
29+
* **Organization Billing Managers:** Access restricted to subscription and financial management.
30+
* **Team Administrators:** Management of specific team resources and memberships.
31+
32+
## Key Management and Tokens
33+
Beyond structural roles, Layer5 Cloud uses cryptographic and session-based security:
34+
35+
### Keychains
36+
Keychains are collections of keys used to manage environment-specific access and signing. They allow for the logical grouping of related security credentials.
37+
38+
### Keys
39+
Keys are the atomic unit of access control within the system. They are used for secure communication between Meshery and Layer5 Cloud, as well as for signing design patterns.
40+
41+
### Tokens
42+
Tokens provide temporary, secure access to the platform.
43+
* **Session Tokens:** Used for web browser authentication.
44+
* **Personal Access Tokens (PATs):** Used for programmatic access via CLI or CI/CD pipelines.
45+
46+
---
47+
48+
### Need more detail?
49+
Check out the [Roles Reference](/docs/security/roles) for a complete matrix of permissions for each role.

0 commit comments

Comments
 (0)