mesheryctl registry generate

Generate Models

Synopsis

Prerequisite: Excecute this command from the root of a meshery/meshery repo fork.\n\nGiven a Google Sheet with a list of model names and source locations, generate models and components any Registrant (e.g. GitHub, Artifact Hub) repositories.\n\nGenerated Model files are written to local filesystem under “/server/models/". Documentation for components can be found at https://docs.meshery.io/reference/mesheryctl/registry/generate


mesheryctl registry generate [flags]

Examples

Generate Meshery Models from a Google Spreadsheet (i.e. “Meshery Integrations” spreadsheet).


mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred "$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 [path to connection definition] --registrant-cred [path to credential definition]

Generate a specific Model from a Google Spreadsheet (i.e. “Meshery Integrations” spreadsheet).


mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred --model "[model-name]"

Generate Meshery Models and Component from csv files in a local directory.


mesheryctl registry generate --directory [DIRECTORY_PATH]

Generate Meshery Models from individual CSV files.


mesheryctl registry generate --model-csv [path/to/models.csv] --component-csv [path/to/components.csv] --relationship-csv [path/to/relationships.csv]

Generate models with a custom per-model timeout (e.g., 10 minutes per model).


mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred "$CRED" --timeout 10m

Generate only the latest version of each model.


mesheryctl registry generate --spreadsheet-id "1DZHnzxYWOlJ69Oguz4LkRVTFM79kC2tuvdwizOJmeMw" --spreadsheet-cred "$CRED" --latest-only

Options


      --component-csv string      path to the component CSV file
  -d, --directory string          Directory containing the Model and Component CSV files
  -h, --help                      help for generate
      --latest-only               generate only the latest version of each model
  -m, --model string              specific model name to be generated
      --model-csv string          path to the model CSV file
  -o, --output string             location to output generated models, defaults to ../server/meshmodels (default "../server/meshmodel")
      --registrant-cred string    path pointing to the registrant credential definition
      --registrant-def string     path pointing to the registrant connection definition
      --relationship-csv string   path to the relationship CSV file (optional)
      --spreadsheet-cred string   base64 encoded credential to download the spreadsheet
      --spreadsheet-id string     spreadsheet ID for the integration spreadsheet
      --timeout duration          timeout duration for generating each model (e.g., 5m, 10m, 1h), default: 5m (default 5m0s)

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, if you want to add content manually to the CLI documentation, please refer to the instruction for guidance.