Deployment Guide¶
ExtraSuite is designed to be deployed as a self-hosted service on Google Cloud Platform. This guide walks you through deploying your own instance.
What You're Building¶
When you complete this guide, you'll have:
- A Cloud Run service that authenticates users and issues short-lived access tokens
- A Firestore database to store user records
- OAuth credentials so users can log in with their Google accounts
- A service account with permissions to create user-specific service accounts
┌─────────────┐ ┌─────────────────┐ ┌──────────────────┐
│ AI Agent │────▶│ ExtraSuite │────▶│ Google Cloud │
│ (Claude, │ │ Server │ │ - Firestore │
│ Codex) │◀────│ (Cloud Run) │◀────│ - IAM │
└─────────────┘ └─────────────────┘ │ - OAuth │
└──────────────────┘
Prerequisites Checklist¶
Before you begin, ensure you have:
| Requirement | Details |
|---|---|
| Google Cloud Project | A project where you have Owner or Editor role, with billing enabled |
| Google Workspace or Gmail | To test authentication after deployment |
Optional but recommended:
| Requirement | Details |
|---|---|
| gcloud CLI | Makes deployment faster. Install gcloud CLI |
| Custom domain | For a professional URL instead of the auto-generated Cloud Run URL |
Deployment Steps Overview¶
The deployment process has 8 steps:
| Step | What You'll Do | Time |
|---|---|---|
| 1 | Enable Google Cloud APIs | 2 min |
| 2 | Create a Firestore database | 2 min |
| 3 | Configure OAuth consent screen | 5 min |
| 4 | Create OAuth credentials | 3 min |
| 5 | Create a service account for ExtraSuite | 3 min |
| 6 | Store secrets securely | 3 min |
| 7 | Deploy to Cloud Run | 5 min |
| 8 | Verify the deployment | 2 min |
Docker Image¶
ExtraSuite publishes official Docker images to Google Artifact Registry:
| Tag | When to Use |
|---|---|
latest | Production deployments (latest stable release) |
v1.0.0 | Pin to a specific version |
main | Testing latest changes (may be unstable) |
Additional Resources¶
- IAM Permissions Reference - Detailed explanation of required permissions
- Operations Guide - Monitoring, troubleshooting, and maintenance
Build Your Own Implementation¶
This deployment guide is for the reference implementation using Google OAuth and Cloud Run. If you prefer to:
- Use your own authentication mechanism (SAML, SSO, LDAP)
- Apply custom access policies (specific departments, approval workflows)
- Integrate into your existing employee portal
See the Authentication API Specification for the protocol specification. You can implement the two required endpoints in any language or framework while maintaining compatibility with the ExtraSuite client library and skills.