csm-orc run-step

Description

Runs a RunTemplate Step with most of the environment variables given by the Cosmo Tech API. May require a functional environment allowing access to a Cosmo Tech API

Command

csm-orc --log-level $LOG_LEVEL run-step --template $CSM_RUN_TEMPLATE_ID --steps $CSM_CONTAINER_MODE

Defined Environment

Variable Name	Description
CSM_ORGANIZATION_ID	The id of an organization in the Cosmo Tech API
CSM_WORKSPACE_ID	The id of a workspace in the Cosmo Tech API
CSM_RUN_TEMPLATE_ID	The name of the run template defined in the Cosmo Tech API and available in the project
CSM_CONTAINER_MODE	The steps run during a run-step
CSM_API_URL	The url to a Cosmo Tech API
CSM_API_SCOPE	The identification scope of a Cosmo Tech API
AZURE_TENANT_ID	An Azure Tenant ID
AZURE_CLIENT_ID	An Azure Client ID having access to the Cosmo Tech API
AZURE_CLIENT_SECRET	The secret for the Azure Client
LOG_LEVEL	Either CRITICAL, ERROR, WARNING, INFO or DEBUG
PYTHONPATH	A list of folder to add to the python path
CSM_DATASET_ABSOLUTE_PATH	A local folder to store the main dataset content
CSM_PARAMETERS_ABSOLUTE_PATH	A local folder to store the parameters content
CSM_SIMULATION_ID	The id of the simulation run
CSM_SIMULATION	The name of the Simulation file to use
AZURE_DATA_EXPLORER_RESOURCE_URI	the ADX cluster path (URI info can be found into ADX cluster page)
AZURE_DATA_EXPLORER_RESOURCE_INGEST_URI	The ADX cluster ingest path (URI info can be found into ADX cluster page)
AZURE_DATA_EXPLORER_DATABASE_NAME	The targeted database name
CSM_PROBES_MEASURES_TOPIC	An AMQP URI to send probe data to
CSM_CONTROL_PLANE_TOPIC	An AMQP URI to send simulation control values to

Will be passed all system Environment Variables as well as the defined Environment

csm-orc run-step json file

{
  "id":"csm-orc run-step",
  "command":"csm-orc",
  "arguments":[
    "--log-level",
    "$LOG_LEVEL",
    "run-step",
    "--template",
    "$CSM_RUN_TEMPLATE_ID",
    "--steps",
    "$CSM_CONTAINER_MODE"
  ],
  "environment":{
    "CSM_ORGANIZATION_ID":{
      "description":"The id of an organization in the Cosmo Tech API",
      "optional":true
    },
    "CSM_WORKSPACE_ID":{
      "description":"The id of a workspace in the Cosmo Tech API",
      "optional":true
    },
    "CSM_RUN_TEMPLATE_ID":{
      "description":"The name of the run template defined in the Cosmo Tech API and available in the project"
    },
    "CSM_CONTAINER_MODE":{
      "description":"The steps run during a run-step"
    },
    "CSM_API_URL":{
      "description":"The url to a Cosmo Tech API",
      "optional":true
    },
    "CSM_API_SCOPE":{
      "description":"The identification scope of a Cosmo Tech API",
      "optional":true
    },
    "AZURE_TENANT_ID":{
      "description":"An Azure Tenant ID",
      "optional":true
    },
    "AZURE_CLIENT_ID":{
      "description":"An Azure Client ID having access to the Cosmo Tech API",
      "optional":true
    },
    "AZURE_CLIENT_SECRET":{
      "description":"The secret for the Azure Client",
      "optional":true
    },
    "LOG_LEVEL":{
      "defaultValue":"INFO",
      "description":"Either CRITICAL, ERROR, WARNING, INFO or DEBUG"
    },
    "PYTHONPATH":{
      "description":"A list of folder to add to the python path"
    },
    "CSM_DATASET_ABSOLUTE_PATH":{
      "description":"A local folder to store the main dataset content"
    },
    "CSM_PARAMETERS_ABSOLUTE_PATH":{
      "description":"A local folder to store the parameters content"
    },
    "CSM_SIMULATION_ID":{
      "description":"The id of the simulation run"
    },
    "CSM_SIMULATION":{
      "description":"The name of the Simulation file to use"
    },
    "AZURE_DATA_EXPLORER_RESOURCE_URI":{
      "description":"the ADX cluster path (URI info can be found into ADX cluster page)",
      "optional":true
    },
    "AZURE_DATA_EXPLORER_RESOURCE_INGEST_URI":{
      "description":"The ADX cluster ingest path (URI info can be found into ADX cluster page)",
      "optional":true
    },
    "AZURE_DATA_EXPLORER_DATABASE_NAME":{
      "description":"The targeted database name",
      "optional":true
    },
    "CSM_PROBES_MEASURES_TOPIC":{
      "description":"An AMQP URI to send probe data to",
      "optional":true
    },
    "CSM_CONTROL_PLANE_TOPIC":{
      "description":"An AMQP URI to send simulation control values to",
      "optional":true
    }
  },
  "description":"Runs a RunTemplate Step with most of the environment variables given by the Cosmo Tech API. May require a functional environment allowing access to a Cosmo Tech API",
  "useSystemEnvironment":true
}