Meshery: [mesheryctl] Create `mesheryctl system check`

[leecalcote]

Child Issue- [mesheryctl] [child] Create mesheryctl exp preflight to verify environment readiness for a Meshery deloyment #2607

Current Behavior
Users are able to run mesheryctl system status to check whether Meshery containers are running or not in their local Docker environment (using docker-compose). Users are not, however, able to perform to other types of checks in-depth:

1. check - a sophisticated check encompassing current environment and current Meshery deployment health. Should include aspects of system version and of system status.
2. preflight - for verification of presence of dependencies and overall environment readiness for a Meshery deployment

Desired Behavior
mesheryctl should provide a utility to aid in the troubleshooting of Meshery deployments. This utility will need to run a number of health checks.

Implementation

1. As a subcommand of the experimental command, create mesheryctl experimental system check.
2. Invoke the collection of connectivity tests between Meshery server, its adapters, Kubernetes, and any connected add-ons like Grafana, Prometheus, Kubernetes permission verification, and Meshery version check.
3. This utility should support a --preflight flag like so: mesheryctl system check --preflight, which only runs the Docker and Kubernetes checks.

Mockups

➜  ~ mesheryctl system check

Docker
--------------
√ Docker is running
√ docker-compose is available

Kubernetes API
--------------
√ can initialize the client
√ can query the Kubernetes API
√ has required level of privileges

Kubernetes Version
------------------
√ is running the minimum Kubernetes API version
√ is running the minimum kubectl version

Meshery Version
---------------
√ server is up-to-date (stable-v0.x.x)
√ cli is up-to-date (stable-v0.x.x)

Meshery Adapters
---------------
√ meshery-istio adapter is reachable and running
√ meshery-consul adapter is reachable and running
√ meshery-linkerd adapter is reachable and running
.
.
.
√ meshery-nginx-sm adapter is reachable and running
√ meshery-octarine adapter is reachable and running

Acceptance Tests

1. _Meshery Preflight_
   
   
   
   • Users may or may not be installing to Docker, so failure of Docker being available should only be shown as a warning.
   
   

1. _Meshery Version_

   • To verify the Meshery server version and the Meshery client version, this check should first attempt to use the /api/server/version endpoint on Meshery server and should use the mesheryctl system version function to check on the client version. It should inform the user if a later version of either server or client is available. It should warn the user if the server and client are not at the same version number.

2. _Meshery Adapters_

   • To verify availability of Meshery adapters, this check should invoke the /api/mesh/adapter/ping endpoint on Meshery to run an ad-hoc connectivity tests for all known adapters.
   • A user may have disabled some or all of Meshery's adapters. Irrespective, all known adapters should be checked for availability.

3. _Kubernetes_

   • Meshery requires "ClusterAdmin" role in order to be able to provide and manage service meshes. This check should verify that the Meshery ServiceAccount has the "ClusterAdmin" role assigned.

[nitishm]

worth splitting this into multiple issues so that folks can pick up sections of this?

[leecalcote]

Yes, most certainly.

[nitishm]

With that said I can look into this unless someone else wants to pick this up?

[leecalcote]

Yes, most assuredly.

[leecalcote]

Our conversation stopped just shy of me having reach down deep for another adverb.

[nitishm]

Meshery Adapters
To verify availability of Meshery adapters, this check should invoke the `` endpoint on Meshery to run an ad-hoc connectivity tests for all known adapters.

What is the endpoint above? Just states ``

[leecalcote]

Here we are. Adapter ad-hoc ping test: /api/mesh/adapter/ping - https://github.com/layer5io/meshery/blob/master/handlers/mesh_ops_handlers.go#L268

URL Encoded Example:
http://localhost:9081/api/mesh/adapter/ping?adapter=meshery-consul%3A10002 (%3A being a colon)

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale[bot]]

This issue is being automatically closed due to inactivity. However, you may choose to reopen this issue.

[piyushsingariya]

Hey @leecalcote is this open? Can I try this?

[navendu-pottekkat]

@piyushsingariya @leecalcote This seems like a big task. We should consider splitting it up...

[navendu-pottekkat]

@leecalcote @piyushsingariya We can first start with implementing preflight. And check should run preflight plus ping the adapters. How does that sound?

[piyushsingariya]

@navendu-pottekkat Agreed, preflight should be implemented first.

[navendu-pottekkat]

@leecalcote @piyushsingariya I have moved the preflight checks to #2607