coconut_environment_create.md

coconut environment create

create a new environment

Synopsis

The environment create command requests from AliECS the creation of a new environment.

The operation may or may not be successful depending on available resources and configuration.

A valid workflow template (sometimes called simply "workflow" for brevity) must be passed to this command via the mandatory workflow-template flag.

Workflows and tasks are managed with a git based configuration system, so the workflow template may be provided simply by name or with repository and branch/tag/hash constraints. Examples:

• coconut env create -w myworkflow - loads workflow myworkflow from default configuration repository at HEAD of master branch
• coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow - loads a workflow from a specific git repository, HEAD of master branch
• coconut env create -w myworkflow@rev - loads a workflow from default repository, on branch, tag or revision rev
• coconut env create -w github.com/AliceO2Group/MyConfRepo/myworkflow@rev - loads a workflow from a specific git repository, on branch, tag or revision rev
• coconut env create -c /home/myrepo/myconfigfile.json -e '{"hosts":"[\"my-test-machine\"]"}'
• coconut env create -c consul:///o2/runtime/COG-v1/TECHNICAL -w readout-dataflow@myBranch -e '{"hosts":"[\"my-test-machine\"]"}'
• coconut env create -c TECHNICAL -e '{"hosts":"[\"my-test-machine\"]"}'

For more information on the AliECS workflow configuration system, see documentation for the coconut repository command.

coconut environment create [flags]

Options

  -y, --asynchronous                     use asynchronous mode for environment creation
  -a, --auto                             create an autorun environment
  -c, --configuration string             high-level configuration payload to be loaded for the new environment
  -e, --extra-vars key1=val1,key2=val2   values passed using key=value CSV or JSON syntax, interpreted as strings key1=val1,key2=val2 or `{"key1": "value1", "key2": "value2"}`
  -h, --help                             help for create
  -p, --public                           control public rights of the environment (default true)
  -w, --workflow-template string         workflow to be loaded in the new environment

Options inherited from parent commands

      --config string            optional configuration file for coconut (default $HOME/.config/coconut/settings.yaml)
      --config_endpoint string   configuration endpoint used by AliECS core as PROTO://HOST:PORT (default "apricot://127.0.0.1:32101")
      --endpoint string          AliECS core endpoint as HOST:PORT (default "127.0.0.1:32102")
      --nocolor                  disable colors in output
      --nospinner                disable animations in output
  -v, --verbose                  show verbose output for debug purposes

SEE ALSO

• coconut environment - create, destroy and manage AliECS environments

Auto generated by spf13/cobra on 27-Nov-2024