forked from meshery/meshery
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
4 changed files
with
95 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
docs/pages/reference/mesheryctl/mesheryctl-registry-generate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters