-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Touriist <[email protected]>
- Loading branch information
Showing
8 changed files
with
1,431 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
type: "learning-path" | ||
title: "Mastering Meshery" | ||
description: "Learn all about Meshery" | ||
order: 1 | ||
themeColor: "#00D3A9" | ||
cardImage: "../../src/assets/images/learning-path/meshery-logo-light.webp" | ||
courses: 1 | ||
technologyList: ["all"] | ||
prominentStyling: true | ||
--- | ||
|
||
<!-- | ||
This file is only used to render the courses list within a learning path. | ||
Check the Learn-Layer5 folder under src/sections/, src/templates for more understanding of how the data is used | ||
--> |
24 changes: 24 additions & 0 deletions
24
content-learn/mastering-meshery/introduction-to-meshery/index.mdx
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,24 @@ | ||
--- | ||
docType: "Course" | ||
title: "Course" | ||
description: "Explore Meshery comprehensively in this introductory course. Cover foundational concepts, architectural components, and logical structures. Learn how to create, deploy, and interpret designs. Gain practical insights into configuring Meshery through workspaces and leverage its collaborative attributes to manage your infrastructure." | ||
videos: 0 | ||
lectures: 3 | ||
courseTitle: "Introduction to Meshery" | ||
themeColor: "#00B39F" | ||
order: 1 | ||
cardImage: "../../../src/assets/images/service-mesh-icons/linkerd-white.svg" | ||
toc: | ||
[ | ||
"meshery-concepts", | ||
"deploying-meshery-designs", | ||
"configuring-meshery", | ||
"creating-designs", | ||
"interpreting-meshery-designs", | ||
"reviewing-designs" | ||
] | ||
--- | ||
|
||
|
||
Introduction to Meshery | ||
|
227 changes: 227 additions & 0 deletions
227
...learn/mastering-meshery/introduction-to-meshery/meshery/configuring-meshery.mdx
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,227 @@ | ||
--- | ||
docType: "Chapter" | ||
id: "configuring-meshery" | ||
chapterTitle: "Configuring Meshery" | ||
description: "This chapter covers the steps for configuring meshery, including the process of creating teams, workspaces, environments, and connections. It also explains how they associate with each other." | ||
videos: 0 | ||
lectures: 4 | ||
order: 1 | ||
--- | ||
import { ChapterStyle } from "../../../../src/components/Learn-Components/Chapters-Style/chapters.style.js"; | ||
|
||
import lifecycleImage from "../../../../src/assets/images/learning-path/meshery-configure/lifecycle.png"; | ||
import createTeamImage from "../../../../src/assets/images/learning-path/meshery-configure/create-team.png"; | ||
import createWorkspaceImage from "../../../../src/assets/images/learning-path/meshery-configure/create-workspace.png"; | ||
import confirmWorkspaceImage from "../../../../src/assets/images/learning-path/meshery-configure/confirm-workspace.png"; | ||
import createEnvironmentImage from "../../../../src/assets/images/learning-path/meshery-configure/create-environment.png"; | ||
import confirmEnvironmentImage from "../../../../src/assets/images/learning-path/meshery-configure/confirm-environment.png"; | ||
import envArrowImage from "../../../../src/assets/images/learning-path/meshery-configure/env-arrow.png"; | ||
import envConnectImage from "../../../../src/assets/images/learning-path/meshery-configure/env-connect.png"; | ||
import mesheryEnvImage from "../../../../src/assets/images/learning-path/meshery-configure/meshery-env.png"; | ||
import addClusterImage from "../../../../src/assets/images/learning-path/meshery-configure/add-cluster.png"; | ||
import uploadKubeconfigImage from "../../../../src/assets/images/learning-path/meshery-configure/upload-kubeconfig.png"; | ||
import invalidKubeconfigImage from "../../../../src/assets/images/learning-path/meshery-configure/invalid-kubeconfig.png"; | ||
import connectionListImage from "../../../../src/assets/images/learning-path/meshery-configure/connection-list.png"; | ||
import environmentsDesignsImage from "../../../../src/assets/images/learning-path/meshery-configure/environments-designs.png"; | ||
import associateWithWorkspaceImage from "../../../../src/assets/images/learning-path/meshery-configure/associate-with-workspace.png"; | ||
import confirmAssociatedWorkspaceImage from "../../../../src/assets/images/learning-path/meshery-configure/confirm-associated-workspace.png"; | ||
|
||
|
||
<ChapterStyle> | ||
|
||
<h2 class="chapter-sub-heading">Introduction</h2> | ||
|
||
Configuring Meshery is foundational to effectively managing and deploying your infrastructure. By understanding what `Teams`, `Workspaces`,`Connections` and `Environments` are and how to set them up, you can effectively manage and monitor your cloud-native infrastructure, as well as collaborate with your team by sharing and organizing your resources. | ||
|
||
**Prerequisite** | ||
|
||
1. Access to Meshery ([Self-Hosted](https://docs.meshery.io/installation) or [Meshery Playground](https://docs.meshery.io/installation/playground)). | ||
|
||
To start configuring Meshery: | ||
|
||
1. Navigate to the left sidebar of Meshery. | ||
1. Click on the **Lifecycle** dropdown and you will see all the menu items we need in this chapter. | ||
|
||
<a href={lifecycleImage}> | ||
<img src={lifecycleImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h2 class="chapter-sub-heading">Creating Teams</h2> | ||
|
||
Creating a [Team](https://docs.layer5.io/cloud/identity/teams/) is the first step in configuring Meshery. In Meshery, a team is a user group that manages and shares access to resources such as Workspaces, Designs, and Environments. Teams enable efficient collaboration and permission management, facilitating organized operations within an organization. Teams offer control access to workspaces and to workspace resources such as Environments and Connections. | ||
|
||
Follow the steps below to create a team: | ||
|
||
1. Teams are visible when you visit the [**Identity**](https://meshery.layer5.io/identity/teams) page in Layer5 Cloud. | ||
1. Select **Add Team**, enter a name for your team, add Team Members, and **Create Team**. | ||
|
||
<a href={createTeamImage}> | ||
<img src={createTeamImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h2 class="chapter-sub-heading">Creating Workspaces</h2> | ||
|
||
Creating a [Workspace](https://docs.layer5.io/cloud/spaces/workspaces/) is an important step in configuring Meshery. A workspace in Meshery is a logical grouping of resources that helps organize and manage your infrastructure more effectively. It is used to separate different projects or environments within your team, enabling better collaboration and resource management. Every user is assigned a default workspace, which can be customized as needed. | ||
|
||
To create a workspace: | ||
|
||
1. Navigate to **Workspaces** under the **Lifecycle** dropdown. | ||
|
||
1. Click **Create**. | ||
|
||
1. Enter a name for your workspace and **Save**. | ||
|
||
<a href={createWorkspaceImage}> | ||
<img src={createWorkspaceImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. Once saved, the new Workspace will be created and displayed on the screen. | ||
|
||
<a href={confirmWorkspaceImage}> | ||
<img src={confirmWorkspaceImage} width="100%" align="center" /> | ||
</a> | ||
|
||
In the subsequent sections, we will discuss `Environments` and `Designs` shown in the image above. | ||
|
||
<h2 class="chapter-sub-heading">Creating Environments and Associating Connections</h2> | ||
|
||
[Environments](https://docs.layer5.io/cloud/spaces/environments/) and [Connections](https://docs.meshery.io/concepts/logical/connections) are essential for efficient resource management in Workspaces. Environments logically group related Connections and Credentials, simplifying management and sharing. Connections within Environments become immediately available for use in any assigned Workspaces. | ||
|
||
<h3 class="chapter-sub-heading">Creating an Environment</h3> | ||
|
||
To create an environment: | ||
|
||
1. Navigate to **Environments** under the **Lifecycle** dropdown. | ||
|
||
1. Click **Create**. | ||
|
||
1. Enter the name of the environment and **Save**. | ||
|
||
<a href={createEnvironmentImage}> | ||
<img src={createEnvironmentImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. Once saved, the new Environment will be created and displayed on the screen. | ||
|
||
<a href={confirmEnvironmentImage}> | ||
<img src={confirmEnvironmentImage} width="100%" align="center" /> | ||
</a> | ||
|
||
Next We’ll learn how to assign Connections to Environments. | ||
|
||
<h3 class="chapter-sub-heading">Associating Connections with an Environment</h3> | ||
|
||
Examples of connections managed by Meshery include GitHub integrations, Prometheus connections, Kubernetes clusters, and more. It's essential to assign these connections to an environment and link that environment to your selected workspace. | ||
|
||
To add a connection to an environment: | ||
|
||
1. Click on the **arrows** icon, and a modal displaying your available connections will appear. | ||
|
||
<a href={envArrowImage}> | ||
<img src={envArrowImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. **Available Connections** shows a list of Kubernetes clusters that are currently managed by Meshery. | ||
|
||
1. Select the connection(s) you want to assign. | ||
|
||
1. Use the appropriate arrow icons to manage your selections: | ||
* The first arrow assigns all connections. | ||
* The second arrow assigns only the selected connections. | ||
* The third arrow removes the selected connection. | ||
* The fourth arrow removes all connections. | ||
|
||
1. Click **Save** to confirm your changes. | ||
|
||
<a href={envConnectImage}> | ||
<img src={envConnectImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. The Connections have now been assigned to the Environment. | ||
|
||
<a href={mesheryEnvImage}> | ||
<img src={mesheryEnvImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h3 class="chapter-sub-heading">Navigating the Connections Page</h3> | ||
|
||
The `Connections` page serves as a central hub for managing the clusters you are connected to. This page provides valuable information and functionality to help you understand and interact with all your connections. | ||
|
||
To access the Connections page, click on **Connections** under the **Lifecycle** dropdown. | ||
|
||
<h4 class="chapter-sub-heading">Adding Cluster Connection</h4> | ||
|
||
On the Connections page, you can easily add a Kubernetes cluster connection. To do this: | ||
|
||
1. Click the **Add Cluster** button to get started. | ||
|
||
<a href={addClusterImage}> | ||
<img src={addClusterImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. When the modal appears,navigate to the location of your kubeconfig file and upload it to add your cluster as a connection. | ||
|
||
<a href={uploadKubeconfigImage}> | ||
<img src={uploadKubeconfigImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. After uploading the kubeconfig file, the modal should indicate that your cluster has been successfully added as a connection. | ||
|
||
If you uploaded an invalid kubeconfig file, you might see an error message statement like the one below. Please ensure you are uploading the correct file with the proper configuration and try again. | ||
|
||
<a href={invalidKubeconfigImage}> | ||
<img src={invalidKubeconfigImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h4 class="chapter-sub-heading">Viewing Cluster Connection Details</h4> | ||
|
||
Each connection has key details associated with it such as: | ||
|
||
1. **Environment**: This displays the environments associated with the connection. Click on the drop-down to add your connection to your Environment and see which Environments the connection is linked to. | ||
2. **Status**: Indicates the currently assigned state and information about what state the connection may or may not transition to. You can learn about [Connection Status](https://docs.meshery.io/concepts/logical/connections#states-and-the-lifecycle-of-connections) | ||
3. If [MeshSync](https://docs.meshery.io/concepts/architecture/meshsync) is actively running in your cluster, clicking the "Flush MeshSync" button will update MeshSync with the latest data, ensuring it matches the current state of your cluster. | ||
This ensures that MeshSync’s data is refreshed and accurately reflects the current state of your cluster’s infrastructure and resources. | ||
|
||
<a href={connectionListImage}> | ||
<img src={connectionListImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h2 class="chapter-sub-heading">Integrating Workspaces with Environments and Designs</h2> | ||
|
||
You can assign your created Environments to Workspaces, enabling effective collaboration and resource utilization across your team. This feature allows you to organize your Environments based on specific projects, teams, or use cases, making it easier to manage and share resources within your organization. | ||
|
||
Integrating designs with Workspaces enables effective collaboration and sharing of infrastructure configurations across your team. When you assign an Environment containing your designs to a Workspace, team members with access to that Workspace can view, manage, and build upon the shared designs and share feedback. | ||
|
||
<h3 class="chapter-sub-heading">Assigning Environments and Designs to Workspaces</h3> | ||
|
||
1. Navigate to **Workspaces** under **Lifecycle**. | ||
|
||
1. In the image below, there are two **arrows** for associating `Environments` and `Designs` to Workspaces, respectively. | ||
|
||
<a href={environmentsDesignsImage}> | ||
<img src={environmentsDesignsImage} width="100%" align="center" /> | ||
</a> | ||
|
||
1. Click the appropriate arrow to assign the selected Environments(or Designs) and **Save**. | ||
|
||
<a href={associateWithWorkspaceImage}> | ||
<img src={associateWithWorkspaceImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h4 class="chapter-sub-heading">Confirm Workspace Association</h4> | ||
|
||
Now, the environment and design are associated with the workspace. You get standardized resource deployment and cross-team collaboration. This enables efficient resource management and tracking, and makes team members more productive. | ||
|
||
<a href={confirmAssociatedWorkspaceImage}> | ||
<img src={confirmAssociatedWorkspaceImage} width="100%" align="center" /> | ||
</a> | ||
|
||
<h2 class>Conclusion</h2> | ||
|
||
In this chapter, you learned how to effectively configure Meshery, laying the groundwork for managing your infrastructure and optimizing workload within Kubernetes environments. Starting with the creation of workspaces, you established collaborative environments where teams can organize and deploy resources efficiently. | ||
|
||
You explored the setup of environments, which serve as logical groupings for managing Kubernetes connections and other resources. By adding cluster connections and associating them with environments, you ensured seamless integration and management of your infrastructure components. | ||
|
||
Throughout the configuration process, you encountered various steps to integrate workspaces with environments and designs. This integration not only streamlined resource management but also facilitated standardized deployments across Kubernetes clusters associated with your workspace. | ||
|
||
</ChapterStyle> |
Oops, something went wrong.