A distributed log service with Kubernetes deployment support.

This project uses a Makefile for easy development and deployment. Here's how to get up and running:

• Go 1.23+ - For building and testing the application
• Docker - For containerizing the application
• Kubernetes cluster - For deployment (minikube, kind, or cloud cluster)
• kubectl - Configured to access your cluster
• Helm 3 - For managing Kubernetes deployments

1. Build and test the application:

   # Run tests
   make test
   
   # Compile protobuf definitions
   make compile
   
   # Build Docker image
   make build-docker

2. Set up certificates (for secure communication):

   # Generate TLS certificates
   make gencert
   
   # Set up ACL configuration
   make genacl

3. Deploy to Kubernetes:

   # Deploy the main application
   make chart
   
   # Check pod status
   make pods

4. Access your services (using the jump server):

   # Deploy jump server for port forwarding
   make jumpserver-deploy
   
   # Start port forwarding
   make jumpserver-start
   
   # Test connectivity
   make jumpserver-test

# View all available commands
make help

# Jump server specific help
make jumpserver-help

# Clean up everything
make clean-chart     # Remove Kubernetes resources
make clean-conf      # Remove local configuration

You can customize the deployment by setting environment variables:

# Deploy to different namespace
make chart NAMESPACE=production

# Use different image tag
make build-docker TAG=v1.2.3

# Custom jump server configuration
make jumpserver-start LOCAL_PORT_RPC=9400 NAMESPACE=staging

This project includes a socat-based jump server solution to address kubectl port-forward limitations, specifically the issues mentioned in:

• Kubernetes issue #72597 - Limited remote host specification
• dist-services-with-go issue #1 - Connection refused errors

1. Deploy the jump server:

   make jumpserver-deploy

2. Start port forwarding:

   make jumpserver-start

3. Test the connection:

   make jumpserver-test

4. Use your service:

   go run cmd/getservers/main.go -addr localhost:8400

The socat jump server acts as a intelligent proxy inside your Kubernetes cluster:

• gRPC Compatible: Maintains persistent connections to the leader instance
• Health Checking: Monitors backend service availability
• Protocol Bridging: Handles the complexity of inter-pod communication

# Port forwarding management
make jumpserver-start      # Start port forwarding
make jumpserver-stop       # Stop port forwarding
make jumpserver-status     # Check status

# Debugging and monitoring
make jumpserver-logs       # View jump server logs
make jumpserver-test       # Test connectivity

# Deployment
make jumpserver-deploy     # Deploy jump server
make jumpserver-help       # Show all available commands

• 8400: RPC service (connected to leader pod)
• 8401: Serf clustering (connected to leader pod)

# Use custom namespace and ports
make jumpserver-start NAMESPACE=production LOCAL_PORT_RPC=9400

# Use different release name and namespace
make jumpserver-deploy RELEASE_NAME=my-aphros NAMESPACE=production

# View help for all configuration options
make jumpserver-help

1. Connection refused errors: Check if the jump server is deployed and running

   make jumpserver-status

2. Port conflicts: Use custom ports with Makefile variables

   make jumpserver-start LOCAL_PORT_RPC=9400 LOCAL_PORT_SERF=9401

3. Service discovery issues: Use logs to check connectivity

   make jumpserver-logs

4. Clean up stuck processes:

   make jumpserver-cleanup

The jump server provides detailed logs and status information to help diagnose connectivity issues.