Moveworks Agent

Overview

For on-premises systems, Moveworks relies on the Moveworks Agent to securely integrate your on-premises system into the Moveworks Platform. The Agent is a container based application installed on a VM or Server behind your firewall. It proxies the interaction between the Moveworks platform and your on-premises systems.

This document gives a high level overview of the architectural details related to the Moveworks Agent and explains how the Moveworks Platform and the Moveworks Agent communicate with your on-premises systems, efficiently and securely.

Secure Communications Architecture

Designed with security in mind, a typical Moveworks Agent deployment, requires no firewall changes to integrate with on-premises systems.

During installation, the Moveworks Agent connects to the Moveworks Platform over a secure HTTPS/SSL connection. All communication is done securely (HTTPS) between the Agent and the Moveworks platform.

Moveworks Agent Architecture Example (AD)

Moveworks Agent Architecture Example (AD)

Outbound Only Communication

Communication between the Agent and the Moveworks platform is always initiated out-bound only by the Agent to the Moveworks Cloud Platform. The Agent initiates communication outbound via an HTTPS request to the Moveworks platform over port 443. This allows the Agent and the Moveworks platform to mutually authenticate and establish a transport layer security (TLS) full-duplex communication channel without requiring an inbound open port on your corporate firewall. The TLS channel is encrypted using an SSL certificate to protect data in transit from unauthorized interception and disclosure. This connection is then refreshed & reauthenticated every 60 seconds.

How does it work?

The sequence diagram below depicts how the Moveworks Agent and the Moveworks platform communicates with your on-premises systems, efficiently and securely.

Moveworks Agent Sequence Diagram

Moveworks Agent Sequence Diagram

A) Moveworks Agent Service adds request to Agent Request Queue.

B) Moveworks Agent initiates outbound polling connection to the Agent Request Queue over HTTPS Port 443 — Authentication to the queue leverages OAuth token (encrypted at rest with AES-256 encryption or fetched securely from AWS Secrets Manager or Azure KeyVault). Moveworks Agent picks up request from Agent Queue.

C) The request is securely executed against On-Prem system (HTTPS over Port 443 for REST integrations and LDAPS over Port 636 for Directory integrations). Note: Active Directory leverages service account based authentication using a username and password (encrypted at rest with AES-256 encryption or fetched securely from AWS Secrets Manager or Azure KeyVault).

D) Moveworks Agent receives response from On-Prem system.

E) Response is returned to Moveworks Agent Service for further downstream processing by the Moveworks Platform.

System/Server Requirements

The Moveworks Agent runs on Linux. Recommended OS with the following requirements (which are the same as "t3.medium" if hosted in AWS or a “B2” if hosted in Azure):

  • 4 GB RAM
  • 2 CPUs
  • 30 GB of disk space

OS Requirements:

  • VM with Ubuntu 20.04 and above OR RHEL 8.0 and above.
  • Latest Version of Docker Engine or Podman must be pre-installed.

Prerequisites

Server Requirements

  • Procure server(s) matching the requirements outlined above. Note: Moveworks recommends at least 2 servers for high availability (HA).
  • Set up the Server with Docker or Podman. Note: Podman is recommended for a fully root-less implementation.
  • Recommended: If possible, Moveworks recommends that you use a separate (non-root) user for running the Moveworks Agent. This limits the granting of unintended access rights for the Agent.

Network Requirements

  • Ensure the server has proper network access to the on-premises system you intend Moveworks to connect to.
  • Ensure the server has proper network access upstream to the Moveworks Platform.
    • Note: You can run the following curl command on the server to verify connection works: curl <auth_url>. If Network connection is set up correctly, you should receive 404 page not found as the response.
    • auth_url to be used:
      • For US commercial region: https://agent.moveworks.com/api/v1/auth
      • For US GovCloud region: https://agent.moveworksgov.com/api/v1/auth
      • For EU region: https://agent.am-eu-central.moveworks.com/api/v1/auth
      • For Canada region: https://agent.am-ca-central.moveworks.com/api/v1/auth

Installation

The Moveworks Agent is a container image distributed by Moveworks with configuration/run scripts to help set up and deploy the Agent consistently. Configuration is done with a Moveworks-provided script with output to YAML file, or provided to you by your Moveworks Customer Success team.

For more details on installing, configuring, and updating the Moveworks Agent, please refer to the Moveworks Agent Installation Guide.

Secrets Management

By default, the Moveworks On-Prem Agent stores service account credentials encrypted locally on the server running your Moveworks Agent(encrypted at rest with AES-256 encryption).

The Moveworks Agent can also be configured to use externally managed secrets, with one of the following platforms:

  1. Azure Key Vault
  2. AWS Secrets Manager

With externally managed secrets, credentials are fetched securely at runtime, allowing your organization to increase security and control over credentials, or other secrets leveraged by your deployment of the Moveworks Agent.

FAQs

Q: What do I need to do in order to prepare for the Agent installation?

A: You’ll need at least two VMs with Docker installed. See the Moveworks Installation Guide. Moveworks Customer Success (CS) can help prepare these VMs.

Q: What does Moveworks do in order to install the Agent?

A: Moveworks CS guides you through the steps for installation, which consists of deploying the Agent as a Docker container image. See the Moveworks Agent Installation Guide.

Q: How does Moveworks support the Agent and its container?

A: Moveworks monitors our service performance at all times and detects any degradations that may indicate an Agent failure. In such cases, our CS team contacts you immediately to address the issue. Periodically, Moveworks CS will contact you with an updated Agent image that we can help install during a service window that you choose.

Q: What maintenance must I do to support the Agent and its container?

A: Make sure the VMs and their hosts are up and running to meet your SLA requirements. When you have an upcoming service windows that represent interruptions in any of the following, please contact Moveworks Support to avoid unnecessary alerts:

  • Active Directory (AD) downtime
  • VM or host downtime
  • Network service interruptions, that affect outbound communication or communication with AD

Q: You recommended I install the Agent on Docker CE. Does Docker CE have enterprise-grade support?

A: Docker CE also known as Docker Engine is a fully featured edition of Docker, but it does not include support from Docker, Inc.

Q: What skills does my team need to maintain the Moveworks Agent?

A: No specific Docker or container experiences is needed. Your team should be comfortable maintaining each server or VM on which an Agent container is installed, and you should be comfortable maintaining network connectivity.

Q: Do I need a container orchestrator like Kubernetes?

A: No

Q: What are the most common Agent and container issues, and how can I handle them?

A: The two most common Agent and contain issues are:

  • Running out of disk space on an Agent’s VM: Have your VM administrator allocate more disk space for the Agent VM.
  • Container cannot communicate: Have your network administrator check the network connection, static IP address whitelisting, and firewall rules.

Q: How do I monitor the Agent?

A: Moveworks monitors service performance at all times and will contact you if we suspect a degradation in Agent performance. You can also check the healthiness of the container by running docker ps or docker inspect on the server running your Moveworks Agent. Additionally, keep an eye on disk, memory, and CPU usage and file a Moveworks support ticket if an issue occurs.

Q: How do I patch the Agent?

A: Moveworks adds new bot skills (actions that can resolve issues) constantly, but these do not normally require an Agent update. Agent updates are infrequent, and Moveworks CS will inform you of any required updates.

Q: What triggers Moveworks to update my Agent, change my Agent configuration, or update my Docker version?

A: Moveworks will contact you to arrange an Agent update if we make a fix or change that affects Agent behavior. This is rare.

Q: What info does the Moveworks Agent send to Moveworks?

A: Moveworks uses the contents of the fields listed in the system's associated Access Needs documentation. This information is stored securely as explained in the Moveworks Information Security Overview.