Running the Agent
Last updated
Last updated
Zirkul Agent can be used for several tasks including:
Stand alone tool: for security tasks such as manually running scans or commands taking advantage fo the plugins available.
Webhook Trigger: for starting CICD jobs.
Service mode: for running as a system service within your infrastructure for executing Jobs created for CICD pipelines.
Zirkul Agent was initially designed as a command line tool for security automation, you can simply run zirkul from terminal for starting the interactive command line interface:
See more in Command Line Interface
You can use the Agent for calling webhooks used for starting Jobs in Zirkul Server:
Where:
<api_key> is the API Key created in Zirkul Server.
<token> is the webhook token id assigned to the Job you want to run. see Creating Jobs
<agent_key> is the Agent name or key you want to assign.
Note:
--server is optional, the default value is 'https://app.zirkul.com'
--webhook is required for calling a web hook.
--apikey is required for calling a web hook.
--agent is required for calling a web hook.
--wait is optional, use this if you want the agent to wait until the Job is completed.
Service mode is used for running the agent as system service that will continue running continuously waiting for Jobs to be executed.
Where:
<api_key> is the API Key created in Zirkul Server.
<agent_key> is the Agent name or key you want to assign.
Note:
--server is optional, the default value is 'https://app.zirkul.com'
--service is required for running in service mode.
--apikey is required for running in service mode.
--agent is required for running in service mode.
