Generate legacy run template json file¶
Help command
> csm-orc gen-from-legacy --help
Usage: csm-orc gen-from-legacy [OPTIONS] COMMAND [ARGS]...
Base command for the json generator using legacy files
Check the help of the sub commands for more information:
• cloud requires access to a fully deployed solution
• solution requires a Solution.yaml file
╭─ OPTIONS ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --web-help Open the web documentation │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ cloud Connect to the cosmotech API to download a run template and generate an orchestrator file at OUTPUT │
│ solution Read SOLUTION_FILE to get a RUN_TEMPLATE_ID and generate an orchestrator file at OUTPUT │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Generate json from Soluton.yaml
> csm-orc gen-from-legacy solution --help
Usage: csm-orc gen-from-legacy solution [OPTIONS] SOLUTION_FILE OUTPUT RUN_TEMPLATE_ID
Read SOLUTION_FILE to get a RUN_TEMPLATE_ID and generate an orchestrator file at OUTPUT
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * SOLUTION_FILE FILE [required] │
│ * OUTPUT FILE [required] │
│ * RUN-TEMPLATE-ID TEXT [required] │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ OPTIONS ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --describe/--no-describe Show a description of the generated template after generation │
│ DEFAULT: no-describe │
│ --web-help Open the web documentation │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Generate json from Cosmo Tech API
> csm-orc gen-from-legacy cloud --help
Usage: csm-orc gen-from-legacy cloud [OPTIONS] OUTPUT
Connect to the cosmotech API to download a run template and generate an orchestrator file at OUTPUT
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * OUTPUT FILE [required] │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ OPTIONS ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * --api-url URL The url to a Cosmotech API │
│ ENV: CSM_API_URL │
│ [required] │
│ * --api-scope URI The identification scope of a Cosmotech API │
│ ENV: CSM_API_SCOPE │
│ [required] │
│ * --organization-id o-########## The id of an organization in the cosmotech api │
│ ENV: CSM_ORGANIZATION_ID │
│ [required] │
│ * --workspace-id w-########## The id of a solution in the cosmotech api │
│ ENV: CSM_WORKSPACE_ID │
│ [required] │
│ * --run-template-id NAME The name of the run template in the cosmotech api │
│ ENV: CSM_RUN_TEMPLATE_ID │
│ [required] │
│ --describe/--no-describe Show a description of the generated template after generation │
│ DEFAULT: no-describe │
│ --web-help Open the web documentation │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯