Operator guide for Valet Dedicated 0.10.1
Valet Dedicated: Overview
Valet Dedicated runs the whole Valet platform in your own AWS account. Your people build and run agents, sites, and apps in it. Your data stays in your account, and the installation serves its hosts only inside your network.
This guide covers what works today: preparing, installing, upgrading, and restoring one installation. It names only commands and settings that exist.
What you receive
A release is a set of files that Valet publishes to a release bucket. Your AWS account reads it once Valet grants access.
module.tar.gz
- What it is
- The Terraform module that builds the installation
valet-dedicated-<os>-<arch>.tar.gz
- What it is
- The operator tool, for darwin or linux on arm64 or amd64
manifest.json
- What it is
- The size and SHA-256 of every file, and the release's images
egress.json
- What it is
- Every outbound host the installation contacts, by process. See Outbound endpoints
notes.md
- What it is
- What changed in the release
The release also names the container images that valet-dedicated upgrade copies into your account. This guide also ships inside the module
archive, so it always matches the release you installed.
What the installation is
The Terraform module builds the infrastructure and leaves it empty. It creates the database, buckets, secrets, clusters, a load balancer, DNS, and IAM. It starts no service.
The valet-dedicated tool then fills the secrets, copies the images,
migrates the database, and starts the services. Terraform never runs the
tool, and the tool never runs Terraform. You run each one yourself.
The load balancer is internal. The installation's hosts resolve and answer only inside your VPC, or over a network path you provide to it.
Who does what
AWS account
- You
- Create it and send its 12-digit ID
- Valet
- Grants it access to the releases
Sign-in
- You
- Connect your identity provider and verify your domains in the Admin Portal, create the WorkOS API key, and enter it at the first upgrade
- Valet
- Creates and configures the WorkOS environment, and sends the Admin Portal link, the client ID, and the AuthKit domain
VPC and DNS
- You
- Provide the VPC and the public DNS zone
- Valet
- None
Install
- You
- Run Terraform and
valet-dedicated upgrade - Valet
- Publishes the release
Upgrade
- You
- Choose when to move to a new release
- Valet
- Publishes new releases
No AWS credential or secret crosses between you and Valet. You send an account ID. Valet publishes releases that the account can read. You create the WorkOS API key yourself.
Read Operations to inventory, suspend, and resume services.
The path
- Prepare: the account, the network, DNS, WorkOS, an Anthropic key, and the tool.
- Install: fetch a release, apply the module, run the first upgrade, and sign in.
- Connect your people: network access, sign-in, and the tools your people use.
- Limits and known gaps: what does not work yet.
- Upgrade: move an installation to a new release.
- Observe: alarms, logs, and load balancer access logs.
- App database: the PostgreSQL database apps can use.
- Audit log: every field of an audit event, and how to read or forward the log.
- Cost and sizing: what an installation costs, as estimates.
- How WorkOS works: who runs sign-in and how to ask for a change.
- Troubleshoot: failed checks and upgrades, sign-in, certificates, the upgrade lock, and ECS Exec.
- Restore: put the database and the source repositories back as they were at an earlier time.
- Private systems: let apps reach a database or service inside your network.
- Reference: every command, flag, and module input.
- Get help: how to reach Valet and what to send.