From ba6c4c5c7002eeaad1e3c18a9c46ef5467b9eb6c Mon Sep 17 00:00:00 2001 From: leecalcote Date: Wed, 21 Feb 2024 21:09:15 +0000 Subject: [PATCH] [Docs] Update mesheryctl docs Signed-off-by: l5io --- .../reference/mesheryctl/mesheryctl-exp.md | 2 +- .../mesheryctl-registry-generate.md | 89 +++++++++++++++++++ .../mesheryctl/mesheryctl-registry-update.md | 8 +- .../mesheryctl/mesheryctl-registry.md | 2 +- 4 files changed, 95 insertions(+), 6 deletions(-) create mode 100644 docs/pages/reference/mesheryctl/mesheryctl-registry-generate.md diff --git a/docs/pages/reference/mesheryctl/mesheryctl-exp.md b/docs/pages/reference/mesheryctl/mesheryctl-exp.md index 3c12e979eb7..70be73d9520 100644 --- a/docs/pages/reference/mesheryctl/mesheryctl-exp.md +++ b/docs/pages/reference/mesheryctl/mesheryctl-exp.md @@ -16,7 +16,7 @@ Experimental commands for mesheryctl ## Synopsis -List of experimental commands for testing and evaluation purpose. +Commands under the Experimental group are for testing and evaluation prior to promotion to general availability. Experimental commands are subject to change. 
 

 mesheryctl exp [flags]
diff --git a/docs/pages/reference/mesheryctl/mesheryctl-registry-generate.md b/docs/pages/reference/mesheryctl/mesheryctl-registry-generate.md
new file mode 100644
index 00000000000..7b7017ba32e
--- /dev/null
+++ b/docs/pages/reference/mesheryctl/mesheryctl-registry-generate.md
@@ -0,0 +1,89 @@
+---
+layout: default
+title: mesheryctl-registry-generate
+permalink: reference/mesheryctl/registry/generate
+redirect_from: reference/mesheryctl/registry/generate/
+type: reference
+display-title: "false"
+language: en
+command: registry
+subcommand: generate
+---
+
+# mesheryctl registry generate
+
+Generate Models
+
+## Synopsis
+
+Prerequisite: Excecute this command from the root of a meshery/meshery repo fork.
+
+Given a Google Sheet with a list of model names and source locations, generate models and components any Registrant (e.g. GitHub, Artifact Hub) repositories.
+
+Generated Model files are written to local filesystem under `/server/models/`.
+
+

+mesheryctl registry generate [flags]
+
+

+
 
+
+## Examples
+
+Generate Meshery Models from a Google Spreadsheet (i.e. "Meshery Integrations" spreadsheet). 
+
+

+mesheryctl registry generate --spreadsheet-id  --spreadsheet-cred 
+
+

+
 
+
+
+

+# Example: mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred
+
+

+
 
+
+Directly generate models from one of the supported registrants by using Registrant Connection Definition and (optional) Registrant Credential Definition
+
+

+mesheryctl registry generate --registrant-def  --registrant-cred 
+
+

+
 
+
+
+

+    
+
+

+
 
+
+## Options
+
+
+

+  -h, --help                      help for generate
+  -o, --output string             location to output generated models, defaults to ../server/meshmodels (default "../server/meshmodel")
+      --registrant-cred string    path pointing to the registrant credetial definition
+      --registrant-def string     path pointing to the registrant connection definition
+      --spreadsheet-cred string   base64 encoded credential to download the spreadsheet
+      --spreadsheet-id string     spreadsheet it for the integration spreadsheet
+
+

+

+
+## Options inherited from parent commands
+
+
+

+      --config string   path to config file (default "/home/runner/.meshery/config.yaml")
+  -v, --verbose         verbose output
+
+

+

+
+## See Also
+
+Go back to [command reference index](/reference/mesheryctl/), if you want to add content manually to the CLI documentation, please refer to the [instruction](/project/contributing/contributing-cli#preserving-manually-added-documentation) for guidance.
diff --git a/docs/pages/reference/mesheryctl/mesheryctl-registry-update.md b/docs/pages/reference/mesheryctl/mesheryctl-registry-update.md
index 2e56d6df5fb..26c2c687a28 100644
--- a/docs/pages/reference/mesheryctl/mesheryctl-registry-update.md
+++ b/docs/pages/reference/mesheryctl/mesheryctl-registry-update.md
@@ -35,7 +35,7 @@ mesheryctl registry update [flags]
 
 
 

-	mesheryctl registry update --spreadsheet_id  --spreadsheet_cred  -i [path to the directory containing models].
+	mesheryctl registry update --spreadsheet-id  --spreadsheet-cred  -i [path to the directory containing models].
 
 

 
 
@@ -49,7 +49,7 @@ mesheryctl registry update [flags]
 
 
 

-	mesheryctl registry update --spreadsheet_id 1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet_cred $CRED
+	mesheryctl registry update --spreadsheet-id 1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet-cred $CRED
 
 

 
 
@@ -60,8 +60,8 @@ mesheryctl registry update [flags]
 

   -h, --help                      help for update
   -i, --input string              relative or absolute input path to the models directory (default "../server/meshmodel")
-      --spreadsheet_cred string   base64 encoded credential to download the spreadsheet
-      --spreadsheet_id string     spreadsheet it for the integration spreadsheet
+      --spreadsheet-cred string   base64 encoded credential to download the spreadsheet
+      --spreadsheet-id string     spreadsheet it for the integration spreadsheet
diff --git a/docs/pages/reference/mesheryctl/mesheryctl-registry.md b/docs/pages/reference/mesheryctl/mesheryctl-registry.md index 2036311dfa4..bdcb1c3845f 100644 --- a/docs/pages/reference/mesheryctl/mesheryctl-registry.md +++ b/docs/pages/reference/mesheryctl/mesheryctl-registry.md @@ -16,7 +16,7 @@ Meshery Registry Management ## Synopsis -Manage the state and configuration of Meshery Registry. +Manage the state and contents of Meshery's internal registry of capabilities. 
 

 mesheryctl registry [flags]