Skip to content

Commit

Permalink
[Docs] Planning
Browse files Browse the repository at this point in the history
Signed-off-by: Lee Calcote <[email protected]>
  • Loading branch information
leecalcote committed Jun 5, 2024
1 parent 4fed1e3 commit 2ed92fd
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 36 deletions.
37 changes: 2 additions & 35 deletions content/en/cloud/self-hosted/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,8 @@ description: >

## On-premises Deployment of Layer5 Cloud

Layer5 Cloud is a collection of services that can be deployed on-premises. The following diagram illustrates the architecture of Layer5 Cloud.
Layer5 Cloud is a collection of services that can be deployed on-premises.

![self-hosted-deployment](images/self-hosted-deployment.svg "image-center-no-shadow")

## Considerations of Self-Hosted Deployments

### White-labeling (Rebranding)

Customize the appearance and branding of your engineering platform powered by Layer5 Cloud. You can change the logo, color scheme, domain name, and other aspects of the user interface to match your own identity and preferences. White-labeling enables you to offer a seamless and consistent experience to your customers, partners, or internal users who access your service mesh platform. White-labeling also helps you to differentiate your platform from other Layer5 Cloud users and competitors, and to enhance your brand recognition and loyalty.

### Considerations of Peer-to-Peer Communication

Layer5 Cloud offers central coordination for real-time user presence and its multi-player experience and does so by propagating document (e.g. designs, views, and so on) updates peer-to-peer to all users using WebRTC. This allows for real-time collaboration without the need for a central server. The signaling server is only used to establish the initial connection between peers. The signaling server does not have access to the content of the document.

Characteristics of the peer-to-peer communication include:

- Fast message propagation
-Encryption and authorization over untrusted signaling servers
- No setup required, public signaling servers are available
- Very little server load
- Not suited for a large amount of collaborators on a single document (each peer is connected to each other)

![meshmap-collaboration-networking](images/meshmap-collaboration-networking.svg "image-center-no-shadow")

#### Default Configuration

By default, Layer5 Cloud uses the public signaling server provided by Layer5. This server is hosted by Layer5 and is available to all users. The server is not able to see the content of the documents, but it can see the metadata of the documents (title, list of users, etc.).

##### Default Number of Supported Users

Minimum: 20
Maximum: 34

Layer5 Cloud uses a min and max range for the total number of users in multi-player mode in one document at-a-time in order to prevent users forming clusters (groups), that can't connect to other users. The min and max range is randomly selected for each document editing session.

### Considerations of Air-Gapped Deployments

Meshery acknowledges the importance of air-gapped deployments and ensures content support for such environments. Content registered should be available even in the absence of internet connectivity, thus aligning with Meshery's commitment to versatile deployment scenarios.
## Considerations of Self-Hosted Deployments
2 changes: 1 addition & 1 deletion content/en/cloud/self-hosted/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Deploying Layer5 Cloud
description: "Layer5 Cloud is a collection of services that can be deployed on-premises using Helm."
categories: [Self-Hosted]
tags: [helm]
weight: 1
weight: 2
---

## High-level List of Deployment Tasks
Expand Down
11 changes: 11 additions & 0 deletions content/en/cloud/self-hosted/planning/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Planning Layer5 Cloud Deployment
description: "Understand deployment prerequisites and prepare your environment for a secure and scalable Layer5 Cloud deployment."
categories: [Self-Hosted]
#tags: [helm]
weight: 1
---

### Considerations of Air-Gapped Deployments

Layer5 acknowledges the importance of air-gapped deployments and ensures content support for such environments. Content registered should be available even in the absence of internet connectivity, thus aligning with Layer5's commitment to versatile deployment scenarios.
10 changes: 10 additions & 0 deletions content/en/cloud/self-hosted/planning/identity-services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Identity Services
description: "Understand identity services prerequisites and how to integrate your existing identity with OIDC."
categories: [Self-Hosted]
tags: [identity]
weight: 3
---
The following diagram illustrates the architecture of Layer5 Cloud.

![self-hosted-deployment](../images/self-hosted-deployment.svg "image-center-no-shadow")
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Networking
description: "Prepare and configure network services for your Layer5 Cloud deployment."
categories: [Self-Hosted]
tags: [identity]
weight: 2
---
## Considerations of Peer-to-Peer Communication

Layer5 Cloud offers central coordination for real-time user presence and its multi-player experience and does so by propagating document (e.g. designs, views, and so on) updates peer-to-peer to all users using WebRTC. This allows for real-time collaboration without the need for a central server. The signaling server is only used to establish the initial connection between peers. The signaling server does not have access to the content of the document.

Characteristics of the peer-to-peer communication include:

- Fast message propagation
-Encryption and authorization over untrusted signaling servers
- No setup required, public signaling servers are available
- Very little server load
- Not suited for a large amount of collaborators on a single document (each peer is connected to each other)

![meshmap-collaboration-networking](../images/meshmap-collaboration-networking.svg "image-center-no-shadow")

### Default Configuration

By default, Layer5 Cloud uses the public signaling server provided by Layer5. This server is hosted by Layer5 and is available to all users. The server is not able to see the content of the documents, but it can see the metadata of the documents (title, list of users, etc.).

#### Default Number of Supported Users

Minimum: 20
Maximum: 34

Layer5 Cloud uses a min and max range for the total number of users in multi-player mode in one document at-a-time in order to prevent users forming clusters (groups), that can't connect to other users. The min and max range is randomly selected for each document editing session.

0 comments on commit 2ed92fd

Please sign in to comment.