Skip to content

Commit 37ffcef

Browse files
author
Vivek Vishal
authored
Merge branch 'master' into open-source-banner
2 parents 00ef5fc + d2cbbd1 commit 37ffcef

957 files changed

Lines changed: 218183 additions & 2878 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Makefile
1616
README.md
1717
package.json
1818
package-lock.json
19-
19+
static/

‎.github/workflows/kanvas.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ jobs:
3737
path: action
3838
repository: layer5labs/kanvas-snapshot
3939
- id: test_result
40-
uses: layer5labs/Kanvas-Snapshot@v0.2.32
40+
uses: layer5labs/Kanvas-Snapshot@v0.2.33
4141
with:
4242
githubToken: ${{ secrets.GITHUB_TOKEN }} # github's personal access token example: "ghp_...."
4343
mesheryToken: ${{ secrets.MESHERY_TOKEN }} # Meshery Cloud Authentication token, signin to meshery-cloud to get one, example: ey.....
4444
prNumber: ${{ env.PULL_NO }} # auto-filled from the above step
4545
application_type: Kubernetes Manifest # your application type, could be any of three: "Kubernetes Manifest", "Docker Compose", "Helm Chart"
46-
filePath: ${{ inputs.fileName == '' && 'https://meshery.github.io/meshery.io/charts/meshery-v0.8.50.tgz' || inputs.fileName }} # relative file-path from the root directory in the github-runner env, you might require to checkout the repository as described in step 2
46+
filePath: ${{ inputs.fileName == '' && 'install/deployment_yamls/k8s' || inputs.fileName }} # relative file-path from the root directory in the github-runner env, you might require to checkout the repository as described in step 2

‎content-learn/mastering-kubernetes-for-engineers/ambassador-edge-stack-api-gateway-with-meshery/edge/conclusion.mdx‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
docType: "Chapter"
3+
id: "conclusion"
4+
chapterTitle: "Conclusion"
5+
description: "Concluding this tutorial, you will gain a comprehensive understanding of how to configure, deploy, and manage the Ambassador Edge Stack with Meshery."
6+
videos: 0
7+
lectures: 4
8+
order: 4
9+
---
10+
import { ChapterStyle } from "../../../../src/components/Learn-Components/Chapters-Style/chapters.style.js";
11+
12+
<ChapterStyle>
13+
14+
In this tutorial, you explored the Ambassador Edge Stack (AES) system using Meshery Playground. By leveraging **Kanvas**, you were able to clearly visualize resource relationships, providing a view of the functionalities and roles within the AES system. You should now have a solid understanding of how to configure, deploy, and manage the Ambassador Edge Stack with Meshery.
15+
16+
Here's a recap of the lessons learned in this course:
17+
18+
1. The Ambassador Edge Stack (AES) system can be explored using Meshery Playground.
19+
2. Kanvas provides a clear visualization of resource relationships in the AES system.
20+
3. Configuring, deploying, and managing the Ambassador Edge Stack with Meshery is now well understood.
21+
22+
By following this tutorial, you have gained a comprehensive understanding of the Ambassador Edge Stack and its integration with Meshery. Congratulations on completing the course!
23+
24+
</ChapterStyle>
25+

‎content-learn/mastering-kubernetes-for-engineers/ambassador-edge-stack-api-gateway-with-meshery/edge/design-interpretation.mdx‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
docType: "Chapter"
3+
id: "design-interpretation"
4+
chapterTitle: "Interpreting the Edge Stack Meshery Design"
5+
description: "This chapter explores the relationships between different components in the Ambassador Edge Stack (AES) system using a Kanvas design. It covers the roles and communication ports of each component, as well as the service account roles and relationships within the AES system."
6+
videos: 0
7+
lectures: 4
8+
order: 3
9+
---
10+
import * as React from "react";
11+
import MesheryDesignEmbed from "@layer5/meshery-design-embed";
12+
import { ChapterStyle } from "../../../../src/components/Learn-Components/Chapters-Style/chapters.style.js";
13+
import es8 from "../../../../src/assets/images/learning-path/edge-stack/es8.png";
14+
import es9 from "../../../../src/assets/images/learning-path/edge-stack/es9.png";
15+
16+
<ChapterStyle>
17+
18+
<h2 class="chapter-sub-heading">
19+
Exploring the Relationships Between Edge Stack Resources with a Kanvas Design
20+
</h2>
21+
22+
<h3 class="chapter-sub-heading">Services and Deployments</h3>
23+
24+
The design below shows the traffic flow between some major components in the the Ambassador Edge Stack (AES) system.
25+
26+
27+
<a href={es8}>
28+
<img src={es8} width="100%" align="center" />
29+
</a>
30+
31+
The components include ;
32+
33+
2. edge-stack-agent Deployment
34+
3. edge-stack Deployment
35+
4. edge-stack-admin Service and
36+
5. edge-stack Service
37+
38+
Let's take a look at the roles of each component and the ports used for communication.
39+
40+
1. **edge-stack Service**:This serves as the primary entry point for incoming traffic. It listens on ports 80 and 443, handling HTTP and HTTPS traffic respectively. This component routes the incoming requests to the appropriate internal services within the AES system.
41+
42+
2. **edge-stack-agent**: This is responsible for specific tasks within the AES system. It receives traffic from the edge-stack service on port 80/TCP. The agent handles various operational tasks, including diagnostics and reporting to the Ambassador Cloud.
43+
44+
3. **edge-stack-admin Service**: This Service provides administrative functions and health checks for the AES system. It communicates with the edge-stack component on port 8877/TCP for administrative purposes.
45+
46+
4. **edge-stack Deployment**:The edge-stack Deployment component is a core part of the Ambassador Edge Stack, handling the main processing and routing of traffic. It receives traffic from the edge-stack service on port 80/TCP and communicates with the edge-stack-admin component on port 8877/TCP for administrative tasks.
47+
48+
<h3 class="chapter-sub-heading">Service Account Roles</h3>
49+
50+
<a href={es9}>
51+
<img src={es9} width="100%" align="center" />
52+
</a>
53+
54+
The diagram above shows one of the role assignments and service account relationships within
55+
the Ambassador Edge Stack (AES) system. You can see that the Service Account (edge-stack) is
56+
linked to both the ClusterRole (edge-stack) and the Role (edge-stack-apiext) through ClusterRoleBinding
57+
and RoleBinding.
58+
59+
With the help of Kanvas, these connections become clear and easy to understand.
60+
61+
<main>
62+
<MesheryDesignEmbed
63+
style={{ border: "1px solid #eee" }}
64+
embedId="embedded-design-7b01cebf-b0f9-4c11-87e7-612d8fad10c8"
65+
embedScriptSrc="/embed-test/embedded-design-deployment-service.js"
66+
/>
67+
</main>
68+
</ChapterStyle>

‎content-learn/mastering-kubernetes-for-engineers/ambassador-edge-stack-api-gateway-with-meshery/edge/edge-stack-configuration.mdx‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
docType: "Chapter"
3+
id: "edge-stack-configuration"
4+
chapterTitle: "Edge Stack Configuration"
5+
description: "This chapter covers the configuration of the Edge Stack, including importing and deploying Edge Stack Custom Resource Definitions (CRDs) and YAML files. You will learn how to configure the necessary Ambassador Cloud license and set up essential components like Listener and Mapping resources. Finally, you will deploy a sample Quote service application to route traffic through Edge Stack."
6+
videos: 0
7+
lectures: 4
8+
order: 2
9+
---
10+
import { ChapterStyle } from "../../../../src/components/Learn-Components/Chapters-Style/chapters.style.js";
11+
import MesheryDesignEmbed from "@layer5/meshery-design-embed";
12+
import es1 from "../../../../src/assets/images/learning-path/edge-stack/es1.png";
13+
import es2 from "../../../../src/assets/images/learning-path/edge-stack/es2.png";
14+
import es3 from "../../../../src/assets/images/learning-path/edge-stack/es3.png";
15+
import es4 from "../../../../src/assets/images/learning-path/edge-stack/es4.png";
16+
import es5 from "../../../../src/assets/images/learning-path/edge-stack/es5.png";
17+
import es6 from "../../../../src/assets/images/learning-path/edge-stack/es6.png";
18+
import es10 from "../../../../src/assets/images/learning-path/edge-stack/es10.png";
19+
20+
<ChapterStyle>
21+
22+
In this chapter, you will import and deploy Edge Stack Custom Resource Definitions (CRDs) and YAML files. You'll learn how to configure the necessary Ambassador Cloud license and set up essential components like Listener and Mapping resources. Finally, you'll deploy a sample Quote service application to route traffic through Edge Stack.
23+
24+
<h2 class="chapter-sub-heading">Steps</h2>
25+
26+
<h3 class="chapter-sub-heading">Import Edge Stack CRD YAML and Deploy</h3>
27+
28+
The Edge Stack CRD YAML file typically contains the definitions for custom resources used by Edge Stack. These definitions include the schemas and validation rules for resources like Mappings, Hosts, TLSContexts, RateLimits, Filters, and more. These custom resources allow you to define and manage the various aspects of your API gateway configuration, such as routing, authentication, rate limiting, and TLS settings, directly within your Kubernetes cluster.
29+
30+
1. In the left sidebar, click on the upward arrow symbol (import icon) to import the file into Meshery.
31+
32+
2. In the modal that appears:
33+
- Enter a name for your design in the **Design File Name** field (e.g. _Edge-stack-crd_).
34+
- Select _Kubernetes Manifest_ from the **Design Type** dropdown menu.
35+
- Choose **Url upload** for the upload method, and paste in the [Edge-Stack-crd](https://app.getambassador.io/yaml/edge-stack/3.11.0/aes-crds.yaml) YAML link.
36+
- Then, click on **Import**.
37+
38+
<a href={es1}>
39+
<img src={es1} width="100%" align="center" />
40+
</a>
41+
42+
3. Click on the name of the design on the Designs tab to display the visual representations of the various Kubernetes resources and their relationships on the canvas.
43+
44+
4. Click **Actions** in the top right corner and click on Deploy (double tick).
45+
46+
5. To check the status of your deployment, click on the notification icon on the top right corner.
47+
48+
<a href={es2}>
49+
<img src={es2} width="100%" align="center" />
50+
</a>
51+
52+
6. Click on **Open In visualizer** to navigate to the Visualize section and see a pre-filtered view of the deployed resources in the cluster.
53+
54+
<a href={es3}>
55+
<img src={es3} width="100%" align="center" />
56+
</a>
57+
58+
<h3 class="chapter-sub-heading">Import the Edge Stack YAML </h3>
59+
60+
Now that the CRDs have been deployed, go ahead to deploy the main Edge Stack Configuration.
61+
62+
1. Follow the previous Steps to Import the [Edge Stack YAML](https://app.getambassador.io/yaml/edge-stack/3.11.0/aes.yaml) into Kanvas with the name _Edge-Stack_.
63+
64+
<a href={es4}>
65+
<img src={es4} width="100%" align="center" />
66+
</a>
67+
68+
2. You can use the **Group Components** icon on the dock below to group resources based on shared labels or annotations.
69+
70+
<a href={es5}>
71+
<img src={es5} width="100%" align="center" />
72+
</a>
73+
74+
<h3 class="chapter-sub-heading">Configure Edge Stack License</h3>
75+
76+
Ambassador Edge Stack requires a valid license to operate. Generate your [license token](https://app.getambassador.io/cloud/edge-stack/license/new) to establish a secure connection between Edge Stack and Ambassador Cloud.
77+
78+
1. Complete the steps on the Ambassador Cloud to generate your license token, then copy the token. Be sure to convert it into **base64** format. You can use an online tool for this conversion.
79+
80+
2. Click on the Secret component on the design canvas and input the token.
81+
82+
<a href={es6}>
83+
<img src={es6} width="100%" align="center" />
84+
</a>
85+
86+
<h3 class="chapter-sub-heading">Deploy Edge Stack </h3>
87+
88+
1. Click **Actions** in the top right corner and click on Deploy (double tick).
89+
90+
2. Click on **Open In visualizer** to navigate to the Visualize section and see a pre-filtered view of the deployed resources in the cluster.
91+
92+
<a href={es10}>
93+
<img src={es10} width="100%" align="center" />
94+
</a>
95+
96+
<h3 class="chapter-sub-heading">Listener Custom Resource</h3>
97+
98+
The Listener Custom Resource tells Ambassador Edge Stack what port to listen on.
99+
100+
1. Copy the following the YAML and save it to a file called _listener.yaml_ , then import it into Kanvas.
101+
102+
```YAML
103+
---
104+
apiVersion: getambassador.io/v3alpha1
105+
kind: Listener
106+
metadata:
107+
name: edge-stack-listener-8080
108+
namespace: ambassador
109+
spec:
110+
port: 8080
111+
protocol: HTTP
112+
securityModel: XFP
113+
hostBinding:
114+
namespace:
115+
from: ALL
116+
---
117+
apiVersion: getambassador.io/v3alpha1
118+
kind: Listener
119+
metadata:
120+
name: edge-stack-listener-8443
121+
namespace: ambassador
122+
spec:
123+
port: 8443
124+
protocol: HTTPS
125+
securityModel: XFP
126+
hostBinding:
127+
namespace:
128+
from: ALL
129+
EOF
130+
131+
```
132+
133+
2. Deploy the resource on Kanvas.
134+
135+
<h3 class="chapter-sub-heading">Mapping Resource</h3>
136+
137+
Create a Mapping configuration that instructs Edge Stack on how and where to route traffic. In the YAML file below, any request coming to the specified _hostname_ with the _prefix_ /backend/ will be directed to the _quote service_.
138+
139+
Copy the following the YAML and save it to a file called _mapping.yaml_ , then import it into Kanvas.
140+
141+
```YAML
142+
apiVersion: getambassador.io/v3alpha1
143+
kind: Mapping
144+
metadata:
145+
name: quote-backend
146+
spec:
147+
hostname: "*"
148+
prefix: /backend/
149+
service: quote
150+
docs:
151+
path: "/.ambassador-internal/openapi-docs"
152+
153+
```
154+
155+
<h3 class="chapter-sub-heading">Deploy Quote Service</h3>
156+
157+
Next, import the [Quote Service YAML](https://app.getambassador.io/yaml/v2-docs/3.9.1/quickstart/qotm.yaml) and deploy it on Kanvas. This step will create the necessary deployment and service resources for the Quote service within your Kubernetes cluster, allowing you to see how Edge Stack manages and routes traffic to this backend service.
158+
159+
<MesheryDesignEmbed
160+
embedId="embedded-design-d429e684-c42a-4c14-816b-b4dddb4b6d40"
161+
embedScriptSrc="/embed-test/embedded-design-edge-stack.js"
162+
/>
163+
164+
</ChapterStyle>

‎content-learn/mastering-kubernetes-for-engineers/ambassador-edge-stack-api-gateway-with-meshery/edge/introduction.mdx‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
docType: "Chapter"
3+
id: "introduction"
4+
chapterTitle: "Introduction"
5+
description: "Ambassador Edge Stack is a powerful API gateway built on Envoy Proxy. It simplifies the configuration, deployment, and management of APIs in Kubernetes environments. With features like automatic TLS, authentication, rate limiting, load balancing, and observability, Ambassador Edge Stack ensures scalability and flexibility for high traffic volumes and distributed requests across multiple services in your cluster."
6+
videos: 0
7+
lectures: 4
8+
order: 1
9+
---
10+
import * as React from "react";
11+
import MesheryDesignEmbed from "@layer5/meshery-design-embed";
12+
import { ChapterStyle } from "../../../../src/components/Learn-Components/Chapters-Style/chapters.style.js";
13+
14+
<ChapterStyle>
15+
16+
<h2 class="chapter-sub-heading">Overview</h2>
17+
18+
In this tutorial, you will explore Edge Stack using Meshery Playground. You'll get hands-on experience importing YAML files that contain Edge Stack configurations and Custom Resource Definitions (CRDs).
19+
20+
You'll use Kanvas to view, configure, and deploy Kubernetes resources, including Edge Stack with its custom resources and a sample application. Additionally, you'll leverage Meshery's visualization tool to filter the deployed resources in your cluster.
21+
22+
<h2 class="chapter-sub-heading">Objectives</h2>
23+
24+
This tutorial will guide you through exploring Edge Stack using Meshery Playground. You'll cover:
25+
26+
1. **Importing YAML Files**: Learn how to import YAML files containing Edge Stack configurations and CRDs (Custom Resource Definitions) into Kanvas.
27+
2. **Design Configuration**: Configure a Kubernetes component on the Playground Canvas.
28+
3. **Deployment**: Deploy Edge Stack alongside a sample application and custom resources.
29+
4. **Visualization**: Get hands-on with Kanvas to understand the components and their interactions within Edge Stack.
30+
5. **Design Interpretation**: Explore some of the relationships between Edge Stack resources with a Kanvas design, explaining their functionalities and roles within the system.
31+
32+
<h2 class="chapter-sub-heading">Meshery Playground and Kanvas</h2>
33+
34+
**Meshery Playground** is an interactive and collaborative live cluster environment that simplifies
35+
the deployment process and enhances user experience by providing visual tools for managing
36+
Kubernetes resources.
37+
38+
[**Kanvas**](https://docs.layer5.io/kanvas/) is a visual tool within Meshery that allows users to interact with and manage Kubernetes resources. It provides a graphical interface for viewing, configuring, and deploying resources, making it easier to understand the relationships and interactions between different components in a Kubernetes cluster.
39+
40+
If this is your first time working with Meshery Playground, consider starting with the [Exploring Kubernetes Pods with Meshery Playground](https://docs.meshery.io/guides/tutorials/kubernetes-pods) tutorial first.
41+
42+
<h2 class="chapter-sub-heading">Ambassador Edge Stack</h2>
43+
44+
Ambassador [Edge Stack](https://www.getambassador.io/products/edge-stack/api-gateway) is a Kubernetes-native API Gateway built on [Envoy Proxy](https://www.envoyproxy.io/). It streamlines Kubernetes workflows for configuration, deployment, and management of APIs, efficiently snd securely managing high traffic volumes and distributing requests across multiple services in your cluster.
45+
46+
The "stack" includes security functionalities such as automatic TLS, authentication, and rate limiting, as well as load balancing, ingress control and observability all integrated to ensure scalability and flexibility in Kubernetes environments.
47+
48+
<h2 class="chapter-sub-heading">Prerequisites</h2>
49+
50+
- Basic understanding of Kubernetes concepts.
51+
- Access to the _Meshery Playground_. If you don't have an account, sign up at [Meshery Playground](https://play.meshery.io/).
52+
- [Ambassador Cloud](https://www.getambassador.io/solutions/ambassador-cloud) account.
53+
54+
<h2 class="chapter-sub-heading">Access Meshery Playground</h2>
55+
56+
1. Log in to the [Meshery Playground](https://meshery.layer5.io/) using your credentials.
57+
2. Click **Explore** in the Cloud Native Playground tile to navigate to _Kanvas_.
58+
59+
<main>
60+
<MesheryDesignEmbed
61+
style={{ border: "1px solid #eee" }}
62+
embedId="embedded-design-d429e684-c42a-4c14-816b-b4dddb4b6d40"
63+
embedScriptSrc="/embed-test/embedded-design-edge-stack.js"
64+
/>
65+
</main>
66+
</ChapterStyle>

‎content-learn/mastering-kubernetes-for-engineers/ambassador-edge-stack-api-gateway-with-meshery/index.mdx‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
docType: "Course"
3+
title: "Course"
4+
description: "This course will guide you through the process of deploying and visualizing Edge Stack components with Meshery. You will learn how to install and configure the Ambassador API Gateway and explore its integration with Meshery. Additionally, you will gain hands-on experience with two popular service meshes, Istio and Linkerd. By the end of this course, you will have a solid understanding of Edge Stack deployment and be able to leverage Meshery for managing your API gateway and service mesh configurations."
5+
videos: 0
6+
lectures: 4
7+
courseTitle: "Ambassador Edge Stack API Gateway with Meshery"
8+
themeColor: "#00B39F"
9+
order: 1
10+
cardImage: '../../../src/assets/images/kubernetes/kubernetes-white.svg'
11+
meshesYouLearn:
12+
[
13+
{
14+
imagepath: "../../../src/assets/images/service-mesh-icons/istio.svg",
15+
name: "Istio",
16+
},
17+
{
18+
imagepath: "../../../src/collections/integrations/ambassador/icons/color/ambassador-color.svg",
19+
name: "edge",
20+
},
21+
{
22+
imagepath: "../../../src/assets/images/service-mesh-icons/linkerd.svg",
23+
name: "Linkerd",
24+
},
25+
]
26+
toc:
27+
[
28+
"introduction",
29+
"edge-stack-configuration",
30+
"design-interpretation",
31+
"conclusion"
32+
]
33+
---

0 commit comments

Comments
 (0)