Skip to content

Commit d5fc516

Browse files
authored
Retiring things (#521)
* chore: deprecate apps * chore: deprecate nginx files * chore: remove deprecated gateway dependency from yarn.lock and update typescript versions * chore: remove deprecated gateway files and update deployment guide to reflect changes in target machine tags and environment setup * docs: add deprecated Multinetwork Gateway section to deployment guide, outlining its features and usage * docs: update Multinetwork Gateway section to reflect its retirement and improve environment tag reference formatting in the deployment guide
1 parent 64e4fe0 commit d5fc516

20 files changed

+32
-1635
lines changed

DEPLOYMENT_GUIDE.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,35 @@ This guide provides comprehensive instructions for managing deployments of the A
2121
The Auto Drive system consists of two main components:
2222

2323
1. **Auto Drive Services**: Main storage and data access layer services
24-
2. **Multinetwork Gateway**: Connects and manages multiple networks
2524

2625
## Target Machine Tags
2726

2827
### Auto Drive Services
2928

3029
#### Production Environments
30+
3131
- **`auto_drive_mainnet_private`**: Private mainnet deployment for internal services
3232
- **`auto_drive_mainnet_public`**: Public mainnet deployment for external access
3333
- **`auto_drive_taurus_private`**: Private taurus testnet deployment
3434
- **`auto_drive_taurus_public`**: Public taurus testnet deployment
3535

3636
#### Staging Environments
37+
3738
- **`auto_drive_mainnet_staging`**: Staging environment for mainnet testing
3839
- **`auto_drive_taurus_staging`**: Staging environment for taurus testing
3940

40-
#### Gateway Services
41-
- **`auto_drive_multinetwork_gateway`**: Unified gateway connecting multiple networks
42-
4341
## Prerequisites
4442

4543
### System Requirements
44+
4645
- **Ansible**: Version 2.9 or later
4746
- **Docker**: Installed on target machines
4847
- **Docker Compose**: Version 2.0 or later
4948
- **Infisical CLI**: For secrets management
5049
- **SSH Access**: To all target machines
5150

5251
### Dependencies Installation
52+
5353
```bash
5454
# Install Ansible
5555
pip install ansible
@@ -60,13 +60,14 @@ ansible-galaxy collection install community.general
6060
```
6161

6262
### Target Machine Setup
63+
6364
All target machines must have:
65+
6466
- Docker and Docker Compose installed
6567
- SSH access configured
6668
- Infisical CLI installed (automatically handled by setup playbook)
6769
- Deployment directories created:
6870
- `~/deploy/auto-drive/`
69-
- `~/deploy/auto-drive/gateway/`
7071
- `~/env-archives/`
7172

7273
## Environment Setup
@@ -80,7 +81,6 @@ Create an `environment.yaml` file in the `ansible/` directory:
8081
infisical_client_id: "your-client-id"
8182
infisical_token: "your-client-secret"
8283
infisical_project_id: "your-project-id"
83-
8484
# Additional environment-specific variables
8585
```
8686

@@ -93,6 +93,7 @@ The `hosts.ini` file is already created in the `ansible/` directory with all tar
9393
3. **Adjust hostnames** to match your infrastructure
9494

9595
Example configuration:
96+
9697
```ini
9798
[auto_drive_mainnet_private]
9899
user@mainnet-private-1
@@ -106,6 +107,7 @@ user@mainnet-public-2
106107
The format is `user@hostname` or `user@ip-address` for each host entry.
107108

108109
The inventory includes:
110+
109111
- **Individual target machine groups** for each service
110112
- **Logical groupings** (production, staging, mainnet, taurus)
111113
- **Environment-specific variables** for each group
@@ -164,17 +166,7 @@ ansible-playbook auto-drive-deployment.yml \
164166
-e "image_tag=staging-latest"
165167
```
166168

167-
### 3. Multinetwork Gateway Deployment
168-
169-
Deploy the multinetwork gateway:
170-
171-
```bash
172-
# Deploy multinetwork gateway
173-
ansible-playbook auto-drive-multinetwork-gateway.yml \
174-
-e "image_tag=gateway-v1.0.0"
175-
```
176-
177-
### 4. Batch Deployments
169+
### 3. Batch Deployments
178170

179171
Deploy to multiple environments simultaneously:
180172

@@ -190,7 +182,7 @@ ansible-playbook auto-drive-deployment.yml \
190182
-e "image_tag=v1.2.3"
191183
```
192184

193-
### 5. Group-Based Deployments
185+
### 4. Group-Based Deployments
194186

195187
Use the logical groupings defined in the inventory:
196188

@@ -239,7 +231,7 @@ Services are organized into profiles:
239231
- **download**: Download-related services (API, Worker)
240232
- **rabbit**: RabbitMQ message queue
241233

242-
### Multinetwork Gateway
234+
### Multinetwork Gateway (retired)
243235

244236
The gateway service provides:
245237

@@ -258,14 +250,12 @@ The deployment uses Infisical for secrets management:
258250
2. **Secret Storage**: Environment-specific paths in Infisical
259251
3. **Configuration Paths**:
260252
- Auto Drive: `/[target_machines]` (e.g., `/auto_drive_mainnet_private`)
261-
- Gateway: `/auto_drive_multinetwork_gateway`
262253

263254
### Environment Variables
264255

265256
Key environment variables managed through Infisical:
266257

267258
- `BACKEND_IMAGE`: Docker image for backend services
268-
- `GATEWAY_IMAGE`: Docker image for gateway service
269259
- `DATABASE_URL`: Database connection string
270260
- `HASURA_GRAPHQL_ADMIN_SECRET`: Hasura admin access
271261
- `HASURA_GRAPHQL_JWT_SECRET`: JWT authentication
@@ -284,40 +274,44 @@ The deployment automatically:
284274
### Common Issues
285275

286276
1. **Infisical Authentication Failure**
277+
287278
```bash
288279
# Check Infisical credentials
289280
infisical login --method=universal-auth --client-id=YOUR_ID --client-secret=YOUR_SECRET
290-
281+
291282
# Verify project access
292283
infisical secrets --projectId YOUR_PROJECT_ID --path /auto_drive_mainnet_private --env prod
293284
```
294285

295286
2. **Docker Compose Failures**
287+
296288
```bash
297289
# Check service logs
298290
docker compose logs -f [service-name]
299-
291+
300292
# Verify image availability
301293
docker images | grep [image-name]
302-
294+
303295
# Check resource usage
304296
docker stats
305297
```
306298

307299
3. **SSH Connection Issues**
300+
308301
```bash
309302
# Test SSH connectivity
310303
ansible all -m ping
311-
304+
312305
# Check specific host
313306
ansible [hostname] -m ping
314307
```
315308

316309
4. **Environment Variable Issues**
310+
317311
```bash
318312
# Check .env file content
319313
cat ~/deploy/auto-drive/.env
320-
314+
321315
# Verify backup exists
322316
ls -la ~/env-archives/
323317
```
@@ -392,9 +386,6 @@ ansible all -m ping
392386
# Deploy to staging
393387
ansible-playbook auto-drive-deployment.yml -e "target_machines=auto_drive_mainnet_staging" -e "image_tag=staging-latest"
394388

395-
# Deploy gateway
396-
ansible-playbook auto-drive-multinetwork-gateway.yml -e "image_tag=gateway-latest"
397-
398389
# Setup new machines
399390
ansible-playbook setup-infisical.yml -e "target_machines=new_machine_group"
400391

@@ -404,16 +395,15 @@ ansible all -m shell -a "docker compose ps"
404395

405396
### Environment Tag Reference
406397

407-
| Tag | Purpose | Network | Environment |
408-
|-----|---------|---------|-------------|
409-
| `auto_drive_mainnet_private` | Private mainnet services | Mainnet | Production |
410-
| `auto_drive_mainnet_public` | Public mainnet services | Mainnet | Production |
411-
| `auto_drive_taurus_private` | Private taurus services | Taurus | Production |
412-
| `auto_drive_taurus_public` | Public taurus services | Taurus | Production |
413-
| `auto_drive_mainnet_staging` | Mainnet staging | Mainnet | Staging |
414-
| `auto_drive_taurus_staging` | Taurus staging | Taurus | Staging |
415-
| `auto_drive_multinetwork_gateway` | Multi-network gateway | Multi | Production |
398+
| Tag | Purpose | Network | Environment |
399+
| ---------------------------- | ------------------------ | ------- | ----------- |
400+
| `auto_drive_mainnet_private` | Private mainnet services | Mainnet | Production |
401+
| `auto_drive_mainnet_public` | Public mainnet services | Mainnet | Production |
402+
| `auto_drive_taurus_private` | Private taurus services | Taurus | Production |
403+
| `auto_drive_taurus_public` | Public taurus services | Taurus | Production |
404+
| `auto_drive_mainnet_staging` | Mainnet staging | Mainnet | Staging |
405+
| `auto_drive_taurus_staging` | Taurus staging | Taurus | Staging |
416406

417407
---
418408

419-
For additional support or questions, refer to the project documentation or contact the development team.
409+
For additional support or questions, refer to the project documentation or contact the development team.

Makefile

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ s3:
99
yarn s3 build
1010
frontend:
1111
yarn frontend build
12-
gateway: install
13-
yarn gateway build
1412
ui: install
1513
yarn workspace @auto-drive/ui build
1614

@@ -36,4 +34,4 @@ lint: install
3634
yarn auth lint
3735
yarn frontend lint
3836

39-
all: submodules models ui s3 frontend gateway backend
37+
all: submodules models ui s3 frontend backend

apps/gateway/Dockerfile

Lines changed: 0 additions & 24 deletions
This file was deleted.

apps/gateway/README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

apps/gateway/docker-compose.prod.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

apps/gateway/package.json

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)