Deploy Options
Pixie offers the following deploy options:
- Annotate Pixie's resources
- Label Pixie's resources
- Provide a custom cluster name
- Configure Pixie's memory usage
- Set the data access mode
To see the full set of deploy options, install the Pixie CLI and run px deploy --help.
Annotating Pixie's resources
When deploying Pixie, you have the option of adding one or more custom annotations to the Kubernetes objects deployed by Pixie.
To annotate Pixie's resources when deploying with the Pixie CLI, use the --annotations flag:
px deploy --annotations=key1=value1,key2=value2
To annotate Pixie's resources when deploying with Helm, use the annotations field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set annotations=key1=value1,key2=value2
Labeling Pixie's resources
When deploying Pixie, you have the option of adding one or more custom labels to the Kubernetes objects deployed by Pixie. Certain labels are reserved for internal use by Pixie. The following are reserved label strings that may not be used:
"vizier-bootstrap"“component"“vizier-updater-dep"“app"
To label Pixie's resources when deploying with the Pixie CLI, use the --labels flag:
px deploy --labels=key1=value1,key2=value2
To label Pixie's resources when deploying with Helm, use the labels field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set labels=key1=value1,key2=value2
Providing a custom cluster name
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.
To provide a custom cluster name when deploying with the Pixie CLI, use the --cluster_name flag:
# Deploy Pixie in your K8s cluster and use the provided name for the cluster.px deploy --cluster_name=<CLUSTER_NAME>
To provide a custom cluster name when deploying with Helm, use the clusterName field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --set clusterName=<CLUSTER_NAME> --namespace pl --create-namespace
Configuring Pixie's memory usage
When deploying Pixie, you have three options for configuring PEM memory usage:
For more information about these options, please refer to the Tuning Memory Usage page.
Setting the memory limit
The default memory limit is 2Gi per PEM. The lowest recommended value is 1Gi per PEM. 1Gi is not a suitable limit for a cluster with high throughput, but it is suitable for a small cluster with limited resources.
To set Pixie's memory limit when deploying with the Pixie CLI, use the --pem_memory_limit flag:
px deploy --pem_memory_limit=1Gi
To set Pixie's memory limit when deploying with Helm, use the pemMemoryLimit field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set pemMemoryLimit=1Gi
Setting the memory request
By default, the PEM's memory request will be the same as the limit. When deploying Pixie, you can specify a different memory request than limit. This flag is useful for clusters in which the PEM pods are pending because there is not enough memory for them to be scheduled on the node.
To set Pixie's memory request when deploying with the Pixie CLI, use the --pem_memory_request flag:
px deploy --pem_memory_request=1Gi
To set Pixie's memory request when deploying with Helm, use the pemMemoryRequest field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set pemMemoryRequest=1Gi
Setting the data table storage memory limit
This is an advanced option that most developers shouldn't need. For more discussion see the Tuning Memory Usage page.
To set Pixie's data store memory limit when deploying with the Pixie CLI, use the --pem_flags flag:
px deploy --pem_flags="PL_TABLE_STORE_DATA_LIMIT_MB=1000"
To set Pixie's data store memory limit when deploying with Helm, use the dataCollectorParams.customPEMFlags.PL_TABLE_STORE_DATA_LIMIT_MB field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set dataCollectorParams.customPEMFlags.PL_TABLE_STORE_DATA_LIMIT_MB=750
Setting the data access mode
When deploying Pixie, you have the option of setting the data access mode. This mode controls what data can be displayed when executing a PxL script to query Pixie platform telemetry data. Pixie offers two data access modes:
Full(default): The user has full data access, and Pixie does not redact any collected data from the user during script execution.Restricted: The user has restricted data access. Pixie will redact all columns that may potentially contain sensitive data (e.g. request/response bodies and headers). All rows in the column will be redacted, regardless of whether they do or do not actually contain PII. Metadata about these columns, such as length, will still be queryable.
If no data access mode is specified when deploying Pixie, the deploy assumes Full as default.
To set the data access mode when deploying with the Pixie CLI, use the --data_access flag:
px deploy --data_access=(Full|Restricted)
To set the data access mode when deploying with Helm, use the dataAccess field:
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set dataAccess=(Full|Restricted)
You may also directly update the dataAccess field in your values.yaml file.