Skip to main content
Use the snctl agents command group to manage Orca Agents after they are deployed. The commands cover day-two operations such as listing agents, rolling out new artifacts, restarting runtimes, and deleting resources when they are no longer needed.

Prerequisites

  • Complete the environment setup guide so snctl is authenticated against the correct organization, cluster, tenant, and namespace.
  • Ensure your service account has permissions to read, update, and delete agents in the target namespace.
  • Package the agent artifact (ZIP archive) you plan to deploy, as described in the framework-specific guides under Develop Agents.

List agents in a namespace

Run snctl agents list with the tenant and namespace that scope your deployment. The command prints a table of agents.

Inspect an agent configuration

Fetch the stored configuration to confirm topics, framework, and runtime options. Use either the tenant/namespace pair or the fully qualified agent name.
Example output (trimmed for brevity):

Update an agent

Use snctl agents update to apply new code artifacts or adjust runtime settings. Reuse the same flags you passed when creating the agent.

Deploy a new artifact

Provide the new ZIP archive with --agent-file. Include any other fields that changed (for example, updated topic bindings or secrets).

Adjust runtime settings

Pass the setting you want to change. The example below increases parallelism to scale out processing.
If the update command reports Update contains no change, verify that at least one flag carries a new value.

Control agent lifecycle

Pause or resume the agent when you need to stop processing without deleting the deployment.

Check runtime status

Retrieve the live status to confirm instance health, restart counts, and recent processing activity.
The output includes metrics for each instance. See Monitor agents for guidance on interpreting the fields.

Trigger a test request

If the agent deployed and running healthy, you can deliver an ad-hoc payload with snctl agents trigger. Supply the input topic name along with the payload that should be delivered to the agent.

Delete an agent

When the deployment is no longer required, remove it with snctl agents delete. The command supports both tenant/namespace pairs and fully qualified agent names.
Run snctl agents list again to confirm the agent no longer appears. If the delete command reports that the agent does not exist, double-check the tenant, namespace, and name values.