fbda1b4beb
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands - CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround - CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check - NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere - MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates - LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference Co-authored-by: Cursor <cursoragent@cursor.com>
263 lines
5.3 KiB
Markdown
263 lines
5.3 KiB
Markdown
# Unified Framework Usage Guide
|
|
|
|
**Last Updated:** 2026-01-31
|
|
**Document Version:** 1.0
|
|
**Status:** Active Documentation
|
|
|
|
---
|
|
|
|
**Date:** 2026-01-22
|
|
**Purpose:** Complete guide for using the 5 unified frameworks
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
Five unified frameworks consolidate 378+ scripts into parameterized, maintainable tools:
|
|
- `verify-all.sh` - Verification framework
|
|
- `list.sh` - Listing framework
|
|
- `fix-all.sh` - Fix framework
|
|
- `configure.sh` - Configuration framework
|
|
- `deploy.sh` - Deployment framework
|
|
|
|
---
|
|
|
|
## 1. verify-all.sh
|
|
|
|
### Purpose
|
|
Consolidates all verification, checking, and validation scripts.
|
|
|
|
### Usage
|
|
```bash
|
|
./scripts/verify-all.sh [component] [type] [host]
|
|
```
|
|
|
|
### Examples
|
|
```bash
|
|
# Verify all components
|
|
./scripts/verify-all.sh all
|
|
|
|
# Verify services
|
|
./scripts/verify-all.sh service status
|
|
|
|
# Verify network connectivity
|
|
./scripts/verify-all.sh network connectivity
|
|
|
|
# Verify specific container
|
|
./scripts/verify-all.sh container 5000
|
|
```
|
|
|
|
### Components
|
|
- `all` - Verify all components
|
|
- `service` - Verify services (PostgreSQL, Redis, etc.)
|
|
- `network` - Verify network configuration
|
|
- `config` - Verify configuration files
|
|
- `container` - Verify containers/VMs
|
|
- `storage` - Verify storage
|
|
- `ssl` - Verify SSL certificates
|
|
- `tunnel` - Verify Cloudflare tunnels
|
|
- `rpc` - Verify RPC nodes
|
|
- `blockscout` - Verify Blockscout explorer
|
|
|
|
---
|
|
|
|
## 2. list.sh
|
|
|
|
### Purpose
|
|
Consolidates all listing, showing, and getting scripts.
|
|
|
|
### Usage
|
|
```bash
|
|
./scripts/list.sh [type] [filter] [host]
|
|
```
|
|
|
|
### Examples
|
|
```bash
|
|
# List all
|
|
./scripts/list.sh all
|
|
|
|
# List containers
|
|
./scripts/list.sh containers
|
|
|
|
# List running containers
|
|
./scripts/list.sh containers running
|
|
|
|
# List VMs on specific host
|
|
./scripts/list.sh vms r630-01
|
|
```
|
|
|
|
### Types
|
|
- `all` - List all
|
|
- `vms` - List VMs
|
|
- `containers` - List containers
|
|
- `services` - List services
|
|
- `network` - List network configuration
|
|
- `config` - List configuration files
|
|
- `storage` - List storage
|
|
- `scripts` - List scripts
|
|
|
|
---
|
|
|
|
## 3. fix-all.sh
|
|
|
|
### Purpose
|
|
Consolidates all fix scripts into one parameterized framework.
|
|
|
|
### Usage
|
|
```bash
|
|
./scripts/fix-all.sh [issue-type] [component] [host] [--dry-run]
|
|
```
|
|
|
|
### Examples
|
|
```bash
|
|
# Fix all issues
|
|
./scripts/fix-all.sh all
|
|
|
|
# Fix service issues
|
|
./scripts/fix-all.sh service postgresql 10100
|
|
|
|
# Fix network issues (dry-run)
|
|
./scripts/fix-all.sh network all --dry-run
|
|
|
|
# Fix permissions
|
|
./scripts/fix-all.sh permissions 5000
|
|
```
|
|
|
|
### Issue Types
|
|
- `all` - Fix all issues
|
|
- `service` - Fix service issues
|
|
- `network` - Fix network issues
|
|
- `config` - Fix configuration issues
|
|
- `container` - Fix container issues
|
|
- `permissions` - Fix permission issues
|
|
- `nginx` - Fix nginx issues
|
|
- `redis` - Fix Redis issues
|
|
- `postgres` - Fix PostgreSQL issues
|
|
|
|
---
|
|
|
|
## 4. configure.sh
|
|
|
|
### Purpose
|
|
Consolidates all configuration scripts.
|
|
|
|
### Usage
|
|
```bash
|
|
./scripts/configure.sh [component] [action] [host]
|
|
```
|
|
|
|
### Examples
|
|
```bash
|
|
# Configure all
|
|
./scripts/configure.sh all setup
|
|
|
|
# Configure service
|
|
./scripts/configure.sh service postgresql setup
|
|
|
|
# Update network configuration
|
|
./scripts/configure.sh network update
|
|
|
|
# Validate SSL configuration
|
|
./scripts/configure.sh ssl validate
|
|
```
|
|
|
|
### Components
|
|
- `all` - Configure all
|
|
- `service` - Configure services
|
|
- `network` - Configure network
|
|
- `container` - Configure containers
|
|
- `ssl` - Configure SSL certificates
|
|
- `nginx` - Configure nginx
|
|
- `redis` - Configure Redis
|
|
- `postgres` - Configure PostgreSQL
|
|
|
|
### Actions
|
|
- `setup` - Initial setup (default)
|
|
- `update` - Update configuration
|
|
- `reset` - Reset to defaults
|
|
- `validate` - Validate configuration
|
|
|
|
---
|
|
|
|
## 5. deploy.sh
|
|
|
|
### Purpose
|
|
Consolidates all deployment, setup, and installation scripts.
|
|
|
|
### Usage
|
|
```bash
|
|
./scripts/deploy.sh [component] [options] [host]
|
|
```
|
|
|
|
### Examples
|
|
```bash
|
|
# Deploy all
|
|
./scripts/deploy.sh all
|
|
|
|
# Deploy service
|
|
./scripts/deploy.sh service postgresql
|
|
|
|
# Deploy container
|
|
./scripts/deploy.sh container 5000
|
|
|
|
# Phased deployment
|
|
./scripts/deploy.sh all --phase=1
|
|
```
|
|
|
|
### Components
|
|
- `all` - Deploy all
|
|
- `service` - Deploy services
|
|
- `container` - Deploy containers
|
|
- `infrastructure` - Deploy infrastructure
|
|
- `besu` - Deploy Besu nodes
|
|
- `rpc` - Deploy RPC nodes
|
|
- `validator` - Deploy validator nodes
|
|
- `blockscout` - Deploy Blockscout explorer
|
|
|
|
### Options
|
|
- `--phase=[1|2|3]` - Deploy specific phase
|
|
- `--validate` - Validate before deployment
|
|
- `--dry-run` - Show what would be deployed
|
|
|
|
---
|
|
|
|
## Utility Modules
|
|
|
|
Five utility modules provide shared functions:
|
|
- `scripts/utils/container-utils.sh` - Container helpers
|
|
- `scripts/utils/network-utils.sh` - Network helpers
|
|
- `scripts/utils/service-utils.sh` - Service helpers
|
|
- `scripts/utils/config-utils.sh` - Config helpers
|
|
- `scripts/utils/proxmox-utils.sh` - Proxmox helpers
|
|
|
|
### Usage
|
|
```bash
|
|
source "$(dirname "${BASH_SOURCE[0]}")/../utils/container-utils.sh"
|
|
container_status 5000
|
|
container_restart 5000
|
|
```
|
|
|
|
---
|
|
|
|
## Migration from Old Scripts
|
|
|
|
Old scripts have been archived to `scripts/archive/consolidated/`. Use the frameworks instead:
|
|
|
|
**Old:**
|
|
```bash
|
|
./scripts/check-container-services.sh 5000
|
|
./scripts/fix-all-blockscout-issues.sh
|
|
./scripts/list-all-vmids-complete.sh
|
|
```
|
|
|
|
**New:**
|
|
```bash
|
|
./scripts/verify-all.sh container 5000
|
|
./scripts/fix-all.sh blockscout all
|
|
./scripts/list.sh containers
|
|
```
|
|
|
|
---
|
|
|
|
**Status:** Complete usage guide for all frameworks
|