AgentKube Operator
is a Kubernetes operator that enables seamless integration with the AgentKube platform for enhanced cluster management and monitoring capabilities.
For detailed information about AgentKube and its features, visit our documentation.
- Kubernetes 1.16+
- Helm 3.x
- A valid AgentKube API key (Generate from AgentKube Dashboard)
- Kubectl access to your cluster
-
Add the AgentKube Helm repository:
helm repo add agentkube https://agentkube.github.io/helm-charts helm repo update
-
Install the operator:
helm install agentkube-operator agentkube/agentkube-operator \ -n agentkube-operator-system \ --create-namespace \ --set manager.apikey=AGENTKUBE_API_KEY \ --set manager.clusterName=CLUSTER_NAME
The following table lists the configurable parameters of the AgentKube Operator chart and their default values:
Parameter | Description | Default |
---|---|---|
manager.serverEndpoint |
AgentKube Server Endpoint | https://api.agentkube.com |
manager.apikey |
AgentKube API Key | "" |
manager.clusterName |
Cluster Name | local_cluster |
manager.readonly |
Read-Only Mode | true |
replicaCount |
Number of operator replicas | 1 |
image.repository |
Operator image repository | agentkube/agentkube-operator |
image.tag |
Operator image tag | v0.2.0 |
image.pullPolicy |
Image pull policy | IfNotPresent |
manager:
serverEndpoint: https://api.agentkube.com
apikey: your_api_key_here # Get from https://dashboard.agentkube.com/settings/manage/api-keys
clusterName: prod-cluster
readonly: false
After installation, the operator will automatically register your cluster with the AgentKube platform. You can access the metrics and management features through your AgentKube Dashboard.
For local development and testing:
kubectl port-forward -n agentkube-operator-system svc/agentkube-operator-controller 8082:8082
We welcome contributions to the AgentKube Operator Helm Charts! Here's how you can contribute:
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
- Follow the Helm best practices when modifying charts
- Update documentation as needed
- Add/update tests for new features
- Ensure backwards compatibility or document breaking changes
- Include relevant issue numbers in PRs
- Keep changes focused and atomic
For support, please:
- Check the documentation
- Open an issue in this repository
- Contact AgentKube support through official channels
This project is licensed under the Apache License - see the LICENSE file for details.