Versions Compared

Key

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

...

The agent uses the same distribution flow as ML model deployments.

Info

Runbook on artifacts deployment: Artifact bundle deployment - Getvisibility - Confluence (atlassian.net)

In the current implementation a bundle must be assigned to a cluster as there’s no default bundle available which could be reused for all deployments.Please contact support@getvisibility.com for help with bundle deployment

We are also in the process of revisiting the flow in order to make the release process more streamlined.

The deployed bundles are essential for two key functionalities:

...

Info

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

Info

Please contact support@getvisibility.com for details about this.Runbook on Accessing the Buckets: Synergy Support: Access Agent buckets on MinIO - Getvisibility - Confluence (atlassian.net)

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:

...

Info

Note: In case the machine doesn't have access to the internet then either the Microsoft website should be whitelisted, or the executable file of the Visual Studio need to be brought inside to that machine. Here is the download link: https://www.microsoft.com/en-us/download/details.aspx?id=48217

Installation through CLI

Pre-requisites:

...

For mass software distribution, it is recommended to use the following deployment script available . Please contact support@getvisibility.com for the script. at office-classifier/win-deployment-script.bat at master · GetVisibility/office-classifier (github.com)

Actions Performed by the Script:

...

  • 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).

...