Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aurora-is-near/blockscout-vc
This is a toolchain for updating blockscout when changes to it occure
https://github.com/aurora-is-near/blockscout-vc
Last synced: 10 days ago
JSON representation
This is a toolchain for updating blockscout when changes to it occure
- Host: GitHub
- URL: https://github.com/aurora-is-near/blockscout-vc
- Owner: aurora-is-near
- Created: 2024-12-17T21:30:54.000Z (17 days ago)
- Default Branch: master
- Last Pushed: 2024-12-18T08:47:43.000Z (17 days ago)
- Last Synced: 2024-12-18T09:25:26.079Z (17 days ago)
- Language: Go
- Size: 20.5 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blockscout VC Sidecar
## Overview
The **Blockscout VC Sidecar** service monitors database changes in Supabase and automatically updates Docker container configurations and restarts services when necessary. This ensures that your Blockscout services are always running with the latest configuration. Intention is to make sure that changes made in Cloud Console are reflected in the running containers.
## Configuration File
To configure the service, use a YAML file with the following structure:
```yaml
supabaseRealtimeUrl: "wss://your-project.supabase.co/realtime/v1/websocket"
supabaseAnonKey: "your-anon-key"
pathToDockerCompose: "./config/docker-compose.yaml"
frontendServiceName: "frontend"
frontendContainerName: "frontend"
backendServiceName: "backend"
backendContainerName: "backend"
statsServiceName: "stats"
statsContainerName: "stats"
table: "silos"
chainId: 10
```
## Running the Service with Docker Compose
The service can be deployed using Docker Compose. Below is an example configuration:
```yaml
services:
sidecar:
command:
- sh
- -c
- /app/app sidecar --config /app/config/local.yaml
container_name: sidecar
image: ghcr.io/aurora-is-near/blockscout-vc:latest
restart: unless-stopped
volumes:
- ./config:/app/config
- /var/run/docker.sock:/var/run/docker.sock
- ./docker-compose.yaml:/app/config/docker-compose.yaml
```
### Important Notes
- Configuration files should be mounted in the `/app/config` directory
### Basic Commands
Start the service:
```bash
docker compose up -d
```
Restart the service:
```bash
docker compose up -d --force-recreate
```
Stop the service:
```bash
docker compose down
```
View logs:
```bash
docker logs -f blockscout-vc-sidecar
```
## Features
- Monitors Supabase database changes in real-time
- Automatically updates Docker Compose environment variables
- Restarts affected services when configuration changes
- Handles multiple service updates efficiently
- Prevents duplicate container restarts
- Validates configuration changes before applying
## Development
### Prerequisites
- Go 1.21 or later
- Docker
- Docker Compose
### Building from Source
1. Clone the repository:
```bash
git clone https://github.com/blockscout/blockscout-vc-sidecar.git
```
2. Build the binary:
```bash
go build -o blockscout-vc-sidecar
```
3. Run with configuration:
```bash
./blockscout-vc-sidecar --config config/local.yaml
```
### Project Structure
```
blockscout-vc/
├── cmd/
│ └── root.go
│ └── sidecar.go
├── internal/
│ ├── client/ # WebSocket client implementation
│ ├── config/ # Configuration handling
│ ├── docker/ # Docker operations
│ ├── handlers/ # Event handlers
│ ├── heartbeat/ # Heartbeat logic
│ └── subscription/ # Supabase subscription logic
│ └── worker/ # Worker implementation
├── config/
│ └── local.yaml # Configuration file
└── main.go
```
## Configuration Options
| Parameter | Description | Required |
|-----------|-------------|----------|
| `supabaseRealtimeUrl` | Supabase Realtime WebSocket URL | Yes |
| `supabaseAnonKey` | Supabase Anonymous Key | Yes |
| `pathToDockerCompose` | Path to the Docker Compose file | Yes |
| `frontendServiceName` | Name of the frontend service | Yes |
| `frontendContainerName` | Name of the frontend container | Yes |
| `backendServiceName` | Name of the backend service | Yes |
| `backendContainerName` | Name of the backend container | Yes |
| `statsServiceName` | Name of the stats service | Yes |
| `statsContainerName` | Name of the stats container | Yes |
| `table` | Name of the table to listen to | Yes |
| `chainId` | Chain ID to listen to | Yes |
## Debugging
Enable debug logging by setting the environment variable:
```bash
export LOG_LEVEL=debug
```
## Deployment Guide
### Release and Versioning
Releases are managed via GitHub with canonical versioning (e.g., `0.1.2`). Ensure the versioning follows semantic versioning guidelines.
To release a new version:
1. Create a release on GitHub, specifying the appropriate tag (following semantic versioning guidelines).
2. This will trigger the build and push workflows to create a new Docker image and store it in the GitHub registry.