Skip to content

Commit

Permalink
[Docs] Update mesheryctl docs
Browse files Browse the repository at this point in the history
Signed-off-by: l5io <[email protected]>
  • Loading branch information
leecalcote authored and l5io committed Feb 21, 2024
1 parent 7d3eeef commit ba6c4c5
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/pages/reference/mesheryctl/mesheryctl-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl exp [flags]
Expand Down
89 changes: 89 additions & 0 deletions docs/pages/reference/mesheryctl/mesheryctl-registry-generate.md
Original file line number Diff line number Diff line change
@@ -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/<model-name>`.
<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl registry generate [flags]

</div>
</pre>

## Examples

Generate Meshery Models from a Google Spreadsheet (i.e. "Meshery Integrations" spreadsheet).
<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl registry generate --spreadsheet-id <id> --spreadsheet-cred <base64 encoded spreadsheet credential>

</div>
</pre>

<pre class='codeblock-pre'>
<div class='codeblock'>
# Example: mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred

</div>
</pre>

Directly generate models from one of the supported registrants by using Registrant Connection Definition and (optional) Registrant Credential Definition
<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl registry generate --registrant-def <path to connection definition> --registrant-cred <path to credential definition>

</div>
</pre>

<pre class='codeblock-pre'>
<div class='codeblock'>


</div>
</pre>

## Options

<pre class='codeblock-pre'>
<div class='codeblock'>
-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

</div>
</pre>

## Options inherited from parent commands

<pre class='codeblock-pre'>
<div class='codeblock'>
--config string path to config file (default "/home/runner/.meshery/config.yaml")
-v, --verbose verbose output

</div>
</pre>

## 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.
8 changes: 4 additions & 4 deletions docs/pages/reference/mesheryctl/mesheryctl-registry-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ mesheryctl registry update [flags]

<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl registry update --spreadsheet_id <id> --spreadsheet_cred <base64 encoded spreadsheet credential> -i [path to the directory containing models].
mesheryctl registry update --spreadsheet-id <id> --spreadsheet-cred <base64 encoded spreadsheet credential> -i [path to the directory containing models].

</div>
</pre>
Expand All @@ -49,7 +49,7 @@ mesheryctl registry update [flags]

<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl registry update --spreadsheet_id 1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet_cred $CRED
mesheryctl registry update --spreadsheet-id 1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw --spreadsheet-cred $CRED

</div>
</pre>
Expand All @@ -60,8 +60,8 @@ mesheryctl registry update [flags]
<div class='codeblock'>
-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

</div>
</pre>
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/reference/mesheryctl/mesheryctl-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<pre class='codeblock-pre'>
<div class='codeblock'>
mesheryctl registry [flags]
Expand Down

0 comments on commit ba6c4c5

Please sign in to comment.