Skip to content

Commit c4d3e3d

Browse files
authored
Update requirements page. (#179)
Signed-off-by: Hannah Troisi <htroisi@pixielabs.ai>
1 parent 97e616e commit c4d3e3d

1 file changed

Lines changed: 36 additions & 27 deletions

File tree

content/en/02-installing-pixie/01-requirements.md

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,24 @@ metaDescription: "Resource requirements to install Pixie"
55
order: 1
66
---
77

8-
Below are the requirements for deploying Pixie to your Kubernetes (K8s) cluster.
8+
Before installing Pixie to your Kubernetes cluster, please ensure that your system meets the requirements below.
9+
10+
- [Kubernetes Environment](/installing-pixie/requirements/#kubernetes)
11+
- [Operating System](/installing-pixie/requirements/#operating-system)
12+
- [CPU](/installing-pixie/requirements/#cpu)
13+
- [Memory](/installing-pixie/requirements/#memory)
14+
- [Network](/installing-pixie/requirements/#network-traffic)
915

1016
Please refer to the [install guides](/installing-pixie/install-guides/) for information on how to install Pixie to your K8s cluster.
1117

1218
## Kubernetes
1319

1420
Kubernetes `v1.16+` is required.
1521

22+
The following tables list Kubernetes environments that have been tested with Pixie.
23+
24+
<Alert variant="outlined" severity="info">Pixie may work on other K8s environments. If you find an unlisted K8s environment that works well, please let us know by opening a GitHub issue or by creating a pull request that updates <a href="https://github.com/pixie-io/docs.px.dev/blob/main/content/en/02-installing-pixie/01-requirements.md">this doc</a>.</Alert>
25+
1626
### Production Environments
1727

1828
| K8s Environment | Support |
@@ -43,25 +53,6 @@ For local development, we recommend using Minikube with a VM driver (`kvm2` on L
4353
| minikube with `driver=docker` | Not Supported |
4454
| minikube with `driver=none` | Not Supported |
4555

46-
## Memory
47-
48-
Pixie requires the following memory per node:
49-
50-
| Minimum | Notes |
51-
| :-------- | :--------------------------------------------------------------------- |
52-
| 1GiB | To accommodate application pods, we recommend using no more than 25% of the nodes' total memory for Pixie. |
53-
54-
Pixie deploys its PEMs as a DaemonSet on your cluster in order to collect and store telemetry data. The default memory limit is 2Gi per PEM. The lowest recommended value is 1Gi per PEM. For more information on how to configure Pixie's memory usage, see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
55-
56-
## CPU
57-
58-
Pixie requires an `x86-64` architecture.
59-
60-
| | Support |
61-
| :------ | :---------------- |
62-
| x86-64 | Supported |
63-
| ARM | Not supported |
64-
6556
## Operating System
6657

6758
Pixie runs on Linux nodes only. You can configure Pixie to [deploy to a subset of the nodes](/reference/admin/deploy-options#deploy-pixie-to-a-subset-of-nodes) in your cluster.
@@ -71,20 +62,38 @@ Pixie runs on Linux nodes only. You can configure Pixie to [deploy to a subset o
7162
| Linux | Supported | v4.14+ |
7263
| Windows | Not Supported | Not in roadmap |
7364

74-
### Linux Distributions
65+
### Linux Distribution
7566

76-
The following is a list of Linux distributions that have been tested.
67+
The following table lists Linux distributions that are known to work with Pixie.
7768

7869
| | Version |
7970
|:----------- | :------------------- |
80-
| Ubuntu | 18.04+ |
71+
| CentOS | 7.3+ |
8172
| Debian | 10+ |
82-
| RHEL | 8+ |
83-
| CentOS | 7.3+ |
84-
85-
Pixie may also work on other distributions.
73+
| RedHat Enterprise Linux | 8+ |
74+
| Ubuntu | 18.04+ |
8675

8776
<Alert variant="outlined" severity="info">We recommended that Linux headers be installed on a cluster's nodes.</Alert>
77+
<Alert variant="outlined" severity="info">Pixie may also work on other distributions. If you find an unlisted Linux distribution that works well, please let us know by opening a GitHub issue or by creating a pull request that updates <a href="https://github.com/pixie-io/docs.px.dev/blob/main/content/en/02-installing-pixie/01-requirements.md">this doc</a>.</Alert>
78+
79+
## CPU
80+
81+
Pixie requires an `x86-64` architecture.
82+
83+
| | Support |
84+
| :------ | :---------------- |
85+
| x86-64 | Supported |
86+
| ARM | Not Supported |
87+
88+
## Memory
89+
90+
Pixie requires the following memory per node:
91+
92+
| Minimum | Notes |
93+
| :-------- | :--------------------------------------------------------------------- |
94+
| 1GiB | To accommodate application pods, we recommend using no more than 25% of the nodes' total memory for Pixie. |
95+
96+
Pixie deploys its PEMs as a DaemonSet on your cluster in order to collect and store telemetry data. The default memory limit is 2Gi per PEM. The lowest recommended value is 1Gi per PEM. For more information on how to configure Pixie's memory usage, see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
8897

8998
## Network Traffic
9099

0 commit comments

Comments
 (0)