Skip to content

Commit 7dcb471

Browse files
SyedAsad108SyedAsad108
authored andcommitted
docs: define security hierarchy and RBAC roles
Signed-off-by: SyedAsad108 <ID+username@users.noreply.github.com>
1 parent a6d3944 commit 7dcb471

File tree

9 files changed

+2476
-1017
lines changed

9 files changed

+2476
-1017
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2022 The Hugo Authors.
189+
Copyright 2020 Layer5, Inc.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 215 additions & 206 deletions
Large diffs are not rendered by default.
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
55
categories: [Security]
6-
tags: [permissions]
6+
tags: [permissions, identity, authentication]
77
---
88

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

10-
![permission](/cloud/security/images/permissions.svg "image-center-shadow")
11+
## Security Architecture
12+
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.

go.mod

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ module github.com/layer5io/docs
33
go 1.23
44

55
require (
6-
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect
7-
github.com/google/docsy v0.11.0 // indirect
6+
github.com/google/docsy v0.12.0 // indirect
87
github.com/google/docsy/dependencies v0.7.2 // indirect
9-
github.com/twbs/bootstrap v5.3.8+incompatible // indirect
108
)

go.sum

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2-
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
3-
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w=
42
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
5-
github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM=
6-
github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI=
3+
github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4=
4+
github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM=
75
github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI=
86
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
97
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
10-
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
11-
github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o=
12-
github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
8+
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
-22 MB
Binary file not shown.
-18.6 MB
Binary file not shown.

0 commit comments

Comments
 (0)