agent

Usage

prism create agent is used to create an agent YML configuration file.

Usage: prism create agent [-h] --type TYPE [-f FILE] [--full-tb] [-l]

Create an agent YML configuration file

Options:
  -h, --help            show this help message and exit

Subcommand Options:
  --type TYPE           Agent type. Accepted types are `docker`
  -f, --file FILE       File path for agent YML configuration. Default is `./agent.yml`.

General Options:
  --full-tb             Display the full traceback for errors in the project; default is False
  -l, --log-level       Log level, must be one of `info`, `warn`, `error`, or `debug`. Default is `info`

Here's what prism create agent does under the hood:

1. Checks whether the YML file specified with option -f, --file exists.

   • If it doesn't, it creates a new YML file with the configuration for agent type --type.

   • If it does, it throws an error. Each agent must live in their own YML file.

Example

Here's what the output looks like in Terminal:

$ prism create agent --type docker -f ./docker_agent.yml
--------------------------------------------------------------------------------
<HH:MM:SS> | INFO  | Running with prism v0.1.9rc1...
<HH:MM:SS> | INFO  | Found project directory at /Users/my_first_project
 
<HH:MM:SS> | INFO  | RUNNING EVENT 'parsing prism_project.py'................................................ [RUN]
<HH:MM:SS> | INFO  | FINISHED EVENT 'parsing prism_project.py'............................................... [DONE in 1.34s]
 
<HH:MM:SS> | INFO  | Creating docker_agent.yml...
 
<HH:MM:SS> | INFO  | Done!
--------------------------------------------------------------------------------

After this command executes, the following file will be added to your project directory.

# docker_agent.yml

agent:
  type: docker
  image: <base image>
  server_url:  # URL to the docker server
  requirements:  # path to requirements.txt, relative to this file
  env:
    <your environment variable here>: '<your environment variable value'