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 content/automation/deploy-from-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ for the build inputs and examples.
| `dockerfile` | no | Path to the Dockerfile |
| `buildArgs` | no | Docker build args, one `KEY=VALUE` per line |
| `port` | no | Port the container listens on (default `8080`) |
| `type` | no | [Deployment type](/deployments/types/) — `WebService` (default), `Worker`, `TCPService`, `InternalTCPService` |
| `type` | no | [Deployment type](/deployments/types/) — `WebService` (default), `Worker`, `InternalTCPService` |
| `protocol` | no | WebService protocol — `http` (default), `https`, or `h2c` |
| `env` | no | Environment variables, one `KEY=VALUE` per line |
| `envGroups` | no | [Env groups](/deployments/environment-variables/) to attach, one per line or comma-separated |
Expand Down
4 changes: 2 additions & 2 deletions content/automation/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ deploy can pass just `image` and leave the rest as configured.
| `location` | yes | Location ID (e.g. `gke.cluster-rcf2`) |
| `name` | yes | Deployment name |
| `image` | for containers | Container image with tag or digest |
| `type` | no | [Deployment type](/deployments/types/) — `WebService`, `Worker`, `CronJob`, `TCPService`, `InternalTCPService`, `Static` |
| `type` | no | [Deployment type](/deployments/types/) — `WebService`, `Worker`, `CronJob`, `InternalTCPService`, `Static` |
| `site` | for `Static` | Static release reference (`site://…@<sha>`); leave `image` empty |
| `siteManifestDigest` | no | Manifest digest for the static release |

**Networking and scaling:**

| Input | Description |
|---|---|
| `port` | Port the container listens on (`WebService`/`TCPService`) |
| `port` | Port the container listens on (`WebService`/`InternalTCPService`) |
| `protocol` | WebService protocol — `http`, `https`, or `h2c` |
| `internal` | Run a WebService as internal-only (`true`/`false`) |
| `minReplicas` / `maxReplicas` | Autoscale bounds (0–20) |
Expand Down
2 changes: 1 addition & 1 deletion content/deployments/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ linkTitle: 'Deployments'
weight: 2
icon: 'box'
description: 'Configure, ship, observe, and roll back the workloads that run your code.'
lead: 'A deployment is a workload you run — a web service, static site, worker, scheduled job, or TCP service. This section covers how to configure them, control who can reach them, watch them, and recover from bad releases.'
lead: 'A deployment is a workload you run — a web service, static site, worker, scheduled job, or internal TCP service. This section covers how to configure them, control who can reach them, watch them, and recover from bad releases.'
---
2 changes: 1 addition & 1 deletion content/deployments/access.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ It applies to the web-facing types only:
- **[Static site](/deployments/static-sites/)** — gates the site (with a
[caching trade-off](#the-static-caching-trade-off)).

Workers, cron jobs, and TCP services have no public HTTP URL, so access control
Workers, cron jobs, and internal TCP services have no public HTTP URL, so access control
doesn't apply to them.

## Who gets in
Expand Down
2 changes: 1 addition & 1 deletion content/deployments/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ If the image is in a private third-party registry, attach a

`type` decides what shape the deployment takes — see
[Deployment types](/deployments/types/) for the full list of strings. The other
three only apply to web services and TCP services:
three only apply to web services and internal TCP services:

- **`port`** — the container port your app listens on (e.g. `8080`).
- **`protocol`** — for `WebService` only. One of `http`, `https`, or `h2c`
Expand Down
20 changes: 7 additions & 13 deletions content/deployments/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: 'Deployment types'
linkTitle: 'Types'
weight: 2
description: 'Web services, static sites, workers, scheduled jobs, and TCP services — and when to use each.'
lead: 'Deploys.app runs six kinds of workloads. The type you pick decides whether the platform gives you a public URL, opens a TCP port, runs you on a cron schedule, serves prebuilt files from the edge, or just keeps you running quietly in the background.'
description: 'Web services, static sites, workers, scheduled jobs, and internal TCP services — and when to use each.'
lead: 'Deploys.app runs five kinds of workloads. The type you pick decides whether the platform gives you a public URL, opens an in-cluster TCP port, runs you on a cron schedule, serves prebuilt files from the edge, or just keeps you running quietly in the background.'
---

## At a glance
Expand All @@ -14,7 +14,6 @@ lead: 'Deploys.app runs six kinds of workloads. The type you pick decides whethe
| **Static site** | `Static` | HTTPS on a managed hostname | None — served from object storage | Prebuilt static sites (SPAs, docs, marketing) |
| **Worker** | `Worker` | None | Autoscales between replica bounds | Background processors, queue consumers |
| **Cron job** | `CronJob` | None | Cron schedule, exits when done | Periodic tasks (cleanup, sync, snapshot) |
| **TCP service** | `TCPService` | Raw TCP on an external port | Autoscales between replica bounds | Non-HTTP protocols you need exposed |
| **Internal TCP service** | `InternalTCPService` | TCP inside the cluster only | Autoscales between replica bounds | Databases, caches, and other in-cluster traffic |

## Web service
Expand Down Expand Up @@ -85,18 +84,13 @@ Need a job that runs once and exits — not on a schedule? Use a Worker with a
auto-deletes it after the duration you set.
{{< /callout >}}

## TCP service

Use for protocols that aren't HTTP — game servers, custom binary protocols.
You pick the port; the platform exposes it on an external load balancer.
[Routes](/networking/routes/) don't apply (those are HTTP-only); clients
connect directly to the service's address.

## Internal TCP service

Same as TCP service, but reachable only from inside your project's cluster
(other deployments in the same location). Useful for self-hosting datastores
that should never be exposed publicly.
Raw TCP for protocols that aren't HTTP, reachable only from inside your project's
cluster (other deployments in the same location). You pick the port; clients
connect directly to the service's in-cluster address. [Routes](/networking/routes/)
don't apply (those are HTTP-only). Useful for self-hosting datastores that should
never be exposed publicly.

```bash
deploys deployment deploy \
Expand Down
2 changes: 1 addition & 1 deletion content/getting-started/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ which can span multiple projects.
|---|---|---|
| **Project** | A workspace that owns all your resources | — |
| **Location** | A managed cluster you can deploy to (e.g. `gke.cluster-rcf2`) | — |
| **Deployment** | A running workload — web service, worker, cron job, or TCP service | Project + Location |
| **Deployment** | A running workload — web service, worker, cron job, or internal TCP service | Project + Location |
| **Revision** | A historical snapshot of a deployment, kept for rollbacks | Deployment |
| **Domain** | A custom hostname attached to your project | Project + Location |
| **Route** | A `(domain, path)` → deployment mapping | Project + Location |
Expand Down
2 changes: 1 addition & 1 deletion content/getting-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ inherits that location's domain suffix.
| **Web service** | Internet-facing HTTP apps and APIs, with autoscaling and a managed hostname. |
| **Worker** | Long-running background processes with no inbound traffic. |
| **Scheduled job** | Cron-style tasks that run on a schedule and exit. |
| **TCP service** | Non-HTTP protocols, exposed internally or externally. |
| **Internal TCP service** | Non-HTTP protocols, reachable from inside your cluster. |

See [Deployment types](/deployments/types/) for the full breakdown.

Expand Down