forked from meshery/meshery
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into aabidsofi/k8s-swi…
…tcher Signed-off-by: Pranav Singh <pranavsingh02@hotmail.com>
- Loading branch information
Showing
33 changed files
with
1,178 additions
and
625 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 30 additions & 30 deletions
60
docs/pages/concepts/architecture/broker.md → docs/pages/concepts/architectural/broker.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,30 @@ | ||
| --- | ||
| layout: default | ||
| title: Broker | ||
| permalink: concepts/architecture/broker | ||
| type: concepts | ||
| redirect_from: architecture/broker | ||
| abstract: "Meshery broker component facilitates data streaming between kubernetes cluster components and outside world." | ||
| language: en | ||
| list: include | ||
| --- | ||
|
|
||
| Broker is a custom Kubernetes controller that provides data streaming across independent components of Meshery whether those components are running inside or outside of the Kubernetes cluster. | ||
|
|
||
| ### Broker FAQs | ||
|
|
||
| #### How many Brokers can run? | ||
| It is recommended to run one broker instance for each kubernetes cluster, However the instance itself can be scaled up based on the incoming data volume in each of the cluster. The scaling is independent of the number of instances running. | ||
|
|
||
| #### What does an HA configuration look like? | ||
| We leverage on the kubernetes functionality in terms of the High-Availability behaviour. Meaning, the broker instance gets instantiated/restarted on its own when an issue occurs. In part, Meshery-Operator is also responsible for keeping the broker functional. | ||
|
|
||
| #### What stateful characteristics does the Broker have? | ||
| All the messages that are published to the broker is persisted in-memory within the broker instance until it get consumed. Persistent-volume/Disk-space is not currently being used by the Broker. | ||
|
|
||
| #### How do I know if the Broker is working? How do I troubleshoot the Broker? | ||
| The Broker instance is deployed inside the kubernetes cluster as a `Statefulset`. In the case where the broker doesn't seem to work, here are a few steps to troubleshoot the instance: | ||
|
|
||
| - Make sure the pods corresponding to the `Statefulset` is up and running. | ||
| - Make sure the kubernetes cluster has support for kubernetes `Service` type `LoadBalancer` or `NodePort`. | ||
| - Ensure connectivity between the Meshery-Server and the Broker service endpoint. | ||
| --- | ||
| layout: default | ||
| title: Broker | ||
| permalink: concepts/architecture/broker | ||
| type: components | ||
| redirect_from: architecture/broker | ||
| abstract: "Meshery broker component facilitates data streaming between kubernetes cluster components and outside world." | ||
| language: en | ||
| list: include | ||
| --- | ||
|
|
||
| Broker is a custom Kubernetes controller that provides data streaming across independent components of Meshery whether those components are running inside or outside of the Kubernetes cluster. | ||
|
|
||
| ### Broker FAQs | ||
|
|
||
| #### How many Brokers can run? | ||
| It is recommended to run one broker instance for each kubernetes cluster, However the instance itself can be scaled up based on the incoming data volume in each of the cluster. The scaling is independent of the number of instances running. | ||
|
|
||
| #### What does an HA configuration look like? | ||
| We leverage on the kubernetes functionality in terms of the High-Availability behaviour. Meaning, the broker instance gets instantiated/restarted on its own when an issue occurs. In part, Meshery-Operator is also responsible for keeping the broker functional. | ||
|
|
||
| #### What stateful characteristics does the Broker have? | ||
| All the messages that are published to the broker is persisted in-memory within the broker instance until it get consumed. Persistent-volume/Disk-space is not currently being used by the Broker. | ||
|
|
||
| #### How do I know if the Broker is working? How do I troubleshoot the Broker? | ||
| The Broker instance is deployed inside the kubernetes cluster as a `Statefulset`. In the case where the broker doesn't seem to work, here are a few steps to troubleshoot the instance: | ||
|
|
||
| - Make sure the pods corresponding to the `Statefulset` is up and running. | ||
| - Make sure the kubernetes cluster has support for kubernetes `Service` type `LoadBalancer` or `NodePort`. | ||
| - Ensure connectivity between the Meshery-Server and the Broker service endpoint. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| layout: default | ||
| title: Designs | ||
| permalink: concepts/designs | ||
| type: concepts | ||
| abstract: "Meshery Designs are descriptive, declarative characterizations of how your Kubernetes infrastructure should be configured." | ||
| language: en | ||
| list: include | ||
| --- | ||
|
|
||
|
|
||
| ## Designs | ||
| Like a Google Doc, Designs are your primary tool for collaborative authorship of your infrastructure and services. | ||
|
|
||
| ### Using Designs | ||
|
|
||
|
|
||
| ### Design Relationships and Restrictions | ||
| - Access to Designs may be granted to one or more users. | ||
|
|
||
| ### Controlling Access to Designs | ||
| When creating a new design by default it's visibility level will be set to __public__ unless you are an active Lara, five subscriber, in which case you can change this default to __private__. | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| layout: default | ||
| title: Environments | ||
| permalink: concepts/environments | ||
| type: concepts | ||
| abstract: "Meshery offers support for Kubernetes cluster and cloud state synchronization with the help of MeshSync." | ||
| language: en | ||
| list: include | ||
| --- | ||
|
|
||
|
|
||
| ## Environments | ||
|
|
||
| Environments represent a collection of resources in the form of Connections - both of managed and unmanaged Connections. Environment resources are comprised of Connections (and implicitly those Connections' Credentials), which can be assigned and unassigned by Workspace Managers. | ||
|
|
||
| ### Environment Relationships and Restrictions | ||
|
|
||
| - Environments can be assigned to zero or more Workspaces. | ||
| - Connections can be assigned to zero or more Environments. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| layout: default | ||
| title: Concepts | ||
| permalink: concepts/logical | ||
| language: en | ||
| list: exclude | ||
| --- | ||
|
|
||
| Concepts for understanding Meshery's various features and components. | ||
|
|
||
| {% assign sorted_pages = site.pages | sort: "name" %} | ||
|
|
||
| <h2>Logical Concepts</h2> | ||
| <ul> | ||
| {% for item in sorted_pages %} | ||
| {% if item.type=="concepts" and item.language=="en" -%} | ||
| <li><a href="{{ site.baseurl }}{{ item.url }}">{{ item.title }}</a> | ||
| {% if item.abstract != " " %} | ||
| - {{ item.abstract }} | ||
| {% endif %} | ||
| </li> | ||
| {% endif %} | ||
| {% endfor %} | ||
| </ul> | ||
|
|
||
| []({{site.baseurl}}/assets/img/architecture/meshery_extension_points.svg) | ||
|
|
||
| _Figure: Extension points available throughout Meshery_ |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| layout: default | ||
| title: Workspaces | ||
| permalink: concepts/workspaces | ||
| type: concepts | ||
| abstract: "Meshery Workspaces act as central collaboration points for teams and their project work." | ||
| language: en | ||
| list: include | ||
| --- | ||
|
|
||
| ## Workspaces | ||
|
|
||
| Workspaces act as central collaboration points for teams and their project work. Often, users create a Workspace for each project or for each team as a way of organizing domains of project work to facilitate collaboration and provide access control over resources with a project. Workspaces are sometimes likened to the concept of a project - a collection of individuals responsible for the development and operation of an application or service. | ||
|
|
||
| ### Using Workspaces | ||
| After creating a Workspace, of your next steps is to resource that Workspace. Like a shared drive (or or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs. | ||
|
|
||
|
|
||
| ### Workspace Relationships and Restrictions | ||
| - Access to Workspaces may be granted to one or more teams. | ||
| - As a point of collaboration to facilitate work, Workspaces may have zero or more Environments associated. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import React from "react"; | ||
| import { makeStyles } from "@material-ui/core/styles"; | ||
|
|
||
|
|
||
| const useStyles = makeStyles((theme) => ({ | ||
| icon : { | ||
| fill : theme.palette.secondary.iconMain | ||
| }, | ||
| })); | ||
| const ColumnIcon = (props) => { | ||
| const classes = useStyles(); | ||
| return ( | ||
| <svg | ||
| className={classes.icon} | ||
| xmlns="http://www.w3.org/2000/svg" | ||
| height="24" | ||
| viewBox="0 -960 960 960" | ||
| width="24" | ||
| fill={props.fill} | ||
| > | ||
| <path d="M120-200v-560h213v560H120Zm253 0v-560h213v560H373Zm253 0v-560h213v560H626Z" /> | ||
| </svg> | ||
| ); | ||
| }; | ||
|
|
||
| export default ColumnIcon; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import { makeStyles } from "@material-ui/core/styles"; | ||
|
|
||
| const useStyles = makeStyles((theme) => ({ | ||
| toolWrapper : { | ||
| marginBottom : "3rem", | ||
| display : "flex", | ||
| justifyContent : "space-between", | ||
| backgroundColor : theme.palette.type === 'dark' ? theme.palette.secondary.toolbarBg2 : theme.palette.secondary.toolbarBg1, | ||
| boxShadow : " 0px 2px 4px -1px rgba(0,0,0,0.2)", | ||
| height : "4rem", | ||
| padding : "0.68rem", | ||
| borderRadius : "0.5rem", | ||
| position : "relative", | ||
| zIndex : "1", | ||
| }, | ||
| // Define other styles as needed | ||
| })); | ||
|
|
||
| export default useStyles; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.