Kubernetes MCP

🚀 Kubernetes MCP Usage Documentation

Kubernetes Multi-Cluster Platform (MCP) is a console for unified management of multiple Kubernetes clusters. Users can conveniently manage and operate Kubernetes clusters distributed in different regions through this platform.

✨ Features

Resource Management

• Multi-Cluster View: View and manage all registered Kubernetes clusters in a single interface.
• Resource Monitoring: Monitor the resource usage of each cluster in real-time, including CPU, memory, storage, etc.
• Log Collection and Analysis: Collect and analyze log information in the cluster, supporting functions such as error pattern recognition and time distribution analysis.

Operational Control

• Cluster Operations: Provide basic operations such as creation, deletion, expansion, and contraction.
• Application Deployment: Support uploading and deploying YAML files for code-free application release.
• Gradual Rollout: Ensure the stable release of new versions through a step-by-step rollout.

Security Management

• Role-Based Access Control (RBAC): Implement fine-grained permission management based on RBAC.
• Authentication and Authorization: Support multiple authentication mechanisms, such as OAuth and LDAP.
• Audit Logs: Record all user operations for security auditing.

Automation

• Auto-Scaling: Automatically adjust the cluster size based on resource usage.
• Self-Healing System: Monitor the cluster health status and automatically fix issues.
• Regular Maintenance: Perform automated tasks such as system updates and patch installations.

🚀 Quick Start

1. Register and log in to the Kubernetes MCP platform.
2. Add information about your Kubernetes clusters.
3. View the status and resource usage of all clusters in the multi-cluster view.
4. Start performing basic operations on the clusters, such as deploying applications and scaling pods.

💻 Usage Examples

Resource Monitoring

• Node Metrics: Get the CPU and memory usage of each node.
• Pod Metrics: Monitor the resource consumption of specific pods.
• Overall Resource Statistics: View the overall resource usage of the entire cluster, including storage and the number of pods.

Log Analysis

• Error Pattern Recognition: Identify common error types and their occurrence frequencies.
• Time Distribution Analysis: Analyze the trend of errors over time.
• HTTP Status Code Tracking: Monitor the occurrence of different HTTP status codes.
• Performance Metrics: Track response times and resource usage statistics.

Cluster Operations

• Create a Cluster: Easily add a new Kubernetes cluster through the wizard provided by the platform.
• Delete a Cluster: Safely remove an unnecessary cluster.
• Scale Up/Down: Dynamically adjust the cluster size according to the load requirements.

📚 Documentation

Basic Operations

• List resources: Get a list of resources, supporting filtering by namespace and labels.
• Get resource: Get the YAML configuration of a specific resource by name.
• Describe resource: View the detailed description of a resource.
• Create resource: Create a new resource using a YAML file.
• Update resource: Update the configuration of an existing resource.
• Delete resource: Delete a specified resource.

Special Operations

• Get Pod logs: Get the log information of containers in a specific pod.
• List namespaces: View all namespaces in the cluster.
• List nodes: Get all nodes and their status information.

Configuration Options

Global Options

• Config file: --kubeconfig (Specify the path to the Kubernetes configuration file)
• Log level: --log-level (Log level: debug/info/warn/error)
• Log format: --log-format (Log format: console/json)

SSE Transmission Specific Options

• Port: --port (Default: 8080)
• Health check port: --health-port (Default: 8081)
• Base URL: --base-url (The URL for clients to connect to the server)
• CORS allowed origins: --allow-origins (Allowed CORS domains, separated by commas or "*" for all)

🔧 Advanced Features

Structured Tools

• GET_CLUSTER_INFO: Get cluster information and version details.
• GET_API_RESOURCES: List available API resources in the cluster.
• SEARCH_RESOURCES: Search for content in namespaces and resource types.
• EXPLAIN_RESOURCE: Get detailed information about resource structure and fields.
• APPLY_MANIFEST: Apply a YAML file to the cluster.
• VALIDATE_MANIFEST: Validate the format of a YAML file.
• DIFF_MANIFEST: Compare the differences between a YAML file and existing cluster resources.

Hint System

• KUBERNETES MCP Hints: Get hints about Kubernetes cluster management.

💻 Usage Examples

Create a New Cluster

# Use the kubectl command-line tool to create a new Kubernetes cluster
kubectl create cluster --name my-new-cluster --region us-east-1

Deploy an Application

apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:latest
        ports:
        - containerPort: 80

Scale Pods

kubectl scale deployment nginx-deployment --replicas=5

Get Logs

kubectl logs -n my-namespace pods/nginx-deployment-56789-fdcsv

Troubleshooting

Unable to Connect to the Cluster

• Check the network configuration to ensure all endpoints are reachable.
• Verify the validity of the API certificate.

Application Deployment Failure

• View event logs: kubectl describe deployment nginx-deployment
• Check the status of pods: kubectl get pods -n my-namespace

📄 Security Considerations

Access Control

• Use a strong password policy.
• Regularly review and update permission configurations.

Backup and Recovery

• Regularly back up cluster configurations and data.
• Develop a disaster recovery plan.

Further Reading

Documentation Resources

• Kubernetes Official Documentation
• MCP Platform Developer Guide

Community

• Join the Kubernetes MCP user group.
• Participate in community discussions and share your usage experiences.

Through the above content, you can comprehensively understand and master the usage methods and related functions of the Kubernetes Multi-Cluster Platform (MCP).