Thanks to visit codestin.com
Credit goes to docs.google.com

ABCDEFGHIJKLMNOPRST
1
servQuick ReferenceColor LegendDocumentation StatusUpcoming ReleaseRoadmap
2
Meshery CLI Commands and Documentationcompleted"cmd index""cmd page"v0.8.0mesheryctl Roadmap
3
not completed
4
partially completedrefers to mesheryctl command referencerefers to page dedicated to command
5
mesheryctl open issues and pull requestsnot applicable
6
needs more info
7
action item
8
experimental
9
10
Global Commands and Flags
11
commandflagfunctionusagecommentsimplemented?Tests Written?context awarenessDockerK8sMacLinuxWincmd indexcmd pagerelease statusroadmap
12
mesheryctl
13
completiongenerates completion scriptmesheryctl completion [bash\|zsh\|fish]YesN/AN/AN/AYesYesN/AYesReady
14
mesheryctlversiondisplays the version of mesheryctl and the SHA of the release binarymesheryctl version
15
help, hdisplays help for any commandmesheryctl --helpdisplays the complete helpLook through each of the inbuilt docs and fix any errorsN/AN/AN/AYesYesYesYesYesReady
16
mesheryctl system --helpdisplays the help for system commandsN/AN/AN/AYesYesYesYesYesReady
17
mesheryctl system start --helpdisplays help for the system start commandN/AN/AN/AYesYesYesYesYesReady
18
configpath to mesheryctl config file(~/.meshery/config.yaml)mesheryctl system reset --config=<path to config file>default value of the config file is ~/.meshery/config.yaml.YesN/AN/AN/AYesYesYesYesYesReady
19
verbose, vdisplays verbose/debug logsmesheryctl system update --verboseeven though the flag is global, verbose/debug logs are not added to commandsYes: verbose flagN/AN/AN/AYesYesYesYesYesReady
20
No: debug logsN/AN/AN/AYesYesadd debug logs
21
22
Meshery Lifecycle and Troubleshooting
23
argumentsflagfunctionusagecommentsimplemented?context awarenessDockerK8sMacLinuxWincmd indexcmd pagerelease statusroadmap
24
system
25
systemcontext, cmesheryctl system reset -c <temporary context name>global flag applicable to all system commandsYesN/AN/AN/AYesYesYesReady
26
startstart Meshery display endpoint based on the platformmesheryctl system startstarts Meshery containers for Docker; applies manifest files to the cluster for Kubernetes; displays endpoint based on platform(The endpoint for docker users is http://localhost:PORT, where PORT is taken from the endpoint specified in meshconfig)The endpoint returned when deployed to Kubernetes is wrong/inaccessibleYesYesYesYesYesYesYesYesYesneed to handle error when version is higher than available versionmesheryctl should only change specific stuff in meshery.yaml, versions should be addable in meshconfig
27
skip-updatestart Meshery- skip checking for new Meshery container imagesmesheryctl system start --skip-updateNot for Kubernetes- dependent on caching manifests locallyYesYesYesYesYesYesYes
28
resetstart Meshery- reset Meshery's configuration file to default settingsmesheryctl system start --resetYesYesYesYesYesYesYesYesreset flag does not work properly
29
yes, ystart Meshery- silently create Meshery's configuration file with default settingsmesheryctl system start --yesYesYesYesYesYesTBDYesYesReady
30
stopstop Mesherymesheryctl system stopstops running Meshery containers for Docker; deletes Meshery deployments from the cluster for Kubernetes. Working to apply and remove operator manifests on start and stop respectively, for platform: dockerYesYesYesYesYesYesYesYesYesYesfails if meshery pods are already running in the clusteradd debug logs
31
resetstop Meshery- reset Meshery's configuration file to default settingsmesheryctl system stop --resetYesYesYesYesYesYesYesReady
32
restartrestart all Meshery containers, their instances and their connected volumesmesheryctl system restartModifying the working to delete all the running pods and let the services restart the pod automaticallyYesYesYesYesYesYesYesYesYesYesrestart would not work if meshery is not already started (occurs sometimes if the platform is Kubernetes)
33
skip-updaterestart Meshery - skip checking for new Meshery container imagesmesheryctl system restart --skip-updateYesYesYesYesTBDTBDYesTBDYesYesReady
34
resetresets meshery.yaml file with a copy from Meshery repomesheryctl system resetYesYesYesYesYesYesYesYesYesYes
35
updatepulls new Meshery images from Docker Hub. Does not update mesheryctl. This command can be run while Meshery is running. mesheryctl system updateDoes not update operator manifests for Docker platformYesYesYesYesYesYesYesYesYesfor docker it does not update the operator manifests, okay for kubernetes
36
configconfigures Meshery with kubeconfig. Generated with the help of user details to provide access for public clouds(GKE/EKS)mesheryctl system config gke --token <path to token>YesYesTBDN/AN/AYesYesTBDYesYesif the platform is not specified, it does not show what to input to the user
37
logstarts tailing Meshery server debug logsmesheryctl system logYesYesYesYesYesYesYesYesYesYesthe docs does not specify that it support argumentsshould have a flag to tail logs(in Kubernetes)- tailing logs being worked upon in meshsync
38
statusdisplay the endpoint and status of the containers/pods in a Meshery deploymentmesheryctl system statusDisplays endpoint based on platform: 1. docker users have the endpoint http://localhost:PORT, where PORT is taken from the endpoint specified in meshconfig. 2. Kubernetes users have the service endpoint displayed, obtained by querying the Kubernetes APIYesYesN/AYesYesYesYesYesYesYesReady
39
checkchecks current environment and Meshery deployment healthmesheryctl system checkYesN/AYesYesN/AN/AN/AYesYes
40
preflightonly runs Docker and Kubernetes checksmesheryctl system check --preflightYesNoYesYesN/AN/AN/AYesYes
41
adapterchecks on specific adaptermesheryctl system check --adapterYesNo
42
operatorverifies health of Meshery Operator deployment with MeshSync and Brokermesheryctl system check --operatorNoNo
43
reportruns diagnostics collection and bundles for opening an issuemesheryctl system check --reportNoNo
44
system channel
45
system channelsetsets release channel and version of context in focusmesheryctl system channel setYesYesN/AN/AYesYesYesYesTBDshould show confirmation to the user, should validate the channel
46
viewview release channel and version of context in focusmesheryctl system channel viewYesYesN/AN/AYesYesYesYesYesReady
47
all, aview release channel and version of all contextsmesheryctl system channel view --allYesYesN/AN/AYesYesYesYesYesReady
48
switchswitch release channel and version of context in focusmesheryctl system channel switchYesYesN/AN/AYesYesYesYesTBDError on MacOS and Windows
49
system context
50
system contextdisplay the current contextmesheryctl system contextYesYesN/AYesYesYesYesYesYesReady
51
createcreate a new context in config.yaml filemesheryctl system context create <context name>YesYesN/AYesYesYesYesYesYesReady
52
url, ucreate a new context in config.yaml file- set Meshery server URL. Defaults to "https://localhost:9081"mesheryctl system context create <context name> --url <URL>YesYesN/AYesYesYesYesYesYesReady
53
set, screate a new context in config.yaml file- set as current contextmesheryctl system context create <context name> --setYesYesN/AYesYesYesTBDYesYesReady
54
platformcreate a new context in config.yaml file- specify the platformmesheryctl system context create <context name> --platform [docker|kubernetes]YesYesYesYesYesTBDYesTBDReady
55
adapters, acreate a new context in config.yaml file- specify the list of adapters to be addedmesheryctl system context create <context name> --adapters <list of adapters>YesYesN/AYesYesYesTBDYesYesReady
56
deletedelete the specified context from the config.yaml file - in case user chooses to delete the current context, a confirmatory question and an interactive list are displayed, both of which can be automated using flagsmesheryctl system context delete <context name>YesYesN/AN/AN/AYesYesYesYesYesIntroduced interactivity to select context when the user is deleting current context. (PR #3060)
57
switchswitch between contextsmesheryctl system context switch <context name>YesYesN/AN/AN/AYesYesYesYesYesReady
58
viewview the configurations of the current contextmesheryctl system context viewYesYesN/AN/AN/AYesYesYesYesYesReady
59
--contextview the configurations of the specified contextmesheryctl system context view --context <context name>YesYesN/AN/AN/AYesYesYesYesYesReady
60
--allif set, shows the configurations of all the contextsmesheryctl system context view --allYesYesN/AN/AN/AYesYesYesYesYesReady
61
listlists all the available contexts and the current contextmesheryctl system context listYesYesN/AN/AN/AYesYesYesYesTBDReady
62
system token
63
// Token CRUD specific commands to be added here
64
Performance Management
65
commandflagfunctionusagecommentsimplemented?Support for Nighthawk?DockerK8sMacLinuxWincmd indexcmd pagerelease statusroadmap
66
perf
67
perfperformance management- baseline and testingdoes not support performance profiles. Consideration of new subcommands in design spec.YesNoYesNoYesYesYesYes
68
applyrun a performance test with the performance profile specifiedmesheryctl perf apply profile-namewill be supported with this spec.Yes
69
url(required) endpoint URL to testmesheryctl perf apply profile-name --url <URL>YesNoYesNoYesYesYesYesYes
70
namename of the testmesheryctl perf apply profile-name --name "<name>" --url <URL>YesNoYesNoYesYesYesYesYes
71
meshname of the adaptermesheryctl perf apply profile-name --adapter <name> --url <URL>YesNoYesNoYesYesYesYesYes
72
qpsqueries per secondmesheryctl perf apply profile-name --qps <queries> --url <URL>YesNoYesNoYesYesYesYesYes
73
concurrent-requestsnumber of parallel requestsmesheryctl perf apply profile-name --concurrent-requests <number of requests> --url <URL>YesNoYesNoYesYesYesYesYes
74
durationlength of the test (e.g. 10s, 5m, 2h). For more, see https://golang.org/pkg/time/#ParseDurationmesheryctl perf apply profile-name --duration <time> --url <URL>YesNoYesNoYesYesYesYesYes
75
tokenpath to Meshery auth tokenmesheryctl perf apply profile-name --token <path to token> --url <URL>YesNoYesNoYesYesYesYesYes
76
load-generatorload generator to be used (fortio/wrk2)mesheryctl perf apply profile-name --load-generator [fortio/wrk2] --url <URL>YesNoYesNoYesYesYesYesYes
77
filefile containing SMP compatible test configuration. For more, see https://github.com/layer5io/service-mesh-performance-specificationmesheryctl perf apply profile-name --file <path to file> --url <URL>need to add support to import and apply SMP compatible files from GitHub or local. Being considered in this spec.YesNoYesNoYesYesTBDYesYes
78
profilelists all the available performance profilesmesheryctl perf profilewill be added with this specYesYesYesNoYesYesYesYesNo
79
lists and search performance profiles with the given namemesheryctl perf profile [profile-name]will be added with this specYesYesNoYesYesYesYesNo
80
viewview single performance profile with detailed fashionmesheryctl perf profile --viewwill be added with this specYesYesYesYesYesYes
81
output-formatprint performance profiles in [json|yaml]mesheryctl perf profile --output-format [json|yaml]will be added with this specYesYesYesYesYesYes
82
resultlist all the performance results with the matching profile namemesheryctl perf result [profile-name]will be added with this specYesYesYesNoYesYesYesYesNo
83
viewview single the performance result with additional details the matching profile namemesheryctl perf result [profile-name] --viewwill be added with this specYesYesYesNoYesYesYesYesNo
84
output-formatprint performance results in [json|yaml]mesheryctl perf result [profile-name] --output-format [json|yaml]will be added with this specYesYesYesYesYesYes
85
86
Lifecycle Management
87
commandflagfunctionusagecommentsimplemented?context awarenessDockerK8sMacLinuxWincmd indexcmd pagerelease statusroadmap
88
mesh
89
meshvalidatevalidate cloud native infrastructure conformance to different standard specifications YesYesYesYesYesYesYesYes
90
adapter, a(required) adapter to use for validation. Defaults to "meshery-osm:10010"mesheryctl adapter validate [mesh name] --adapter <name of the adapter> --tokenPath <path to token for authentication> --spec <specification to be used for conformance test>YesYesYesYesYesYesYesYes
91
spec, s(required) specification to be used for conformance test. Defaults to "smi"Only istio supports "Analyse Running Configuration" [istio-vet] (for now)YesYesYesYesYesYesYesYes
92
tokenPath, t(optional) path to token for authenticating to Meshery APIYesYesYesYesYesYesYesYes
93
namespace, nKubernetes namespace to be used for deploying the validation tests and sample workloadmesheryctl adapter validate [mesh name] --adapter <name of the adapter> --tokenPath <path to token for authentication> --spec <specification to be used for conformance test> --namespace <namespace to be used>No need for this in "smi". This should be removed.YesYesYesYesYesYesYesYes
94
validate viewview the result of a Conformance Testmesheryctl validate view [name|id]New command to be added. Being considered in this design spec.NoNoNoNoNoNoNoNo
95
--allview all the resultsmesheryctl validate view --allNoNoNoNoNoNoNoNo
96
deploydeploy cloud native infrastructure into the clustermesheryctl adapter deploy [mesh name]YesYesYesYesYesYesYesYes
97
applyadapter operationsmesheryctl adapter apply <name of operation like mTLS>NoNoNoNoNoNoNoNo
98
removeremove a cloud native infrastructure from the clustermesheryctl adapter remove [mesh name]YesYesYesYesYesYesYesYes
99
100
Configuration Management