Actors¶
Support for Tapis actors (also known as Abaco actors) is is provided by the
actors command set. It includes supplementary workflows for creating
and deploying actor projects such as actors init
and actors deploy
.
General¶
List and inspect all Actors the currently authenticated user can access.
actors list¶
List available Actors
tapis actors list
[--sort-ascending | --sort-descending]
[--filter GLOB]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--filter
GLOB
¶ Filter by name,description,image,owner
Replaces legacy CLI command “abaco list”
actors show¶
Show details for an Actor
tapis actors show [-Z NONCE] ACTOR_ID
-
-Z
NONCE
,
--nonce
NONCE
¶ Tapis nonce
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco list”
Messaging¶
Send a message to an Actor’s mailbox, resulting in an Execution. This can be done asynchronously (default) or synchronously. For the latter case, it is possible to save the result to a file.
actors submit¶
Send an asynchronous message to an Actor
tapis actors submit
[-Z NONCE]
(-m STRING | -F FILEPATH)
[-e key=value]
ACTOR_ID
-
-Z
NONCE
,
--nonce
NONCE
¶ Tapis nonce
-
-m
STRING
,
--message
STRING
¶ Message to send to the Actor
-
-F
FILEPATH
,
--file
FILEPATH
¶ Text file containing Actor message
-
-e
key=value
¶ Variable to send to the Actor (can be specified multiple times)
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco run”
actors run¶
Send a message to an Actor and await response
tapis actors run
[-Z NONCE]
(-m STRING | -F FILEPATH)
[-e key=value]
[-O OUTPUT]
[--binary]
ACTOR_ID
-
-Z
NONCE
,
--nonce
NONCE
¶ Tapis nonce
-
-m
STRING
,
--message
STRING
¶ Message to send to the Actor
-
-F
FILEPATH
,
--file
FILEPATH
¶ Text file containing Actor message
-
-e
key=value
¶ Variable to send to the Actor (can be specified multiple times)
-
-O
<OUTPUT>
¶ Output destination (default: STDOUT)
-
--binary
¶
Treat output as binary data
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco run”
Executions¶
List and inspect Executions for a given Actor. It is also possible to view the logs for a specific Execution.
actors execs list¶
List Executions for a specific Actor
tapis actors execs list
[--sort-ascending | --sort-descending]
[-Z NONCE]
[--filter GLOB]
ACTOR_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-Z
NONCE
,
--nonce
NONCE
¶ Tapis nonce
-
--filter
GLOB
¶ Filter by finalState,status
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco executions”
actors execs logs¶
Show logs for a specific Execution
tapis actors execs logs
[--sort-ascending | --sort-descending]
[-Z NONCE]
ACTOR_ID
EXECUTION_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-Z
NONCE
,
--nonce
NONCE
¶ Tapis nonce
-
ACTOR_ID
¶
Actor identifier
-
EXECUTION_ID
¶
Execution identifier
Replaces legacy CLI command “abaco logs”
Sharing¶
Assign and manage human-readable nicknames for Actors that can be used in lieu of their unique IDs.
Aliases¶
actors aliases create¶
Add an Alias for an Actor
tapis actors aliases create ALIAS_ID ACTOR_ID
-
ALIAS_ID
¶
Alias string
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco aliases create”
actors aliases delete¶
Delete an Actor Alias
tapis actors aliases delete ALIAS_ID
-
ALIAS_ID
¶
Alias string
Replaces legacy CLI command “abaco aliases rm”
actors aliases list¶
List all Actor Aliases
tapis actors aliases list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
[--filter GLOB]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
--filter
GLOB
¶ Filter by owner
Replaces legacy CLI command “abaco aliases list”
Nonces¶
Generate and manage Nonces, which are a kind of API key for Actors that allow them to be used without authenticating to the Tapis platform.
actors nonces create¶
Create a Nonce for the specified Actor (or Alias)
tapis actors nonces create
[--level LEVEL]
[--max-uses INT]
[-A]
ACTOR_ID
-
--level
LEVEL
¶ Optional Permissions level for this Nonce (default: EXECUTE)
-
--max-uses
INT
¶ Optional Max number of times Nonce can be redeemed (default: -1)
-
-A
¶
Identifier is an ALIAS rather than an ACTOR_ID
-
ACTOR_ID
¶
Actor identifier
actors nonces delete¶
Delete a Nonce from an Actor (or Alias)
tapis actors nonces delete [-A] ACTOR_ID NONCE_ID
-
-A
¶
Identifier is an ALIAS rather than an ACTOR_ID
-
ACTOR_ID
¶
Actor identifier
-
NONCE_ID
¶
Nonce identifier
actors nonces list¶
List Nonces for the specified Actor (or Alias)
tapis actors nonces list
[--sort-ascending | --sort-descending]
[--filter GLOB]
[-A]
ACTOR_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--filter
GLOB
¶ Filter by description,level
-
-A
¶
Identifier is an ALIAS rather than an ACTOR_ID
-
ACTOR_ID
¶
Actor identifier
Permissions¶
Grant and manage update and execution rights for an Actor to other Tapis platform users.
Administration¶
Create and manage Actors. This can be accomplished by interacting
directly with the Abaco APIs via create
, update
, and
delete
or via Tapis CLI workflows init
and deploy
.
actors create¶
Create an Actor
tapis actors create
--repo ACTOR_REPO
-n NAME
[-d DESCRIPTION]
[--stateful | --stateless]
[--hints ACTOR_HINTS]
[--privileged | --unprivileged]
[--tokens | --no-tokens]
[--actor-uid | --user-uid]
[-e KEY=VALUE | -E ACTOR_ENV_FILE]
[--link ACTOR_ID|ALIAS]
[--webhook URL]
[--cron-schedule SCHEDULE]
[--cron-on | --cron-off]
[--force]
-
--repo
<ACTOR_REPO>
¶ Docker image repo for the Actor
-
-n
NAME
,
--name
NAME
¶ Name of the Actor
-
-d
DESCRIPTION
,
--description
DESCRIPTION
¶ Plaintext description of the Actor
-
--stateful
¶
Actor will be stateful
-
--stateless
¶
Actor will be stateless [default]
-
--hints
<ACTOR_HINTS>
¶ Comma-separated list of keyword hints
-
--privileged
¶
Actor will have elevated privileges
-
--unprivileged
¶
Actor will not have elevated privileges [default]
-
--tokens
¶
Actor will request Tapis Oauth2 tokens [default]
-
--no-tokens
¶
Actor will not request Tapis Oauth2 tokens
-
--actor-uid
¶
Actor will run as container UID
-
--user-uid
¶
Actor will run as the User UID [default]
-
-e
KEY=VALUE
,
--env
KEY=VALUE
¶ Actor environment variables (can be specified multiple times)
-
-E
<ACTOR_ENV_FILE>
,
--env-file
<ACTOR_ENV_FILE>
¶ Actor environment variables JSON file
-
--link
ACTOR_ID|ALIAS
¶ Actor ID or Alias event notifications
-
--webhook
URL
¶ URL for event notifications
-
--cron-schedule
SCHEDULE
¶ Cron schedule (yyyy-mm-dd hh + <int> <time unit>)
-
--cron-on
¶
Actor cron is on
-
--cron-off
¶
Actor cron is off
-
--force
¶
Force Abaco to update Actor container image
Replaces legacy CLI command “abaco create”
actors update¶
Update an Actor
tapis actors update
--repo ACTOR_REPO
[-d DESCRIPTION]
[--hints ACTOR_HINTS]
[--privileged | --unprivileged]
[--tokens | --no-tokens]
[--actor-uid | --user-uid]
[-e KEY=VALUE | -E ACTOR_ENV_FILE]
[--link ACTOR_ID|ALIAS]
[--webhook URL]
[--cron-schedule SCHEDULE]
[--cron-on | --cron-off]
[--force]
ACTOR_ID
-
--repo
<ACTOR_REPO>
¶ Docker image repo for the Actor
-
-d
DESCRIPTION
,
--description
DESCRIPTION
¶ Plaintext description of the Actor
-
--hints
<ACTOR_HINTS>
¶ Comma-separated list of keyword hints
-
--privileged
¶
Actor will have elevated privileges
-
--unprivileged
¶
Actor will not have elevated privileges [default]
-
--tokens
¶
Actor will request Tapis Oauth2 tokens [default]
-
--no-tokens
¶
Actor will not request Tapis Oauth2 tokens
-
--actor-uid
¶
Actor will run as container UID
-
--user-uid
¶
Actor will run as the User UID [default]
-
-e
KEY=VALUE
,
--env
KEY=VALUE
¶ Actor environment variables (can be specified multiple times)
-
-E
<ACTOR_ENV_FILE>
,
--env-file
<ACTOR_ENV_FILE>
¶ Actor environment variables JSON file
-
--link
ACTOR_ID|ALIAS
¶ Actor ID or Alias event notifications
-
--webhook
URL
¶ URL for event notifications
-
--cron-schedule
SCHEDULE
¶ Cron schedule (yyyy-mm-dd hh + <int> <time unit>)
-
--cron-on
¶
Actor cron is on
-
--cron-off
¶
Actor cron is off
-
--force
¶
Force Abaco to update Actor container image
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco update”
actors delete¶
Delete an Actor
tapis actors delete ACTOR_ID
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco rm”
actors deploy¶
Deploy an Actor from a project directory
tapis actors deploy
[--sort-ascending | --sort-descending]
[--ini FILEPATH]
[-I ACTOR_ID | --force-create]
[-E ENVS_FILE]
[-R]
[--ignore-errors]
[--no-build]
[--no-pull]
[--no-push]
[--no-create]
[--no-cache]
[--no-grant]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--ini
FILEPATH
¶ .ini file (project.ini)
-
-I
<ACTOR_ID>
,
--id
<ACTOR_ID>
¶ Actor identifier (overrides existing)
-
--force-create
¶
Force creation of new Actor
-
-E
<ENVS_FILE>
,
--env-file
<ENVS_FILE>
¶ Environment variables JSON file (secrets.json)
-
-R
,
--dry-run
¶
Shortcut: Only build container
-
--ignore-errors
¶
Ignore deployment errors and warnings
-
--no-build
¶
Do not build container image
-
--no-pull
¶
Do not pull source image when building
-
--no-push
¶
Do not push built container image
-
--no-create
¶
Do not create or update Tapis actor
-
--no-cache
¶
Do not cache the Tapis actor identifer
-
--no-grant
¶
Do not grant actor permissions
Replaces legacy CLI command “abaco deploy”
Workers¶
View and manage an Actor’s workers, which control the extent to which the Actor can scale to accomodate additional concurrent messages.
actors workers create¶
Add Workers to the specified Actor
tapis actors workers create ACTOR_ID INT
-
ACTOR_ID
¶
Actor identifier
-
INT
¶
The number of workers to ensure are running; Note:Only Admins are authorized to update workers
Replaces legacy CLI command “abaco workers”
actors workers delete¶
Delete a Worker
tapis actors workers delete ACTOR_ID WORKER_ID
-
ACTOR_ID
¶
Actor identifier
-
WORKER_ID
¶
Worker identifier
actors workers list¶
List Workers for an Actor
tapis actors workers list
[--sort-ascending | --sort-descending]
[-Z NONCE]
[--filter GLOB]
ACTOR_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-Z
NONCE
,
--nonce
NONCE
¶ Tapis nonce
-
--filter
GLOB
¶ Filter by id
-
ACTOR_ID
¶
Actor identifier
Replaces legacy CLI command “abaco workers”
Projects¶
Create and deploy new actors from a configuration-driven template.
apps init¶
Initialize a new Tapis App project from a template
tapis apps init
[--sort-ascending | --sort-descending]
[-L]
[-R]
[-O DIRECTORY]
[-N STRING]
[--app-label STRING]
[--app-description STRING]
[--app-version N.N.N]
[--repo URL]
[--checkout COMMIT]
[--template TEMPLATE]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-L
,
--list-templates
¶
List available templates and quit
-
-R
,
--dry-run
¶
Show configuration and quit
-
-O
DIRECTORY
,
--output-dir
DIRECTORY
¶ Output directory (default: .)
-
-N
STRING
,
--app-name
STRING
¶ App name (default: new_app)
-
--app-label
STRING
¶ App human-readable label
-
--app-description
STRING
¶ One-sentence description
-
--app-version
N.N.N
¶ App semantic version
-
--repo
URL
¶ Templates repository (https://github.com/TACC-Cloud/cc-tapis-v2-app.git)
-
--checkout
COMMIT
¶ Branch/Tag/Commit (master)
-
--template
TEMPLATE
¶ Template ID (default)
Replaces legacy CLI command “apps-init”
apps deploy¶
Deploy an App from a project directory
tapis apps deploy
[--sort-ascending | --sort-descending]
[-W DIRECTORY]
[-F FILEPATH]
[--ini FILEPATH]
[-R]
[--ignore-errors]
[--no-build]
[--no-pull]
[--no-push]
[--backup]
[--no-upload]
[--no-create]
[--no-grant]
[--no-grant-roles]
[--display]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-W
DIRECTORY
¶ Working directory
-
-F
FILEPATH
,
--file
FILEPATH
¶ JSON payload file (app.json)
-
--ini
FILEPATH
¶ .ini file (project.ini)
-
-R
,
--dry-run
¶
Shortcut: Only build container
-
--ignore-errors
¶
Ignore deployment errors and warnings
-
--no-build
¶
Do not build container image
-
--no-pull
¶
Do not pull source image when building
-
--no-push
¶
Do not push built container image
-
--backup
¶
Back up deployment path if present
-
--no-upload
¶
Do not upload app assets to Tapis storage
-
--no-create
¶
Do not create a Tapis app record
-
--no-grant
¶
Do not automatically do application permission grant(s)
-
--no-grant-roles
¶
Do not automatically do system role grant(s)
-
--display
¶
Display rendered app in deployment log
Replaces legacy CLI command “apps-deploy”