Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

The previous pods auto-update-server and synergy-server are deprecated.

Info

Runbook on Accessing the Buckets: Synergy Support: Access Agent buckets on MinIO - Getvisibility - Confluence (atlassian.net) /wiki/spaces/GS/pages/226754565

image-20240418-074030.png

The agent supports two types of artifact distributions:

...

This section addresses the different methods to install the GV Agent file on a single machine and across multiple machines.

Agent Generic Pre-requisites:

  • OS: Windows 10, Windows 11.

  • Processor: 2 GHz or faster, 2 cores (64-bit processor recommended).

  • Memory: 4GB RAM.

  • Hard Disk: 1GB free space.

  • Administrator Privileges: user needs admin permissions to install.

  • .NET 6 must be installed.

  • .NET Framework 4.7.2 must be installed.

  • Visual Studio 2010 Tools for Office Runtime.

  • Office Version: Office 365 subscription plans.

  • Browser: Microsoft Edge (latest version).

Installation config

The agent supports various initial agent configs which can be specified via installerConfig.json or CLI arguments: Synergy Agent: installerConfig.json and CLI config - GV-KnowledgeBase - Confluence (atlassian.net)

Manual Installation

Pre-requisites:

...

  1. Download the Agent MSI File: Obtain the MSI file and save it to the Windows machine.

  2. Prepare for Installation:

    • Ensure all Office applications are closed to guarantee a clean installation of the agent.

    • Place the installerConfig.json file (if provided by GV) in the same directory as the MSI file.

  3. Configure the Installer:

  4. Start the Installation:

    • Double-click the MSI file to launch the setup.

    • Accept the terms in the License Agreement by checking the box, then click "Install".

    • Click "Yes" when prompted to allow the app to make changes to your device.

  5. Visual Studio Tools Check:

    • During installation, if Microsoft Visual Studio Tools 2010 is not detected, a dialog box will appear.

    • Check the box and click "Install" to add the necessary tools.

  6. Complete the Installation:

    • After the installation completes, press "Finish".

...

  • Auto-update: Server URL or path - specifies the endpoint from where the agent will attempt to download updates. By default, it should be left empty, and agent will assume default values.

    • By default, the endpoint defaults to:

    • Custom URLs or paths don’t support beta releases.

    • It supports local file path - if this is the case, the full path to the directory must be provided, e.g. C:/Artifacts

    • If a custom URL is used it must be a NGINX File Server which lists the files in JSON format - configuration autoindex_format json. Example:

      Code Block
      server {
        listen 80;
        server_name auto-updater;
        access_log /var/log/access.log;
        error_log /var/log/error.log;
      
        location /static/ {
          alias /var/static/;
          autoindex on;
      	autoindex_format json;
          gzip_static on;
          expires max;
          add_header Cache-Control public;
        }
      }
  • Auto-update: regex for agent packages to include - specifies the regex which will be used for artifacts discovery. By default, it should be left empty, and agent will assume default values.

  • Auto-upate: check for updates frequency rate - how often the agent should look for updates. By default, it should be left empty, and agent will assume default values.

  • Enable beta version update - If this option is enabled and appropriate machine name entries are created, the targeted machines will attempt to fetch auto-updates from beta endpoints (https://{cluster}/static-server/static/agent/beta/) instead of stable endpoints (stable endpoint will be completely ignored by the agent).

Note

The agent only supports upgrading via auto-update. It’s not possible to downgrade using auto-update functionality.

This means removing machine from beta endpoints will not result in the agent downgrading to the previous stable version.

Information for AV Scans

Paths to Exclude for AV scans to avoid slowness during installation are as below:

Please be sure that the Getvisibility application is excluded from the below:

  • Real Time Scans

  • Scheduled Scans

  • Manual Scans

Paths and executables to be excluded:

  • C:\Program Files (x86)\GVClient\

  • C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe

  • C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe

  • C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe

  • C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe

  • C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe

  • C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe

Add the below list to the Trusted Applications

  • C:\Program Files (x86)\GVClient\

  • C:\Program Files (x86)\GVClient\\PlatformHub\GVClient.PlatformHub.Windows.exe

  • C:\Program Files (x86)\GVClient\\AgentEngine\GVClient.AgentEngine.Windows.exe

  • C:\Program Files (x86)\GVClient\\GVClient.AutoUpdateService.Windows.exe

  • C:\Program Files (x86)\GVClient\\GVClient.Classifier.Windows.exe

  • C:\Program Files (x86)\GVClient\\AgentUI\GVClient.AgentUI.exe

  • C:\Program Files (x86)\GVClient\\PlatformHub\Proxy\grpcwebproxy.exe

EOD