Skip to content

Commit 3692710

Browse files
authored
docs: add resource requirements to system requirments (#2561)
Adds a section to system requirements in docs, describing the amount of CPU/memory odigos requires from the cluster / node
1 parent 28e9c80 commit 3692710

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/setup/system-requirements.mdx

+40
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,43 @@ This allows users to maintain observability on nodes that meet the requirements
2828
- [Amazon Elastic Kubernetes Service (EKS)](https://aws.amazon.com/eks/)
2929
- [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine)
3030
- [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/products/kubernetes-service)
31+
32+
## Resource Requirements
33+
34+
To achieve its functionality Odigos uses a set of Deployments and Daemonsets.
35+
36+
### Cluster
37+
38+
The following components runs as Deployment and request the following resources **(per pod)**:
39+
40+
| Component Name | Memory Request | Memory Limit | CPU Request | CPU Limit |
41+
|---------------|---------------|-------------|------------|----------|
42+
| odigos-autoscaler | 64Mi | 512Mi | 10m | 500m |
43+
| odigos-instrumentor (2 replicas) | 64Mi | 512Mi | 10m | 500m |
44+
| odigos-schedualer | 64Mi | 512Mi | 10m | 500m |
45+
| odigos-ui | 64Mi | 512Mi | 10m | 500m |
46+
47+
In addition, Odigos deploys OpenTelemetry Collector Deployment,
48+
with auto scaling (multiple replicas) and configurable resources requests and limits.
49+
The default values (unless overridden) are:
50+
51+
| Component Name | Memory Request | Memory Limit | CPU Request | CPU Limit |
52+
|---------------|---------------|-------------|------------|----------|
53+
| odigos-gateway | 300Mi | 300Mi | 150m | 300m |
54+
55+
Read more [here](/pipeline/configuration).
56+
57+
### Per Node
58+
59+
2 Daemonsets are deployed on each node in the cluster and consumes resources as follows:
60+
61+
- **odiglet** - Does not set requests and limits. it will consume resources as needed depending on the number of pods running on the node and the amount of data being recorded.
62+
- **odigos-data-collection** - cpu and memory limits and requests are set by default to:
63+
64+
| Component Name | Memory Request | Memory Limit | CPU Request | CPU Limit |
65+
|---------------|---------------|-------------|------------|----------|
66+
| odigos-data-collection | 150Mi | 300Mi | 150m | 300m |
67+
68+
You can override these values by providing a custom configuration (read more [here](/pipeline/configuration)).
69+
70+

0 commit comments

Comments
 (0)