Skip to content

Commit 97e616e

Browse files
authored
Add instructions for deploying Pixie to select nodes. (#185)
* Add instructions for deploying Pixie to select nodes. Signed-off-by: Hannah Troisi <htroisi@pixielabs.ai> * tweak Signed-off-by: Hannah Troisi <htroisi@pixielabs.ai> * address nserrino's comment Signed-off-by: Hannah Troisi <htroisi@pixielabs.ai>
1 parent c5a0fd7 commit 97e616e

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Pixie requires an `x86-64` architecture.
6464

6565
## Operating System
6666

67-
Pixie runs on Linux nodes only.
67+
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.
6868

6969
| | Support | Version |
7070
| :------ | :------------- | :---------------- |

content/en/05-reference/01-admin/04-deploy-options.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Pixie offers the following deploy options:
1111

1212
- [Annotate Pixie's resources](#annotating-pixie's-resources)
1313
- [Label Pixie's resources](#labeling-pixie's-resources)
14+
- [Deploy to a subset of nodes](#deploy-pixie-to-a-subset-of-nodes)
1415
- [Provide a custom cluster name](#providing-a-custom-cluster-name)
1516
- [Configure Pixie's memory usage](#configuring-pixie's-memory-usage)
1617
- [Set the data access mode](#setting-the-data-access-mode)
@@ -54,6 +55,28 @@ To label Pixie's resources when deploying with [Helm](/installing-pixie/install-
5455
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set labels=key1=value1,key2=value2
5556
```
5657

58+
## Deploy Pixie to a subset of nodes
59+
60+
When deploying Pixie, you have the option of selecting which nodes Pixie will be deployed to in your cluster. For example, Pixie [runs on Linux nodes only](/installing-pixie/requirements/#operating-system), so you would use this option to deploy Pixie to clusters with mixed node types.
61+
62+
To deploy Pixie to a subset of the nodes in your cluster:
63+
64+
1. [Label the target nodes](https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes/#add-a-label-to-a-node) with `pixie=allowed`.
65+
66+
2. Add a [`nodeSelector`](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) to Pixie's [`vizier-pem`](/reference/architecture/#vizier) datacollector pods during deployment:
67+
68+
> When deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--patches` flag:
69+
70+
```bash
71+
px deploy --patches='vizier-pem:{\"spec\":{\"template\":{\"spec\":{\"nodeSelector\":{\"pixie\": \"allowed\"}}}}}'
72+
```
73+
74+
> When deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `patches.vizier-pem` field:
75+
76+
```bash
77+
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set patches.vizier-pem='\{\"spec\"\: \{\"template\"\: \{\"spec\"\: \{ \"nodeSelector\"\: \{\"pixie\"\: \"allowed\" \}\}\}\}\}'
78+
```
79+
5780
## Providing a custom cluster name
5881

5982
When deploying Pixie, you have the option of providing a custom cluster name. If you do not provide a cluster name, the name will be taken from the current kubeconfig.

0 commit comments

Comments
 (0)