Skip to content

Commit 880b4a4

Browse files
add instructions
1 parent a230e91 commit 880b4a4

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
A Kubernetes operator that runs **Devin Outposts** ("Bring Your Own Box")
44
workers on any certified Kubernetes cluster (GKE, EKS, ...).
55

6+
> **Note:** Outposts is not covered by the same support as the rest of the Devin
7+
> product. If you plan to deploy this, contact your account team for more
8+
> information.
9+
610
## Quick start
711

812
```bash
@@ -18,7 +22,26 @@ kubectl create secret generic my-pool-token --from-literal=token=<PAT>
1822
kubectl apply -f examples/outpostpool.yaml
1923
```
2024

21-
The service account needs the `Outposts` permission. A service account token looks like `cog_abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz`.
25+
The operator authenticates to the Outposts API as a **service account user**.
26+
Its token looks like `cog_abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz`.
27+
28+
## Creating a service account user
29+
30+
Outposts must be enabled on your account by Cognition first — contact your
31+
account team. Once enabled, in the Devin web app:
32+
33+
1. **Create a role** with Outposts access. Under Settings → Roles, add an
34+
Enterprise role and enable **Use outpost machine** (`UseOutpostsMachine`)
35+
under *Outpost permissions*. Also enable **Manage outpost pools**
36+
(`ManageOutpostsOrchestrator`) if this account will create/delete pools.
37+
2. **Provision the service user.** Under Settings → Devin API → *Service users*,
38+
click **Provision service user**, give it a name (e.g. `outposts-operator`),
39+
assign the role from step 1, and set an expiration.
40+
3. **Copy the token.** The `cog_...` token is shown **only once** at creation —
41+
copy it now; it can't be retrieved later. Use it as the `<SVC_ACT_TOKEN>` /
42+
`<PAT>` above.
43+
4. **Create a pool.** Under Settings → Outpost pools, click **Create pool** and
44+
note its `pool_id` for the operator config.
2245

2346
## Documentation
2447

0 commit comments

Comments
 (0)