Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise documentation and move sections to the website #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Revise documentation and move sections to the website #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# Anteon Helm Charts

Welcome to the official [Helm chart repository](https://github.com/getanteon/anteon-helm-charts) for Anteon, formerly known as Ddosify. These charts can be used to deploy **Anteon Platform** and **eBPF agent (Alaz)** on a Kubernetes cluster.
Welcome to the official [Helm chart repository](https://github.com/getanteon/anteon-helm-charts) for Anteon!
These charts can be used to deploy **Anteon Platform** and **eBPF agent (Alaz)** on a Kubernetes cluster.

Anteon Platform consists of two main components:

- **Kubernetes Monitoring**: Easy to use, comprehensive monitoring for Kubernetes clusters with no code changes.
- **Performance Testing**: No-code user simulation to test the performance of your applications.

## Available Charts

- [Anteon Platform Self-Hosted Chart](./charts/anteon/README.md): This chart deploys the Anteon Platform on your Kubernetes cluster, providing you with powerful insights and monitoring capabilities for your applications.
- [Anteon Platform Self-Hosted Chart](https://getanteon.com/docs/helm-charts/anteon): Deploys the Anteon Platform on your Kubernetes cluster, providing powerful insights and monitoring capabilities for your applications.

- [Alaz Chart - Anteon eBPF Agent](./charts/alaz/README.md): This chart deploys the Anteon eBPF agent, Alaz, on your Kubernetes cluster. Alaz collects and sends data to the Anteon platform, enabling you to monitor the performance and health of your cluster.
- [Anteon eBPF Agent (Alaz) Chart](https://getanteon.com/docs/helm-charts/alaz): Deploys the Anteon eBPF agent, Alaz, on your Kubernetes cluster. Alaz collects and sends data to the Anteon Platform, enabling you to monitor the performance and health of your cluster.

## About Anteon

Anteon is an observability platform designed to provide comprehensive monitoring for Kubernetes clusters. With the help of eBPF technology, Anteon automatically generates a service map of your Kubernetes cluster without the need for code instrumentation or sidecars. This allows you to easily identify and address bottlenecks in your system. Anteon also provides performance testing capabilities, allowing you to simulate user traffic and test the performance of your applications.

![Anteon Kubernetes Monitoring Service Map](assets/anteon_service_map.png)
*The service map generated by Anteon. Red lines indicate potential bottlenecks.*
_The service map generated by Anteon. Red lines indicate potential bottlenecks._

For more information about each chart, please refer to the respective README files. If you have any questions or issues, feel free to open an issue on our [GitHub repository](https://github.com/getanteon/anteon-helm-charts/issues).

Expand Down
50 changes: 3 additions & 47 deletions charts/alaz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,6 @@
# Alaz Chart - Anteon eBPF Agent

[Alaz](https://github.com//alaz) is an open-source Anteon eBPF agent that can inspect and collect Kubernetes (K8s) service traffic without the need for code instrumentation, sidecars, or service restarts. This is possible due to its use of eBPF technology. Alaz can create a Service Map that helps identify golden signals and problems like high latencies, 5xx errors, zombie services, SQL queries. Additionally, it can gather system information and resources via the Prometheus Node Exporter, which is readily available on the agent.
See the [documentation](https://getanteon.com/docs/helm-charts/alaz) for more information.

To install the Alaz chart, first, you need to add the Anteon Helm repository:

```bash
helm repo add anteon https://getanteon.github.io/anteon-helm-charts/
helm repo update
```

Then, you can install the Alaz chart with the following command:
```bash
# Replace <MONITORING_ID> with your monitoring ID from the Anteon UI. Change XXXXX with your monitoring ID.
MONITORING_ID=XXXXX
# Set BACKEND_HOST with your Anteon Self-Hosted Endpoint. If your Anteon Self-Hosted endpoint is http://localhost:8014, then BACKEND_HOST=http://localhost:8014/api
BACKEND_HOST=XXXXX
helm repo add anteon https://getanteon.github.io/anteon-helm-charts/
helm repo update
kubectl create namespace anteon
helm upgrade --install --namespace anteon alaz anteon/alaz --set monitoringID=$MONITORING_ID --set backendHost=$BACKEND_HOST
```

For more installation methods, see [Alaz (Anteon eBPF Agent)](https://github.com/getanteon/alaz).

## Alaz Chart Configuration Parameters

The following table lists the configurable parameters of the Alaz chart and their default values.

| Parameter | Description | Type | Default |
| --- | --- | --- | --- |
| `monitoringID` | **CHANGE**: Monitoring ID (required). You can get it from Anteon UI, Cluster Detail Page. | string | `""` |
| `backendHost` | Backend host URL to send the collected data. Default is [Anteon Cloud](https://app.getanteon.com/). If you have Anteon Self-Hosted installed, you can give the backend URL. | string | `https://api-alaz.getanteon.com:443` |
| `namespace` | Namespace to deploy the chart | string | `anteon` |
| `logLevel` | [Zero log](https://github.com/rs/zerolog) level (0: trace, 1: debug, 2: info, 3: warn, 4: error, 5: fatal, 6: panic) | int | `1` |
| `resources.limits.cpu` | CPU limit | string | `1` |
| `resources.limits.memory` | Memory limit | string | `1Gi` |
| `resources.requests.memory` | Memory request | string | `400Mi` |
| `image` | Alaz Docker image | string | - |
| `imagePullPolicy` | Image pull policy | string | `IfNotPresent` |
| `containerPort` | Container port for debugging and profiling Alaz | int | `8181` |
| `podAnnotations` | Annotations to add to the pod | object | `{}` |
| `metricsEnabled` | Enable prometheus node exporter metrics (cpu, memory, network, disk, etc.) | bool | `true` |
| `tracingEnabled` | Enable tracing (Service Map) using eBPF | bool | `true` |
| `logsEnabled` | Enable logging | bool | `false` |
| `excludedNamespaces` | Namespaces to exclude from monitoring with regex format. For example: `"^anteon.*"` to exclude all namespaces starting with "anteon" | string | `""` |
| `criRuntimeEndpoint` | Custom CRI runtime endpoint (optional) | string | `""` |
| `sendAliveTCPConnections` | Send undetected protocol connections (unknown connections) | bool | `false` |

You can override these default values by creating a `values.yaml` file and specifying your own values or using the `--set` flag during installation.
- [Installation](https://getanteon.com/docs/helm-charts/alaz/#installation)
- [Configuration Parameters](https://getanteon.com/docs/helm-charts/alaz/#configuration-parameters)
Loading