Skip to main content

Cyware Orchestrate

Install Cyware Agent

After you have ensured that you meet the prerequisites to install Cyware Agent, follow the steps to install Cyware Agent on your machine:

  1. Open a command prompt and run the following command to download the configure.sh file.

    wget https://packages.cyware.com/repository/cyware/soar/configure.sh

    Note

    If wget is not installed, then run the following command to install wget:

    sudo yum install wget

  2. To install Cyware Agent for a specific Orchestrate app version, run the following command:

    bash configure.sh MOUNT_DIRECTORY=<new-mount-directory> IMAGE=<image-url> DOCKER_NAME=<docker-name> MODE=<execution-mode>

    Parameter

    Description

    Required/Optional

    Comments

    MOUNT_DIRECTORY

    Enter the directory to mount Cyware Agent.

    Example:

    /apps/cyware/cyware_agent

    Optional

    Default value: 

    /apps/cyware/cyware_agent

    IMAGE

    Enter the URL to download Cyware Agent for a specific Orchestrate version.

    Example:

    prod.packages.cyware.com/co/code-engine:co-release-3.3.1.0

    Required

    Image URL format:

    prod.packages.cyware.com/co/code-engine:co-release-<cyware orchestrate version>

    DOCKER_NAME

    Enter the Cyware Agent Docker name.

    Example:

    cyagent-3510

    Optional

    Default:

    cyware_agent

    MODE

    Enter the mode of execution for the configure.sh file.

    Example:

    install

    Required

    Allowed values for installation:

    • install: This is the default installation mode. This mode follows the normal installation path. Use this mode to install Cyware Agent without any custom certificate.

    • install-with-custom-certs: Use this mode to install Cyware Agent with a custom CA certificate. Before using this mode, ensure that you have stored a valid certificate on the host system. For more information, see Prerequisites.

    If you do not include the MODE parameter or try to run the command in an unsupported execution mode, the Cyware Agent help is displayed and provides the details of the supported execution modes.

    Examples:

    • To install the Cyware Agent version associated with the Orchestrate version 3.3.1.0, run the following command:

      bash configure.sh MOUNT_DIRECTORY=/apps/cyware/cyware_agent IMAGE=prod.packages.cyware.com/co/code-engine:co-release-3.3.1.0 DOCKER_NAME="cyagent-3510" MODE=install

    • To install the Cyware Agent with custom CA certificates, run the following command:

      bash configure.sh MOUNT_DIRECTORY=/apps/cyware/cyware_agent IMAGE=prod.packages.cyware.com/co/code-engine:co-release-3.3.1.0 DOCKER_NAME="cyagent-3510" MODE=install-with-custom-certs

  3. Select a product to which you want to connect Cyware Agent. Enter 1 for Orchestrate and enter 2 for CTIX

    Product_Choice.png

  4. To configure a proxy server for Cyware Agent, choose Yes and enter the required details. The default value is No.

    Configure_Proxy_step.png

    Proxy is used to secure a connection between the Cyware agent and a Orchestrate instance. You can configure a proxy so that all the network requests from on-premise machines are forwarded to a proxy server. This helps in enhancing the security of on-premises resources.

    • http proxy: Enter the URL of the HTTP proxy server through which the connection requests need to go before accessing the required resource. HTTP proxies do not validate the certificate of the server and are less secure. For example, http://proxy.example.com:80

    • https proxy: Enter the URL of the HTTPS (HTTP over SSL) proxy server through which the connection requests need to go before accessing the required resource. HTTPS proxies validate the certificate of the server and allow secure and anonymous connections. For example, http://proxy.example.com:80

    • no proxy: Enter the IP addresses or URLs that do not need to go through the proxy server before accessing the required resource. For example, localhost or 127.0.0.1

  5. Enter the Base URL (API URL) to access a Orchestrate instance. You can find the base URL in the OpenAPI credentials which you downloaded earlier as a Prerequisites. For example, https://<top_level_domain>/soarapi/openapi/

    Add_baseURL.png

  6. Enter the Access ID and Secret key. You can find the Access ID and Secret key in the OpenAPI credentials which you downloaded earlier as a Prerequisites.

    access_key_secret_key.png

    Note

    Once the Cyware Agent is installed, it will be associated with the Workspace that was connected with the Open API credentials used during the setup process.

  7. Choose to configure Cyware Agent for High Availability (HA). The default value is n (no). For more information on the High Availability of Cyware Agents, see Enable High Availability for Cyware Agents.

    Cyware_Agent_HA_Command.png

    • If you are installing Cyware Agent for the first time, then enter n or press enter to skip the Configure Cyware Agent HA prompt.

    • If you need to configure Cyware Agent for high availability, then enter y to Configure Cyware Agent HA and enter the Cyware Agent ID of the Agent you have already installed. To retrieve the Cyware Agent ID of the installed Cyware Agent, in Orchestrate, navigate to Admin Panel > Cyware Agent and select the required Cyware Agent to retrieve the Agent ID.

    Note

    • You can configure the Cyware Agent for high availability only if you are installing the Cyware Agent from the second time and onwards.

    • If you are performing the Agent installation process for the second time and onwards to configure a Cyware Agent for High Availability, then you do not need to specify the polling schedule, identification name of Cyware Agent, and path of the log directory.

  8. Enter the number of tasks to be polled in the range of 1 to 100. The default value is 10

    Note

    • The process of a Cyware Agent connecting to a parent product to fetch information is called Polling.

    • Tasks indicate the maximum number of tasks that the Orchestrate instance can request the Agent to execute in one poll.

    • Admins receive timely updates of Cyware Agent polling errors via email notifications. This helps admins to stay up-to-date on Cyware Agent failures and troubleshoot instantly.

  9. Enter the polling schedule in cron format. The minimum polling schedule is 1 minute. The default value of the polling schedule is 5 minutes. There is no upper limit for the maximum polling schedule. However, it is not recommended to keep longer schedules as it will affect the performance of the Cyware Agent. For more information on cron expressions, see Working with Cron Expressions.

  10. Polling_Schedule.png

    Enter the identification name for the Cyware agent. This Cyware Agent name will help in identifying the name in the Orchestrate instance. For example, Cyware Agent Installation Demo.

    CSOL_Agent_Name.png

  11. You have now successfully installed Cyware Agent. As a confirmation, the terminal will display the unique ID of the Cyware Agent. The container ID may look like 148cfd9490bf1dc14248f14c1681087a57721ffcb4750da393a2e6b082c993a9.

    You can view the details of the installed Cyware Agent in Orchestrate under Admin Panel > Cyware Agent. For more information, see View Cyware Agent Details. The identification name provided for the agent is shown as the Agent ID.

    Note

    Your Cyware Agent logs are stored in the specified location. By default, the log directory is /var/log. The log directory stores the application.log and error.log files.

  12. To verify the installation, use the below command.

    docker ps | grep agent

    This displays the identification name of the installed Cyware Agent.

    Agent_Successful_Installation.png