Skip to content

Prerequisites

Fill in this page before you schedule the first rollout wave. Nothing in the deployment is hard to obtain. What stalls a rollout is discovering, on the morning of the first wave, that a decision sits somewhere else in the organization, or that the person who can approve an egress entry is away. The inventory below turns that discovery into a form somebody fills in the week before.

Fill in the readiness inventory in one working session, with everyone who holds an answer in the room. The checklist then turns those answers into rows grouped by phase of work. The last section states what the rollout costs in hours.

Each answer changes something downstream. The agent answers decide which machines belong in which wave. The endpoint answers decide the install channel. The network answers decide whether the route is discovered or handed over. The identity answers decide who administers the organization. Where the answer is genuinely none, write “none” rather than nothing, so a later reader can tell an answered question from an unasked one.

ItemWhy it matters
Which agents are in use, and on which machinesThe install detects the agents present on a machine and wires each one. Knowing the set in advance tells you which machines belong in which wave. Once an agent reports, the console shows its control level
Whether any agent runs somewhere other than a personal workstationThe client is installed once per machine that runs an agent, wherever that machine sits. A build host or a shared workstation running an agent is in scope on the same terms as a laptop
ItemWhy it matters
Operating system mix and machine counts per operating systemThe client installs and runs at user scope on every supported platform, with no administrator rights. The floors are macOS 13, Windows 10 1809 or Windows Server 2019, Ubuntu 20.04 and Debian 10, or later
Processor architectures in the fleetPackages exist for macOS on Apple silicon and Intel, Linux x64 and arm64, and Windows x64. Windows on ARM64 and musl-based Linux distributions such as Alpine are not supported
The packaging or configuration channel your organization already operatesWaves 2 and 3 deliver the install through a channel that already reaches these machines. That channel also carries the wave credential from your secret store
Whether any wave machines are shared by several peopleInstall and local state are per user. Each user on a shared machine runs an install of their own
ItemWhy it matters
Proxy in the path: yes or noDecides whether the route is discovered at install or handed to it. See Network requirements
Proxy scheme: HTTP CONNECT, SOCKS5 or proxy auto-configAll three are supported. A proxy auto-config file is evaluated by the operating system on Windows and macOS. On Linux, set the route explicitly instead
Proxy authentication: none, Basic, Kerberos (Negotiate) or NTLMNone, Basic and Negotiate are supported. NTLM is not supported, by design, so an NTLM-only estate plans a Negotiate or unauthenticated path for the client before the first wave
TLS inspection: yes or no, and where the interception certificate authority livesInspection needs no bypass. The interception root belongs in the operating system trust store, or is supplied as a PEM file at install
Whether the model endpoints your agents already reach stay reachable, and are exempt from response buffering and streaming inspectionYour agents reach those endpoints exactly as before. A device that buffers a streamed response makes agent output arrive in one burst
ItemWhy it matters
The SAML 2.0 identity provider your organization usesThe console authenticates an organization through SAML 2.0. Microsoft Entra ID, Okta, PingOne and Active Directory Federation Services connect this way. Connecting it needs an administrator on both sides
Allowed email domainsAllowed domains and invitations together gate who can join the organization
Directory for owner lookup: Microsoft Entra ID, Okta, Google Workspace, PingOne or Active DirectoryA read-only lookup resolves an agent’s owner to a person. It never creates or removes users. This connection is optional
Who holds the owner and admin roles in the consoleConsole roles run owner, admin, editor, viewer. Invitees start as viewer, and identity settings need admin
ItemWhy it matters
Where the per-wave OPENLATCH_API_KEY is held, and how it reaches a machine without appearing in a scriptOne key per rollout wave, created in the console and revoked there when the wave completes. Managed installs read it from your secret store as an environment variable. It is never written into a script, a package or a command line
ItemWhy it matters
The ten wave-1 machines and their ownersWave 1 runs the developer install path. Named owners let you confirm each machine against the console’s agent record
How you will reach OpenLatch during the rolloutAgree the support route before the first wave rather than during it. See Operate

Every row names where the value comes from and the page it blocks. The four phases are independent, so the console rows and the network rows run in parallel through the same week.

#ItemWhere it comes fromBlocks
1Organization created in the consoleYour OpenLatch contact creates the organization and invites its owner. Accept the invitation from the invited address. Later sign-ins start at app.openlatch.ai with an email step whose browser check needs challenges.cloudflare.comConfigure the organization
2SAML connected and testedYour identity provider’s admin console, for the entity ID, sign-on URL, and certificate or metadata URL. Entered in the console under Settings › SAML SSOConfigure the organization
3Allowed email domains setThe same SAML settings as row 2Configure the organization
4Owner, admin, editor and viewer roles assignedThe console, under Settings › Users. Invitees start as viewerConfigure the organization
5Directory chosen for owner lookup, optionalYour directory’s admin console. The lookup is read-onlyConfigure the organization
6Audit trail retention setThe console, under Settings › Audit Trail: 90, 180, 365 or 730 days, or a custom window, with auto-purge and exportConfigure the organization
7Webhook or Slack notification channel, optionalThe console, under Settings › Notification ChannelsConfigure the organization
8Wave credential created and storedThe console, under your account’s API Keys, from a signed-in browser session. Stored in your organization’s secret storeConfigure the organization
#ItemWhere it comes fromBlocks
9Egress allowlist entry for app.openlatch.ai on TCP 443 approvedYour change process, against the table in Network requirementsDeploy the client
10The model endpoints your agents already reach stay reachable, and are exempt from response buffering and streaming inspectionYour proxy or secure web gateway configurationDeploy the client
11Proxy scheme and credential path confirmedYour proxy configuration, read against the support matrixDeploy the client
12Interception certificate authority available as a PEM file, if the operating system does not already trust itYour certificate authority’s own exportDeploy the client
#ItemWhere it comes fromBlocks
13The agents you intend to cover are installed and signed in on those machinesThe machines themselves, confirmed with the person who uses each oneDeploy the client
14Install reviewed for the managed routeThe managed route in Deploy the client. It reads OPENLATCH_API_KEY from your secret store and never carries it inlineDeploy the client
#ItemWhere it comes fromBlocks
15Wave-1 machine list with ownersYour endpoint inventory, cross-checked with the agent ownersVerify and roll out
16Developers briefed that some agents ask them to confirm the connection onceYour own rollout communication, sent before the wave startsVerify and roll out
17Support route agreed for the rolloutOperateVerify and roll out
18Rollback owner namedYour own decision: the person who can pause a wave and remove the client from a machineVerify and roll out

The client rollout runs in three waves of two weeks each. Wave 1 installs on about ten machines through the developer path. Wave 2 takes about fifty machines through the channel you already operate. Wave 3 extends to the full perimeter and ends in the decision to run it as normal operations.

Effort is front-loaded into the first week, when the organization is set up and the route is proven on one machine of each operating system in the fleet. After that, each wave repeats a procedure that already worked.

Phase of workWave 1Wave 2Wave 3Typical effort
Prepare the consoleConnect SAML, set allowed domains and audit retention, invite people, create the wave credentialRotate the wave credentialHand over the operating routineA day in the first week, then a few hours a week
Prepare the networkApprove the egress entry and confirm the proxy routeReview the managed routeNo further changeHalf a day in the first week
Prepare the machinesProve the install on one machine per operating system, then run ten machines through the developer pathCarry the install in the channel you already operate and run the waveExtend the same channel to the remaining machinesMinutes per machine after the first
Confirm and operateConfirm each installed machine appears in the console’s agent record with an ownerWeekly checkpoint and a managed-route reviewWeekly checkpoint, then the decision to run it as normal operationsA weekly checkpoint through the rollout
  • Complete the readiness inventory in one working session before the first wave is scheduled. Every blank cell is a decision somebody will make under time pressure later.
  • One egress entry is mandatory: app.openlatch.ai on TCP 443, outbound. Everything else in the path is your agents’ own traffic, which is unchanged.
  • An NTLM-only proxy estate blocks the rollout. Plan a Negotiate or unauthenticated path for the client.
  • No administrator rights are needed on a machine. Install and local state are per user, so a machine shared by several people needs an install per user.
  • One OPENLATCH_API_KEY per rollout wave, held in your secret store and revoked in the console when the wave completes. It never appears in a script, a package or a command line.