--- title: "Install Guide" slug: "discovery-installation-guide" status: "update" updated: 2026-11-17T13:30:07Z published: 2026-11-17T13:30:07Z canonical: "help.symphonysummitai.com/discovery-installation-guide" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt > Use this file to discover all available pages before exploring further. # Install Guide ## 1. Preface This document provides instructions for deploying, configuring, validating, maintaining, and upgrading the Discovery Worker in customer environments. This guide supports administrators who manage Discovery Worker deployments. ## 2. User Persona Administrator ## 3. Overview This section covers the below aspects in this document: - [Product Overview](/apex/docs/discovery-installation-guide#_9e2910dc59e9f9b16c41db33ee1642206e49e11) - [Installation Overview](/apex/docs/discovery-installation-guide#_91a3c5571df2618e4f131f6e30849a9d1af1dac) ### 3.1 Product Overview The Discovery Worker is an application deployed in the customer environment responsible for executing discovery activities against approved target systems. It continuously polls the Discovery-Worker Gateway in the Apex application for Discovery jobs. The Gateway securely routes job requests and responses between the worker and the Temporal server; the worker does not connect to Temporal server directly. The worker submits discovery results to the Discovery ingestion API. The Admin creates discovery jobs, and Temporal server workflows orchestrate them. The worker continuously polls the Gateway for available Discovery jobs. The Gateway communicates with Temporal server on the worker’s behalf and returns available jobs to the worker. The worker performs discovery, collects data, and submits the results as Discovered Devices. ![Figure: Architecture Diagram](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/discovery-installation-guide-image-yih6c4zy.png?sv=2026-02-06&spr=https&st=2026-11-20T21%3A41%3A53Z&se=2026-11-20T22%3A41%3A53Z&sr=b&sp=r&sig=Uc%2Fo9UXFRHkgCV0VAKepeLAn48IppnroeIYiFaFhGvY%3D) Figure: Architecture Diagram ### 3.2 Installation Overview A typical deployment consists of: 1. [Install the Discovery Worker](/apex/docs/discovery-installation-guide#_280b9906a58d1eba0e223a54ee61305c8a8c777) 2. [Perform verification activities](/apex/docs/discovery-installation-guide#_af91ef0410c5639f96dae3c4ce782664deee61b) 3. [Execute test job validation](/apex/docs/discovery-installation-guide#_4dfc9422198396815493c01c06ba06ece94e930) ## 4. Deployment Architecture Overview Temporal server orchestrates all discovery jobs created from the application UI. The Discovery-Worker Gateway, which runs as part of the Apex application, securely routes job requests and responses between Temporal server and workers. A worker in the customer environment continuously polls the Gateway over the network/internet to receive jobs from Temporal server; the worker does not connect to or poll Temporal server directly. When a job is available, the Gateway returns it to the worker. Jobs can run immediately or on a schedule. For each activity, the worker connects to the approved target systems within the customer network, collects the required information. ### 4.1 Component responsibilities | Component | Responsibility | | --- | --- | | Discovery UI | Allows authorized users to create, schedule, and track discovery jobs. | | Temporal service | Orchestrates workflows, manages scheduled jobs and workflow state, and tracks retries. | | Discovery-Worker Gateway | Runs as part of the Apex application and securely routes job requests and responses between Temporal server and Discovery Workers. | | Discovery Worker | Continuously polls the Gateway for jobs from Temporal server, executes returned discovery jobs, collects target data, records operational logs, and submits results. | | Target systems | Customer-approved systems or endpoints that Discovery Workers discover. | ## 3. Readiness Checklist / Prerequisites Before installation, verify that you meet all the requirements listed below: - [Network Readiness](/apex/docs/discovery-installation-guide#_b48fe9dd95177e58531f07b34fb4a523b361e54) - [Hardware and Software Requirements](/apex/docs/discovery-installation-guide#_4b901385541ed22b61116c4ead5e21f35d7b9b7) ### 3.2 Network Readiness Run checks from the intended worker host in an elevated PowerShell session. Use the Discovery-Worker Gateway hostname and port supplied for your environment: `Resolve-DnsName <gateway-host>` Ex: Resolve-DnsName Discovery-Gateway.abc.com (do not input http/https) > [!NOTE] > Note > > Output should not contain any DNS errors. `Test-NetConnection <gateway-host> -Port <gateway-port>` Example: Test-NetConnection Discovery-API.abc.com -Port 50056 > [!NOTE] > Note > > Output should contain the below **TcpTestSucceeded : True** `Resolve-DnsName <discovery-api-host>` `Test-NetConnection <discovery-api-host> -Port <discovery-api-host-port>` > [!NOTE] > Note > > A successful TCP test confirms basic network reach. It does not prove that TLS trust, mutual TLS, API authentication, target credentials, or application-level authorization is valid. ### 3.3. Hardware and Software Requirements Size the hardware based on the number of target systems and the expected discovery workload. #### 3.3.1 Software Requirement | Item | Windows | Linux | | --- | --- | --- | | Operating system | 64-bit Windows 10/11 or Windows Server | 64-bit Linux (x86_64) with systemd | | Install rights | Run installer as Administrator | Install with root / sudo | | Extra software | None required | None required | | How it runs | Windows service | systemd service | | Installer | itam-worker-installer.exe (wizard) | itam-worker-installer with -ui cli | #### 3.3.2 Hardware Requirement | Item | Requirement | | --- | --- | | Machine type | Dedicated machine preferred (not a small shared utility host) | | Processor | Multi-core CPU (4 cores or more recommended) | | Memory (RAM) | 8 GB minimum, 16 GB recommended for large scans | | Disk space | About 2 GB free for program and logs | | Network | Stable access to the Discovery-Worker Gateway, ITAM/Discovery service, and devices to scan | #### 3.3.3 Network Access | Connection | Purpose | | --- | --- | | Worker → Discovery-Worker Gateway | Poll for Discovery jobs and receive job requests and responses routed through the Gateway | | Worker → ITAM / Discovery service | Get credentials and send results | | Worker → target devices | Discover devices on the network | #### 3.3.4 What each platform can discover | Device / method | Windows worker | Linux worker | | --- | --- | --- | | Windows devices (WMI) | Yes | No | | Linux / Unix (SSH) | Yes | Yes | | Network devices (SNMP) | Yes | Yes | | Cloud discovery | Yes | Yes | > [!NOTE] > Important > > For Windows PC/server discovery, install on Windows. - For SSH / SNMP / cloud-only discovery, use Windows or Linux. - For mixed environments that include Windows assets, plan at least one Windows worker. ## 4. Discovery Worker Installation The Discovery Worker Installation process installs and configures the Discovery Worker as a service on the server. During installation, specify the installation location, configure the worker’s connection to the Discovery-Worker Gateway and Discovery service, and define the worker’s concurrency and logging settings. The installer validates the configuration, installs the required components, and displays the installation status. To install the worker, perform the following steps: 1. Right click on the **itam-worker-installer** and run as administrator. The Worker setup displays Terms and Condition. ![Figure: Terms and Conditions](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/discovery-installation-guide-image-0w49stcw.png?sv=2026-02-06&spr=https&st=2026-11-20T21%3A41%3A53Z&se=2026-11-20T22%3A41%3A53Z&sr=b&sp=r&sig=5rCeRXhm4uqwgtdIcqRAS7SeDTOvgIJTXdZt8LT876Q%3D) Figure: Terms and Conditions 2. Accept the terms agreement and click **Next** to proceed. 3. Select **Destination Folder**. By default, the installer uses `C:\Program Files\SummitAI`. Click **Next** to proceed with the next step. ![Figure: Destination Folder](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1794912857576.png?sv=2026-02-06&spr=https&st=2026-11-20T21%3A41%3A53Z&se=2026-11-20T22%3A41%3A53Z&sr=b&sp=r&sig=F23cR4kV7z6GVoSmWPn2ll8MsKKXULhAqvzTFAX49k8%3D) Figure: Destination Folder 4. On the **Discovery Connection** screen, enter the connection settings provided for your environment. The installer writes these values to worker.config.yaml. Hover over the information icon beside a field for help, then click **Next** to proceed. | Field | Description | | --- | --- | | **Discovery Gateway URL** | Enter the address of the SummitAI Discovery Gateway that this worker connects to. Use an HTTPS URL, such as https://gateway.example.com, for a gateway published over HTTPS; this machine does not need certificates. For a local gateway, use host:port, such as 127.0.0.1:7234. The gateway must be reachable outbound from this machine. | | **Namespace** | Enter the namespace provided by SummitAI for your organization. | | **Worker identity** | Enter a unique name for this worker. The installer uses it in the Windows service name, installation folder, and log folder. | | **Discovery API URL** | Enter the base URL of the Discovery service, using http:// or https://; for example, http://host:8082 or https://host:8443. The service must be reachable outbound from this machine. | | **Ingest API key** | Enter the shared secret used to authenticate worker callbacks to the Discovery service. The value must match DISCOVERY_INGEST_API_KEY on the server. | | **Tenant ID** | Enter the ITAM tenant GUID for this worker. The installer uses it when registering the worker and as a fallback when a job does not include tenant context. | ![Figure: Connections](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1794912904309.png?sv=2026-02-06&spr=https&st=2026-11-20T21%3A41%3A53Z&se=2026-11-20T22%3A41%3A53Z&sr=b&sp=r&sig=giQsRTHRK7niz9fJCKPkNnyXh6igeafFPj5DKXgzEtM%3D) Figure: Connections 5. Review the configuration summary, select **view installation log** for the setup to save to the installation logs. Note the logs location to verify later and then click **Install**. The installation process installs the Discovery Worker on the server. If an error occurs during installation, the installer displays the corresponding error message. If the installation fails because the Discovery-Worker Gateway or Discovery API URL is unavailable or incorrect, return to the **Connections** step and update the connection details. After correcting the values, retry the installation. ![Figure: Review and Install](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1794912946047.png?sv=2026-02-06&spr=https&st=2026-11-20T21%3A41%3A53Z&se=2026-11-20T22%3A41%3A53Z&sr=b&sp=r&sig=4V7Wx2y4YueSrevT7oTNuPBb%2BygLWOUkngluemozarY%3D) Figure: Review and Install 6. Click **Finish** on the confirmation dialog box. ![Figure: Installation Success](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1794913114929.png?sv=2026-02-06&spr=https&st=2026-11-20T21%3A41%3A53Z&se=2026-11-20T22%3A41%3A53Z&sr=b&sp=r&sig=C1dk%2FPmC%2Bspd7bZac5YHM9hztKQOeegr0%2FGRJqy%2FzaI%3D) Figure: Installation Success ## 5. Post Installation Verification After installing the Discovery Worker on the server, perform the following steps to verify the installation: 1. [Verify the SummitAI folder](/apex/docs/discovery-installation-guide#_78f9018d420e978d19ec9910f34a0626aa8d108) 2. [Installation Logs](/apex/docs/discovery-installation-guide#_9a36fd18a07119c08851924614e0d78a42c0735) 3. [Service Validation](/apex/docs/discovery-installation-guide#_eeb575c1cbf2d20f5f39581b64ed8d12aff59a7) ### 5.1 Verify SummitAI folder Once the installation is complete, you will be able to see the SummitAI folder in Program Files location as mentioned below. `C:\Program Files\SummitAI` Each worker has its own installation folder beneath `C:\Program Files\SummitAI`. For example, the worker with the identity `S701_Obs` uses `C:\Program Files\SummitAI\S701_Obs`. The folder contains the worker application and the files that identify the worker, store protected settings, and control its runtime configuration. Keep the files together; removing or renaming them can prevent the service from starting or connecting to the Gateway. #### Files in the worker installation folder | File | Purpose | | --- | --- | | itam-discovery-worker.exe | Runs the Discovery Worker service. The worker polls the configured Gateway for jobs, connects to target machines as required by a job, and sends the collected discovery data to the Discovery API. | | itam-worker-uninstaller.exe | Removes the worker installation. Run it with the required administrator permissions, or uninstall the worker through **Add/Remove Programs**. | | README.txt | Provides installation-specific information and instructions for the worker. Review it when troubleshooting or checking the installed package. | | .worker-id | Stores the worker identity generated by the application and used to identify the worker during communication. Treat it as installation data; do not delete it or create a replacement manually. | | worker.secrets | Stores protected, encrypted values used for secure communication. Re-run the installer to change installer-managed secrets. | | worker.config.yaml | Stores the worker’s Gateway, Discovery API, service, logging, and capacity settings. The following sections explain each setting. | #### worker.config.yaml settings This example shows a worker installed with the identity S701_Obs. Your Gateway namespace, service endpoints, generated worker ID, and log folder depend on your environment. Use local addresses such as 127.0.0.1 only when the Gateway or Discovery API runs on the worker’s machine. ```WorkerConfig gateway:    url: "127.0.0.1:7234"    namespace: "aspen**********" discovery:    api_url: "http://127.0.0.1:8082"    # ingest_api_key and tenant_id are stored encrypted in worker.secrets. worker:    worker_id: "axxxxxxa-4xxc-4xxa-bxx0-4xxxxxxxxxx7"    identity: "S701_Obs"    service_name: "ITAMDiscoveryWorker-S701_Obs"    max_concurrent_activities: 10    max_concurrent_workflows: 2    log_level: "info"    log_dir: "C:\ProgramData\SummitAIDiscoveryService\S701_Obs" capacity:    max_scan_processes: 12    reserve_scan_processes: true    reserved_scan_processes: 4 ``` ##### Configuration reference | Setting | Example | Description | | --- | --- | --- | | gateway.url | 127.0.0.1:7234 | Gateway address and port used by the worker to receive and submit work. This example points to port 7234 on the worker’s own machine. For a Gateway on another server, use its configured address, such as gateway.example.com:7234. The worker connects to the Gateway, not directly to the Temporal server. | | gateway.namespace | aspen************** | Logical customer or environment namespace used by the Gateway. Enter the exact namespace provisioned for the deployment. | | discovery.api_url | http://127.0.0.1:8082 | Base address of the Discovery service that receives results. This example points to a service on the same machine. A remote deployment uses its configured address, such as https://discovery.example.com. | | discovery secrets | Stored in worker.secrets | The ingest API key and tenant ID do not appear as plain text in worker.config.yaml. The installer stores these values in encrypted form in worker.secrets; use the installer to change them. | | worker.worker_id | axxxxxxa-4xxc-4xxa-bxx0-4xxxxxxxxxx7 | Generated unique ID for this installation. Each worker must have its own ID; do not copy this example UUID to another installation. | | worker.identity | S701_Obs | Human-readable worker name used to distinguish the worker in the service list and installation paths. | | worker.service_name | ITAMDiscoveryWorker-S701_Obs | Windows service name for this worker. Use the installed name when checking or restarting its service. **Note**: In this example, you will view the display name of the service as **SummitAI Discovery Worker(S701_Obs)**. | | worker.max_concurrent_activities | 10 | Maximum number of activities the worker can process at the same time. Higher values can increase throughput and resource use; choose a value suitable for the host and deployment. Each available slot processes one job and sends the resulting data to the ITAM application. For example, a value of 10 allows the worker to process jobs J1 through J10 concurrently. Any other job, such as J11, remains in the queue until a processing slot becomes available. Increase the value to allow more jobs to run in parallel. Higher values, such as 100, 150, or 200, increase parallel processing but also consume more CPU and memory. Use a smaller value to optimize resource utilization and maintain stable performance. The default value is 10. | | worker.max_concurrent_workflows | 2 | Maximum number of workflows the worker can process concurrently. Choose a value suitable for the host and deployment. A workflow is a group of related tasks that performs a particular activity, such as sending a notification, parsing an email, creating a service request, or running discovery. A value of 2 allows the worker to process two workflows concurrently. If the Discovery workflow occupies one workflow slot, one slot remains available for another workflow. Default value: 2. | | worker.log_level | info | Controls the level of detail written to worker logs. info is the example operational setting. | | worker.log_dir | C:\ProgramData\SummitAIDiscoveryService\S701_Obs | Windows folder where this worker writes its logs. In the YAML value, doubled backslashes represent the path separators. | | capacity.max_scan_processes | 12 | Maximum number of scan processes available to the worker. | | capacity.reserve_scan_processes | true | Set to true to reserve scan-process capacity; set to false to disable the reservation. | | capacity.reserved_scan_processes | 4 | Number of scan processes to reserve when reserve_scan_processes is true. In this example, the worker reserves four of the maximum twelve processes. Keep this value within the configured maximum. | The installer generates or manages identity and secret values. Edit worker.config.yaml only when your administrator or deployment procedure instructs you to do so. Restart the corresponding Windows service after changing settings so the worker loads the updated configuration. ### 5.2 Installation Logs A folder **SummitAIDiscoveryService** gets created under `C:\ProgramData` or `%ProgramData%`. Verify Installation Logs in this new folder. This folder contain the following files: - **Installation Log file**: At the time of installation, if any errors/failures displays here. The details such as Tenant ID and other details. At the end it displays the success message. - **README file**: has some instructions - **Worker file**: Displays the actual worker logs, including worker startup information, Gateway polling activity for Discovery jobs, service start and stop events, connection details, the target host the worker is connecting to, and the corresponding host details. ### 5.3 Service Validation On installing the discovery worker successfully, an automatic service must start running in the server’s services. To check this, perform the following steps: 1. Navigate to services.msc. 2. Locate the service `SummiAI Discovery Worker(<Name of the worker>)`. 3. Verify that the service is running. ## 6. Restart Discovery Service When you perform any changes on the worker.config file, you must restart the service for the changes to take effect. To restart discovery service, perform the following steps: 1. Go to services.msc and locate `SummiAI Discovery Worker(<Name of the worker>)` service, then right click and select **restart**. 2. You can also select **stop** and then **start** this will restart the service. 3. The service starts automatically when the server starts and enters the Running state. ## 7. Uninstall Discovery Worker To uninstall discovery worker, run itam-discovery uninstall application with admin privileges. You can also uninstall from the Add/Remove Programs by right click and selecting **Uninstall**. Upon uninstalling verify the following: 1. Verify that the uninstaller removed the SummitAI folder from C:\Program Files. 2. Verify that the uninstaller removed the Summit Discovery Service folder from `C:\ProgramData`. 3. Open services.msc and verify that the uninstaller removed the `SummiAI Discovery Worker(<Name of the worker>)` service. ## 8. Discovery Worker Validation The Discovery Worker Validation process verifies that the installed worker can receive and process discovery jobs successfully. Create and run a test job with a defined network scope and valid WMI credentials, and then review the worker logs to confirm that the worker received the job and initiated the discovery process. Create a new job with the following settings: 1. In **Identity** step, enter the job name as “demo job”. 2. On the **Scope** Step select the **CIDR Subnet** from the **Scope Type** dropdown and enter value for **CIDR Block**. Example: “192.xx.xx.x/24” 3. Select Type as **WMI** with the following values: - Cred Name: “Demo Cred” - User Name: “ss” - Password: “*******” - WMI namespace: root > [!NOTE] > Note > > These credential will allow the worker to access the other machines to retrieve the discovery data. Click **Create** to create the credential. 1. Enter the job details and use the configured Gateway connection, then click **Create and Run** and **Create Job**. The worker continuously polls the Gateway to receive the job from Temporal server; the Gateway routes job requests and responses between them. 2. Check the logs, you can check the logs on the worker server by navigating to C:\Program Data\Summit Discovery Service and view the worker file. You must see the job “demo job” log.