KubeAIOPS evaluates Kubernetes system anomalies using Bayesian Network AI methodology and suggests predefined resolutions to correct misbehaviors in your Kubernetes cluster. It leverages the power of Prometheus as a central repository of metrics and anomaly evaluation rules, minimizing the burden of setting up a metric-based machine learning infrastructure for operation procedures. Argo Workflow is used to execute each evaluation and execution step.
// TODO(user): An in-depth paragraph about your project and overview of use
You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info
shows).
- Install Instances of Custom Resources:
kubectl apply -f config/samples/
- Build and push your image to the location specified by
IMG
:
make docker-build docker-push IMG=<some-registry>/kubeaiops:tag
- Deploy the controller to the cluster with the image specified by
IMG
:
make deploy IMG=<some-registry>/kubeaiops:tag
To delete the CRDs from the cluster:
make uninstall
UnDeploy the controller from the cluster:
make undeploy
// TODO(user): Add detailed information on how you would like others to contribute to this project
This project aims to follow the Kubernetes Operator pattern.
It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
- Install the CRDs into the cluster:
make install
- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run
NOTE: You can also run this in one step by running: make install run
- Download Helm chart
helm repo add kubelab https://repo.kubeaiops.com/chartrepo/lab && helm repo update
helm fetch kubelab/kubeaiops
- Edit the value.yaml file to enter your Prometheus address and email information to receive the result of anomaly resport
vim values.yaml
cd helm
- Install helm chart
helm upgrade -install km --namespace km --create-namespace . -f values.yaml
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifests
NOTE: Run make --help
for more information on all potential make
targets
More information can be found via the Kubebuilder Documentation
Copyright 2023.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.