Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated instructions and image of adapters #56

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Meshery-Adapters/kuma-meshery-adapter/assets/install-kuma.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Meshery-Adapters/kuma-meshery-adapter/assets/kuma-adapter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions Meshery-Adapters/kuma-meshery-adapter/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@
"hideHiddenFiles": true,
"exclusionPatterns": ["*test", "./test/*", "./logs"],
"showdashboard": true,
"dashboards": [{"name": "Meshery Server", "port": 9081}],
"dashboards": [{"name": "Meshery UI", "port": 9081},{"name": "Image Hub", "port": 8080}],
"uilayout": "terminal-iframe"
},

"backend": {
"imageid": "kubernetes-cluster-running:1.18"
"imageid": "kubernetes-cluster-running:1.22"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we took this image from the katacoda library, are you sure this works?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was suggested by @piyushsingariya. And it is the only line of code I saw that mentioned the version of Kubernetes. So I guess it should work 🤞

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be out of date, but here it is - https://www.katacoda.community/essentials/environments.html

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the docs only mention about 1.18 version. What should we do? The other adapters will work fine but OSM requires kubernetes >=1.19.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we disable OSM lab for some time until we figure some solution out and keep the other labs running with the Kubernetes version 1.18?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leecalcote @warunicorn19 thoughts on this approach?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I think we should remove the OSM lab for the time being, since it doesn't work and I don't see a workaround either. @leecalcote ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The trafeik-mesh adapter too. It's still not connecting after the install command.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know that the OSM installations are working in the Meshery Adapter for OSM even on later K8s versions. @Aisuko, @Revolyssup, is it?

}
}
24 changes: 15 additions & 9 deletions Meshery-Adapters/kuma-meshery-adapter/step1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,28 @@ Meshery can be downloaded, installed, and launched with a single command:

`curl -L https://git.io/meshery | ADAPTERS=kuma PLATFORM=kubernetes bash -`{{execute}}

**Congratulations!** You have successfully installed Meshery and the Meshery Adapter for Linkerd.
**Congratulations!** You have successfully installed Meshery and the Meshery Adapter for Kuma.

Meshery is now available at host:`9081`.

Find the **Meshery UI** tab is configured to be listening at `http://localhost:9081`/
><font size=2>NOTE: If you see a vim page please press `q` and `y`. Also if you see an error stating `Failed to open Meshery in browser, please point your browser to....` please ignore it. </font>

- Click on the **Meshery UI** tab
- Click on **Display Port**
To know that the Meshery has loaded with all the components connected, run

`mesheryctl system status`{{execute}}.

If all the components are in ready state you can open Mehsery UI tab with everything connected.

Find the **Meshery UI** tab which is configured to be listening at `http://localhost:9081`/

- Click on new tab icon the **Meshery UI** tab
- Click on **Display Port**

**Welcome to Meshery!**

Choose **Meshery** as your provider. Sign in to get started.

![Meshery landing page](./assets/meshery-none-provider.png)
![Meshery landing page](./assets/starting-page.png)

## Connect your cluster with Meshery

Expand All @@ -34,8 +42,6 @@ Meshery will auto-connect with your Kubernetes by loading the kubeconfig found i

1. Between Meshery and Kubernetes.

![Meshery connected with cluster](./assets/cluster-up.png)

1. Between Meshery and the Meshery Adapter for your corresponding service mesh.
2. Between Meshery and the Meshery Adapter for your corresponding service mesh.

![Meshery connected with adapter](./assets/adapter-up.png)
![Meshery connected with adapter](./assets/kuma-connected.png)
6 changes: 3 additions & 3 deletions Meshery-Adapters/kuma-meshery-adapter/step2.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Kuma can be installed on Meshery with one click!

## 1. Select `Kuma` from the Management menu
## 1. Select `Kuma` from the Lifecycle menu

![Meshery adapter for Kuma](./assets/kuma-adapter.png)

## 2. In the Kuma management page:

- Type `kuma` into the namespace field
- Click the (+) icon on the Install card and select `Latest Kuma` to install the latest version of Istio
- Click the (+) icon on the Manage Service Mesh Lifecycle card and select `Kuma Service Mesh` to install the latest version of Kuma

![Install Kuma using Meshery](./assets/install-kuma.png)

To check if Istio is along with all the pieces that have been deployed, execute the following:
To check if Kuma is along with all the pieces that have been deployed, execute the following:

`kubectl get all -n kuma-system`{{execute}}

Expand Down
21 changes: 6 additions & 15 deletions Meshery-Adapters/kuma-meshery-adapter/step3.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,12 @@ Sample Applications are deployed on top of a service mesh to help you explore an
## Deploy Image Hub on Kuma

- Navigate to the **Kuma Management** page on Meshery with `default` in the Namespace field.
- Select the `Image Hub application` in the `Sample Application` drop down menu.
- Select the `Image Hub application` in the `Manage Sample Application Life` drop down menu.

![Kuma Imagehub](./assets/kuma-sample-app.png)
![Kuma Imagehub](./assets/install image-hub.png)

You will be notified of successful deployment.

## Expose your Sample Application

A sidecar injector is used for automating the injection of the Linkerd proxy into your application's pod spec. The Kubernetes admission controller enforces this behavior by sending a webhook request to the sidecar injector every time a pod is to be scheduled.

You have already deployed the sidecar proxy injector when you installed Consul, which should be running in your control plane. To verify, execute this command:

`kubectl get deployment consul-consul-connect-injector-webhook-deployment -n consul-system`{{execute}}

**Let's verify that your deployment works. Run**:
(The *Available* column might take upto a minute to get updated)

Expand All @@ -30,9 +22,8 @@ Sample Output:

| NAME | READY | UP-TO-DATE | AVAILABLE | AGE |
|:-----------------:|:-----:|:----------:|:---------:|:---:|
| api-deployment-v1 | 1/1 | 1 | 1 | 88s |
| envoy | 1/1 | 1 | 1 | 88s |
| web-deployment | 1/1 | 1 | 1 | 88s |
| api-v1 | 1/1 | 1 | 1 | 88s |
| web-v1 | 1/1 | 1 | 1 | 88s |

### Let's inspect our pod:

Expand All @@ -50,10 +41,10 @@ If you cannot see the *Ready* column updated, this is because the deployment can

`kubectl get svc -n default`{{execute}}

`kubectl describe svc/web-service -n default`{{execute}}
`kubectl describe svc/web -n default`{{execute}}

4. Assess the application deployment by port-forwarding the web-service service:

`kubectl port-forward svc/web-service 8080 --address 0.0.0.0 -n default`{{Execute}}
`kubectl port-forward svc/web 8080 --address 0.0.0.0 -n default`{{Execute}}

The Image Hub application should now be deployed on the HTTP port: `8080`. Make your way to the `ImageHub` Server tab. For this tutorial, the server is configured to be listening at `http://localhost:8080`
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions Meshery-Adapters/linkerd-meshery-adapter/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@
"hideHiddenFiles": true,
"exclusionPatterns": ["*test", "./test/*", "./logs"],
"showdashboard": true,
"dashboards": [{"name": "Meshery UI", "port": 9081},{"name": "Emojivoto", "port": 8080}],
"dashboards": [{"name": "Meshery UI", "port": 9081},{"name": "Emojivoto", "port": 80}],
"uilayout": "terminal-iframe"
},

"backend": {
"imageid": "kubernetes-cluster-running:1.18"
"imageid": "kubernetes-cluster-running:1.22"
}
}
14 changes: 11 additions & 3 deletions Meshery-Adapters/linkerd-meshery-adapter/step1.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,26 @@ Meshery can be downloaded, installed, and launched with a single command:

Meshery is now available at host:`9081`.

><font size=2>NOTE: If you see a vim page please press `q` and `y`. Also if you see an error stating `Failed to open Meshery in browser, please point your browser to....` please ignore it. </font>

To know that the Meshery has loaded with all the components connected, run

`mesheryctl system status`{{execute}}.

If all the components are in ready state you can open Mehsery UI tab with everything connected.

## Open Meshery UI

Find the **Meshery UI** tab is configured to be listening at `http://localhost:9081`/

- Click on the **Meshery UI** tab
- Click on new tab icon the **Meshery UI** tab
- Click on **Display Port**

**Welcome to Meshery!**

Choose **Meshery** as your provider. Sign in to get started.

![Meshery landing page](./assets/meshery-none-provider.png)
![Meshery landing page](./assets/starting-page.png)

## Connect your cluster with Meshery

Expand All @@ -36,4 +44,4 @@ Meshery will auto-connect with your Kubernetes by loading the kubeconfig found i
1. Between Meshery and Kubernetes.
2. Between Meshery and the Meshery Adapter for your corresponding service mesh.

![Meshery connected with cluster](./assets/cluster-up.png)
![Meshery connected with cluster](./assets/linkerd-connected.png)
10 changes: 6 additions & 4 deletions Meshery-Adapters/linkerd-meshery-adapter/step2.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
Linkerd can be installed on Meshery with one click!

## 1. Select `Linkerd` from the Management menu
## 1. Select `Linkerd` from the Lifecycle menu

![Meshery adapter for Linkerd](./assets/linkerd-adapter.png)

## 2. In the Linkerd management page:

- Type `linkerd-system` into the namespace field
- Click the (+) icon on the Install card and select `Latest Linkerd` to install the latest version of Istio
- Type `linkerd-system` into the namespace field.
- Click the (+) icon on the Manage Service Mesh Lifecycle card and select `Linkerd Service Mesh` to install the latest version of Linkerd

![Install Linkerd using Meshery](./assets/install-linkerd.png)

You can verify the successful installation of Linkerd on your Meshery instance by running:
`kubectl get all -n linkerd-system`{{execute}}
You can continue to next step after all the components displayed on the terminal after running this command, are in ready state.

The same can be seen on your Meshery dashboard:

![Linkerd deployed](./assets/linkerd-installed.png)
![Linkerd deployed](./assets/linkerd-installed.png)

13 changes: 7 additions & 6 deletions Meshery-Adapters/linkerd-meshery-adapter/step3.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Upon successful deployment, the output should look like:

To deploy the Emojivoto application, follow these steps:

- Using Meshery, navigate to the Linkerd management page.
- Using Meshery, navigate to the Linkerd management page from the Lifecycle menu.
- Enter `default` in the Namespace field. This is the namespace in which we will be defining and deploying the Sample Application.
- Click the (+) icon on the Sample Application card and select `Emojivoto Application` from the list.
- Click the (+) icon on the Manage Sample Application Lifecycle card and select `EmojiVoto Application` from the list.

![Emojivoto sample app](./assets/linkerd-sample-app.png)

![Emojivoto deployed](./assets/emojivoto-deployed.png)
![Emojivoto deployed](./assets/emojivoto-dep.png)


**Let's verify that your deployment works. Run**:
Expand All @@ -46,12 +46,13 @@ Sample Output:
| web | 1/1 | 1 | 1 | 4m38s |

### Let's inspect our pod:
If you cannot see the *Ready* column updated, this is because the deployment can take up upto a minute. When all the deployment are in ready state, you can use `CTRL+ C` to switch back to the terminal.
asubedy marked this conversation as resolved.
Show resolved Hide resolved

1. View the details of the deployed pods:

`watch kubectl get po -n default`{{execute}}

If you cannot see the *Ready* column updated, this is because the deployment can take up upto a minute. When the deployment is complete, the page will auto-refresh. You can use `CTRL+ C` to switch back to the terminal.
Again if you cannot see the *Ready* column updated, this is because the deployment can take up upto a minute. When the deployment is complete, the page will auto-refresh. You can use `CTRL+ C` to switch back to the terminal.
asubedy marked this conversation as resolved.
Show resolved Hide resolved

2. View the details of the services:

Expand All @@ -68,11 +69,11 @@ If you cannot see the *Ready* column updated, this is because the deployment can
`kubectl port-forward svc/web-svc 80:80 --address 0.0.0.0 -n default`{{Execute}}

**Success!**
The `emojivoto` sample application has now been onboarded on to your Linkerd instance. As a final check, let's verify your data plane environment with this check:
The `emojivoto` sample application has now been onboarded on to your Linkerd instance. This may take some time. As a final check, let's verify your data plane environment with this check:

`linkerd -n emojivoto check --proxy`{{execute}}

The Emojivoto sample application should now be deployed at HTTP port:`8080`. Make your way to the `Linkerd-Emojivoto` Server tab. For this tutorial, the server is configured to be listening at `http://localhost:8080`
The Emojivoto sample application should now be deployed at HTTP port:`80`. Make your way to the `Emojivoto` Server tab. For this tutorial, the server is configured to be listening at `http://localhost:80`

**Note**: The Sample Application may take upto a minute to deploy. Please be patient

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified Meshery-Adapters/nsm-meshery-adapter/assets/install-nsm.png
Diff not rendered.
Diff not rendered.
Binary file modified Meshery-Adapters/nsm-meshery-adapter/assets/nsm-adapter.png
Binary file modified Meshery-Adapters/nsm-meshery-adapter/assets/nsm-installed.png
Diff not rendered.
4 changes: 2 additions & 2 deletions Meshery-Adapters/nsm-meshery-adapter/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@
"hideHiddenFiles": true,
"exclusionPatterns": ["*test", "./test/*", "./logs"],
"showdashboard": true,
"dashboards": [{"name": "Meshery Server", "port": 9081},{"name": "ICMP", "port": 8080}],
"dashboards": [{"name": "Meshery UI", "port": 9081},{"name": "ICMP", "port": 8080}],
"uilayout": "terminal-iframe"
},
"backend": {
"imageid": "kubernetes-cluster-running:1.18"
"imageid": "kubernetes-cluster-running:1.22"
}
}
16 changes: 12 additions & 4 deletions Meshery-Adapters/nsm-meshery-adapter/step1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,28 @@ Meshery can be downloaded, installed, and launched with a single command:

`curl -L https://git.io/meshery | ADAPTERS=nsm PLATFORM=kubernetes bash -`{{execute}}

**Congratulations!** You have successfully installed Meshery and the Meshery Adapter for Linkerd.
**Congratulations!** You have successfully installed Meshery and the Meshery Adapter for NSM.

Meshery is now available at host:`9081`.

><font size=2>NOTE: If you see a vim page please press `q` and `y`. Also if you see an error stating `Failed to open Meshery in browser, please point your browser to....` please ignore it. </font>

To know that the Meshery has loaded with all the components connected, run

`mesheryctl system status`{{execute}}.

If all the components are in ready state you can open Mehsery UI tab with everything connected.

Find the **Meshery UI** tab is configured to be listening at `http://localhost:9081`/

- Click on the **Meshery UI** tab
- Click on new tab icon the **Meshery UI** tab
- Click on **Display Port**

**Welcome to Meshery!**

Choose **Meshery** as your provider. Sign in to get started.

![Meshery landing page](./assets/meshery-none-provider.png)
![Meshery landing page](./assets/starting-page.png)

## Connect your cluster with Meshery

Expand All @@ -34,4 +42,4 @@ Meshery will auto-connect with your Kubernetes by loading the kubeconfig found i
1. Between Meshery and Kubernetes.
2. Between Meshery and the Meshery Adapter for your corresponding service mesh.

![Meshery connected with cluster](./assets/cluster-up.png)
![Meshery connected with cluster](./assets/nsm-connected.png)
6 changes: 4 additions & 2 deletions Meshery-Adapters/nsm-meshery-adapter/step2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Meshery allows you to install any service mesh with a single click:

![Meshery adapter for NSM](./assets/nsm-adapter.png)

## 2. In the Istio management page:
## 2. In the NSM management page:

- Type `nsm-system` into the namespace field
- Click the (+) icon on the Install card and select `Network Service Mesh` to install the latest version of Istio
- Click the (+) icon on the Manage Service Mesh Lifecycle card and select `NSM` to install the latest version of NSM

![Install NSM using Meshery](./assets/install-nsm.png)

Expand All @@ -16,7 +16,9 @@ Meshery allows you to install any service mesh with a single click:
NSM has been deployed in a separate Kubernetes namespace: nsm-system. To check if NSM is along with all the pieces that have been deployed, execute the following:

`kubectl get all -n nsm-system`{{execute}}
You can continue to next step after all the components displayed on the terminal after running this command, are in ready state.

The details of your configuration will also be reflected on the Meshery dashboard:


![NSM installed](./assets/nsm-installed.png)
10 changes: 5 additions & 5 deletions Meshery-Adapters/nsm-meshery-adapter/step3.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ Sample Applications are deployed on top of a service mesh to help you explore an

## Deploy ICMP Application on Kuma

- Navigate to the **NSM Management** page on Meshery with `default` in the Namespace field.
- Select the `ICMP` in the `Sample Application` drop down menu.
- Navigate to the **NSM Management** page from the Lifecycle Menu on Meshery and select `default` in the Namespace field.
- Select the `ICMP Responded` in the Manage Sample Application Lifecycle drop down menu.

![NSM Sample Apps](./assets/nsm-sample-app.png)

You will be notified of successful deployment:

![NSM ICMP](./assets/icmp-deployed.png)
![NSM ICMP](./assets/icmp-instaled.png)

## Expose your Sample Application

A sidecar injector is used for automating the injection of the NSM proxy into your application's pod spec. The Kubernetes admission controller enforces this behavior by sending a webhook request to the sidecar injector every time a pod is to be scheduled.

You have already deployed the sidecar proxy injector when you installedsz Consul, which should be running in your control plane. To verify, execute this command:
You have already deployed the sidecar proxy injector when you installed NSM, which should be running in your control plane. To verify, execute this command:

`kubectl get deployment nsm-admission-webhook -n nsm-system`{{execute}}

Expand Down Expand Up @@ -59,4 +59,4 @@ If you cannot see the *Ready* column updated, this is because the deployment can

`kubectl port-forward svc/nsm-admission-webhook 8080 --address 0.0.0.0 -n default`{{Execute}}

The Image Hub application should now be deployed on the HTTP port: `8080`. Make your way to the `ImageHub` Server tab. For this tutorial, the server is configured to be listening at `http://localhost:8080`
The ICMP application should now be deployed on the HTTP port: `8080`. Make your way to the `ImageHub` Server tab. For this tutorial, the server is configured to be listening at `http://localhost:8080`
Binary file modified Meshery-Adapters/osm-meshery-adapter/assets/osm-adapter.png
Binary file modified Meshery-Adapters/osm-meshery-adapter/assets/osm-sample.png
4 changes: 2 additions & 2 deletions Meshery-Adapters/osm-meshery-adapter/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@
"hideHiddenFiles": true,
"exclusionPatterns": ["*test", "./test/*", "./logs"],
"showdashboard": true,
"dashboards": [{"name": "Meshery Server", "port": 9081},{"name": "Image Hub", "port": 8080}],
"dashboards": [{"name": "Meshery UI", "port": 9081},{"name": "Image Hub", "port": 8080}],
"uilayout": "terminal-iframe"
},

"backend": {
"imageid": "kubernetes-cluster-running:1.18"
"imageid": "kubernetes-cluster-running:1.22"
}
}
Loading