Skip to content

Commit 6c3c374

Browse files
breardon2011ZIJ
breardon2011
and
ZIJ
authored
feat: Update CLI callback, docs for AD/Fargate (#2284)
* WIP apprunner guide * feat: aws fargate cloudfront guide * fix: remove debug changes * feat: add examples * remove other 127 references --------- Co-authored-by: Igor Zalutski <[email protected]>
1 parent b99224a commit 6c3c374

File tree

21 files changed

+1466
-8
lines changed

21 files changed

+1466
-8
lines changed

‎docs/ce/state-management/aws-apprunner-quickstart.mdx‎

Lines changed: 239 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
---
2+
title: " AWS App Runner Quickstart"
3+
---
4+
5+
## Overview
6+
7+
Deploy OpenTaco Statesman on AWS App Runner for the fastest setup. App Runner provides a managed HTTPS URL automatically — no custom domain or ACM certificate required.
8+
9+
Terraform example path: `taco/examples/aws-apprunner-quickstart`
10+
11+
## Prerequisites
12+
13+
- AWS CLI and Docker installed and logged in
14+
- Terraform >= 1.4
15+
- An existing S3 bucket and prefix for OpenTaco state
16+
- Optional: OIDC provider (e.g., Auth0)
17+
18+
## 1) Mirror image to ECR (copy/paste)
19+
20+
App Runner pulls images from ECR. Run these commands to mirror the public image (region: `us-east-1`, repo: `opentaco-statesman`):
21+
22+
```bash
23+
aws ecr create-repository --repository-name opentaco-statesman --region us-east-1
24+
25+
aws ecr get-login-password --region us-east-1 | \
26+
docker login --username AWS --password-stdin \
27+
$(aws sts get-caller-identity --query Account --output text).dkr.ecr.us-east-1.amazonaws.com
28+
29+
docker pull --platform linux/amd64 ghcr.io/diggerhq/digger/taco-statesman:latest
30+
31+
docker tag ghcr.io/diggerhq/digger/taco-statesman:latest \
32+
$(aws sts get-caller-identity --query Account --output text).dkr.ecr.us-east-1.amazonaws.com/opentaco-statesman:latest
33+
34+
docker push \
35+
$(aws sts get-caller-identity --query Account --output text).dkr.ecr.us-east-1.amazonaws.com/opentaco-statesman:latest
36+
```
37+
38+
Notes:
39+
- Terraform defaults use `ecr_repo_name = "opentaco-statesman"` and `image_tag = "latest"`, so no extra configuration is needed if you keep the commands as is.
40+
41+
## 2) Configure variables
42+
43+
Create `terraform.tfvars`:
44+
45+
```hcl
46+
aws_region = "us-east-1"
47+
bucket_name = "your-s3-bucket"
48+
bucket_prefix = "opentaco"
49+
ecr_repo_name = "opentaco-statesman"
50+
image_tag = "latest"
51+
52+
# Start with auth disabled to get the service URL first
53+
opentaco_auth_disable = true
54+
```
55+
56+
## 3) Deploy and get URL
57+
58+
```bash
59+
terraform init
60+
terraform apply -auto-approve
61+
terraform output service_url # HTTPS URL from App Runner
62+
```
63+
64+
Health check:
65+
66+
```bash
67+
curl $(terraform output -raw service_url)/readyz
68+
```
69+
70+
Expected:
71+
72+
```json
73+
{"service":"opentaco","status":"ok"}
74+
```
75+
76+
## 4) Enable SSO
77+
78+
Follow Configure SSO: ./sso for IdP setup details. Then update `terraform.tfvars` with your OIDC values and set `opentaco_public_base_url` to the `service_url`, and apply again:
79+
80+
```hcl
81+
opentaco_public_base_url = "https://xxxxxxxx.awsapprunner.com"
82+
opentaco_auth_disable = false
83+
opentaco_auth_issuer = "https://your-tenant.auth0.com/" # trailing slash required
84+
opentaco_auth_client_id = "your_client_id"
85+
opentaco_auth_client_secret = "your_client_secret"
86+
opentaco_auth_auth_url = "https://your-tenant.auth0.com/authorize"
87+
opentaco_auth_token_url = "https://your-tenant.auth0.com/oauth/token"
88+
```
89+
90+
Add the callback URL to your IdP:
91+
92+
```
93+
[SERVICE_URL]/oauth/oidc-callback
94+
```
95+
96+
## Notes
97+
98+
- No custom domain or certificate needed; App Runner manages HTTPS for you.
99+
- The service uses an IAM instance role for S3 access, so no AWS access keys are required in the container.
100+
- You can later attach a custom domain to App Runner if desired (optional).
101+
102+
## 5) Install Taco CLI
103+
104+
Use the same install steps as in the main Quickstart.
105+
106+
<Tabs>
107+
<Tab title="Linux">
108+
The first thing you'll want to do is visit our releases page [here](https://github.com/diggerhq/digger/releases?q=taco%2Fcli&expanded=true) and check the latest taco/cli release. Right now it is v0.1.7
109+
110+
```bash
111+
# For Linux AMD64 (most common)
112+
curl -L https://github.com/diggerhq/digger/releases/download/taco/cli/v0.1.7/taco-linux-amd64 -o taco
113+
chmod +x taco
114+
115+
# Move to a directory in your PATH
116+
sudo mv taco /usr/local/bin
117+
118+
# Alternative: Install to user directory (no sudo required)
119+
mkdir -p ~/.local/bin
120+
mv taco ~/.local/bin
121+
# Add to PATH in your shell profile if not already there
122+
echo 'export PATH=$HOME/.local/bin:$PATH' >> ~/.bashrc
123+
source ~/.bashrc
124+
```
125+
126+
For other architectures:
127+
```bash
128+
# For Linux ARM64
129+
curl -L https://github.com/diggerhq/digger/releases/download/taco/cli/v0.1.7/taco-linux-arm64 -o taco
130+
131+
# For Linux 386
132+
curl -L https://github.com/diggerhq/digger/releases/download/taco/cli/v0.1.7/taco-linux-386 -o taco
133+
```
134+
135+
Confirm Taco CLI is available with:
136+
137+
```bash
138+
taco --help
139+
```
140+
</Tab>
141+
<Tab title="MacOS">
142+
The first thing you'll want to do is visit our releases page [here](https://github.com/diggerhq/digger/releases?q=taco%2Fcli&expanded=true) and check the latest taco/cli release. Right now it is v0.1.7
143+
144+
We can then do:
145+
146+
```bash
147+
curl -L https://github.com/diggerhq/digger/releases/download/taco/cli/v0.1.7/taco-darwin-arm64 -o taco
148+
chmod +x taco
149+
sudo mv taco /usr/local/bin
150+
```
151+
152+
Confirm Taco CLI is available with:
153+
154+
```bash
155+
taco --help
156+
```
157+
</Tab>
158+
<Tab title="Windows (powershell)">
159+
The first thing you'll want to do is visit our releases page [here](https://github.com/diggerhq/digger/releases?q=taco%2Fcli&expanded=true) and check the latest taco/cli release. Right now it is v0.1.7
160+
161+
#### Using PowerShell (Recommended)
162+
163+
```powershell
164+
# For Windows AMD64 (most common)
165+
Invoke-WebRequest -Uri "https://github.com/diggerhq/digger/releases/download/taco/cli/v0.1.7/taco-windows-amd64.exe" -OutFile "taco.exe"
166+
167+
# Move to a directory in your PATH (create directory if needed)
168+
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\bin"
169+
Move-Item "taco.exe" "$env:USERPROFILE\bin\taco.exe"
170+
171+
# Add to PATH permanently (run as Administrator or current user)
172+
$currentPath = [Environment]::GetEnvironmentVariable("Path", "User")
173+
if ($currentPath -notlike "*$env:USERPROFILE\bin*") {
174+
[Environment]::SetEnvironmentVariable("Path", "$currentPath;$env:USERPROFILE\bin", "User")
175+
}
176+
```
177+
178+
#### Confirm Installation
179+
180+
Open a **new** Command Prompt or PowerShell window and test:
181+
182+
```cmd
183+
taco --help
184+
```
185+
</Tab>
186+
<Tab title="Windows (cmd)">
187+
The first thing you'll want to do is visit our releases page [here](https://github.com/diggerhq/digger/releases?q=taco%2Fcli&expanded=true) and check the latest taco/cli release. Right now it is v0.1.7
188+
189+
#### Using Command Prompt
190+
191+
```cmd
192+
# Download (you may need to use a browser for this step)
193+
# Save the file from: https://github.com/diggerhq/digger/releases/download/taco/cli/v0.1.7/taco-windows-amd64.exe
194+
195+
# Create a bin directory in your user profile
196+
mkdir "%USERPROFILE%\bin"
197+
198+
# Move the downloaded file
199+
move "taco-windows-amd64.exe" "%USERPROFILE%\bin\taco.exe"
200+
201+
# Add to PATH (this adds for current session only)
202+
set PATH=%PATH%;%USERPROFILE%\bin
203+
```
204+
205+
#### Confirm Installation
206+
207+
Open a **new** Command Prompt or PowerShell window and test:
208+
209+
```cmd
210+
taco --help
211+
```
212+
</Tab>
213+
<Tab title="Windows (manual)">
214+
The first thing you'll want to do is visit our releases page [here](https://github.com/diggerhq/digger/releases?q=taco%2Fcli&expanded=true) and check the latest taco/cli release. Right now it is v0.1.7
215+
#### Alternative: Manual Installation
216+
217+
1. Download `taco-windows-amd64.exe` from the [releases page](https://github.com/diggerhq/digger/releases?q=taco%2Fcli&expanded=true)
218+
2. Rename it to `taco.exe`
219+
3. Place it in a directory that's in your PATH (like `C:\Windows\System32` for system-wide access)
220+
4. Or create a `bin` folder in your user directory and add it to your PATH
221+
222+
#### Confirm Installation
223+
224+
Open a **new** Command Prompt or PowerShell window and test:
225+
226+
```cmd
227+
taco --help
228+
```
229+
</Tab>
230+
</Tabs>
231+
232+
## 6) Login with Taco
233+
234+
Set the server URL to the App Runner `service_url` and log in:
235+
236+
```bash
237+
taco setup # set the server URL to the service_url output
238+
taco login # runs the PKCE login flow
239+
```

0 commit comments

Comments
 (0)