Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When you run `miren deploy`, Miren:
2. **Detects and builds on the server** — the server inspects your source code to detect the [language, framework](/guides), and [services](/services), then builds a container image using the detected stack (or your Dockerfile)
3. **Activates the new version** — rolls out the new version, replacing the previous one

Every deployment is tracked with a unique version ID, its current status, and the git commit it came from. You can inspect, roll back, or redeploy any previous version at any time.
Each deployment is a tracked object with its own ID, a status, and the git commit it came from. A successful deployment produces a new version (identified by a version ID); a failed one produces no version but stays in history as a record of the attempt. You can inspect, roll back, or redeploy any previous version at any time.
Comment thread
maryelizbeth marked this conversation as resolved.

## Deploying from a Project Directory

Expand Down
10 changes: 8 additions & 2 deletions docs/docs/terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ The [route](#route) automatically assigned to an app when it is first deployed.

## Deployment

A specific version of your app that has been built and deployed. Each deployment creates a new container image and can be rolled back if needed.
An attempt to build and release a specific [version](#version) of your app. Running `miren deploy` starts a deployment, which gets its own ID. A successful deployment produces a new [version](#version); a failed deployment produces no version but remains as a record of what was attempted and why it failed. A [rollback](#rollback) is a deployment that re-releases an existing version without building a new one.

A deployment and the version it produces are distinct objects: the deployment is the action, and the version is the resulting artifact.

## Disk

Expand Down Expand Up @@ -112,6 +114,10 @@ A simple file format for defining [services](#service) in your app. Each line ma

Maps a hostname to an application. Routes determine how HTTP traffic reaches your apps. Your first app gets a [default route](#default-route) automatically. See [Traffic Routing](/traffic-routing).

## Rollback

A type of [deployment](#deployment) that re-releases a previously built [version](#version) instead of building a new one. Because the container image already exists, a rollback skips the [build](#build) step and re-releases the target version as-is.

## Route Protection

Authentication at the routing layer using an [identity provider](#identity-provider). Unauthenticated requests are redirected to an OIDC provider for login. After authentication, JWT claims are injected as HTTP headers (e.g., `X-User-Email`) before the request reaches your app — no in-app auth code required. See [Protecting Routes](/route-protect).
Expand Down Expand Up @@ -142,7 +148,7 @@ Time to live — the expiration timer for an [ephemeral version](#ephemeral-vers

## Version

A unique identifier for a specific build of your app (e.g., `myapp-vCVkjR6u7744AsMebwMjGU`). Each [deployment](#deployment) creates a new version, which tracks the container image, git commit, and configuration. Previous versions can be rolled back to without rebuilding.
A unique identifier for a specific build of your app (e.g., `myapp-vCVkjR6u7744AsMebwMjGU`). Each successful [deployment](#deployment) creates a new version, which tracks the container image, git commit, and configuration. Previous versions can be rolled back to without rebuilding — see [rollback](#rollback).

## WAF

Expand Down
Loading