Skip to main content
Deploy WuKongIM single node instance in Kubernetes cluster, suitable for development, testing, and small-scale production environments.

Deployment Features

Advantages:
  • High availability and strong disaster recovery capability
  • Supports online scaling
  • Real-time automatic backup between multiple replicas
  • Load balancing without manual configuration
  • Fast scaling
Applicable scenarios:
  • Applications with high data security requirements
  • Large applications
  • Environments requiring rapid deployment
Note: WuKongIM currently supports hot scaling but does not support hot shrinking!

Prerequisites

  • Kubernetes cluster 1.19+
  • kubectl configured and able to access cluster
  • Helm 3.0+
  • At least 2GB available memory and 2 CPU cores

Deployment Steps

1. Add Helm Repository

2. Update Helm Repository

3. Search Available Charts

4. Deploy WuKongIM

Optional parameters:
  • replicaCount=1: Number of replicas (default is 2)
  • externalIP=<IP_ADDRESS>: External IP address

5. Check Installation Status

6. Verify Deployment

Access Services

Port Forward Access

Access URLs

Configuration Options

Common Helm Parameters

Main Configuration Parameters

Scaling Operations

Scale to Multi-Node

Verify Scaling

Troubleshooting

Common Issues

Pod startup failure:
Service inaccessible:
Storage issues:

Log Viewing

Upgrade and Maintenance

Version Upgrade

Data Backup

Uninstall

Advanced Configuration

Custom Values File

Create a values.yaml file for custom configuration:
Deploy with custom values:

Environment Variables

Configure WuKongIM through environment variables:

Monitoring and Observability

Enable Monitoring

Health Checks

Next Steps

Multi-Node Deployment

Deploy high availability cluster

Server Configuration

Detailed configuration options

Docker Deployment

Docker deployment method

API Documentation

Start using the API