elchi-client

Elchi Client

Elchi Client is an enterprise-level network management client that connects to remote servers via gRPC protocol to manage FRR routing, network configuration, service deployment, and monitoring operations.

🚀 Key Features

• Secure gRPC Communication: TLS-enabled client-server communication
• FRR (Free Range Routing) Management: BGP neighbor and route policy management
• Network Configuration: Netplan interface and route management
• Service Deployment: Systemd service control and monitoring
• Circuit Breaker Pattern: Automatic reconnection and failure recovery
• Performance Optimized: Load balancer and proxy workload optimizations

📋 Requirements

• Operating System: Ubuntu 24.04 LTS (minimum)
• Go: 1.21 or higher (for development)
• System: Root privileges for installation
• Network: Internet access for dependencies

🔧 Installation

Quick Installation (Recommended)

# Download and run bootstrap script
curl -fsSL https://raw.githubusercontent.com/CloudNativeWorks/elchi-client/main/elchi-install.sh | sudo bash

# For BGP/FRR support
curl -fsSL https://raw.githubusercontent.com/CloudNativeWorks/elchi-client/main/elchi-install.sh | sudo bash -s -- --enable-bgp

⚙️ Configuration

Configuration File (/etc/elchi/config.yaml)

server:
  host: "backend.elchi.io"
  port: 443
  tls: true
  insecure_skip_verify: true # Set to false when using trusted TLS certificates
  token: "your-authentication-token"
  timeout: "30s"

logging:
  level: "info"
  format: "json"
  modules:
    client: "info"
    grpc: "info"
    frr: "info"
    network: "debug"

client:
  name: "production-client-01"
  cloud: "my-cloud"
  bgp: false

🚀 Usage

Start Client Service

# Start as systemd service (recommended)
sudo systemctl start elchi-client
sudo systemctl enable elchi-client

# Check status
sudo systemctl status elchi-client

# View logs
sudo journalctl -u elchi-client -f

🐛 Troubleshooting

Common Issues

Connection Failed

# Check network connectivity
ping backend.elchi.io
telnet backend.elchi.io 443

# Verify TLS configuration
openssl s_client -connect backend.elchi.io:443

Log Analysis

Enable debug logging to investigate issues:

# Edit config.yaml
logging:
  level: "debug"
  modules:
    client: "debug"
    grpc: "debug"

# Or use environment variable
ELCHI_LOGGING_LEVEL=debug systemctl restart elchi-client

📞 Support

• Issues: GitHub Issues
• License: MIT License

🔄 Updates

The client automatically downloads the latest binary during bootstrap. For manual updates:

# Download latest release
curl -fsSL https://github.com/CloudNativeWorks/elchi-client/releases/latest/download/elchi-client -o /etc/elchi/bin/elchi-client
chmod 755 /etc/elchi/bin/elchi-client

# Restart service
sudo systemctl restart elchi-client