• Home
Open Source Docs



  • Review Pixie's requirements to make sure that your Kubernetes cluster is supported.

  • Determine if you already have Operator Lifecycle Manager (OLM) deployed to your cluster, possibly to the default olm namespace. Pixie uses the Kubernetes Operator pattern to manage its Vizier, which handles data collection and query execution (see the Architecture diagram). The OLM is used to install, update and manage the Vizier Operator.

1. Install the Pixie CLI

The CLI is used to get Pixie's YAML files. You can install the Pixie CLI following the directions here.

2. (Optional) Use the CLI to Check Pixie's Requirements

Check if your K8s cluster meets Pixie's requirements by running:

px deploy --check_only

If your cluster fails any checks, you may still proceed with installation, but it is unlikely that Pixie will work on your cluster.

3. Create a Deployment Key

Create a deployment key following the directions here.

4. Extract Manifests

Create a directory to save Pixie's manifest files and run the following CLI commands to extract them:

# Extract YAML (No OLM present on cluster).
px deploy --extract_yaml <NAME_OF_PIXIE_YAMLS_FOLDER> --deploy_key <PIXIE_DEPLOYMENT_KEY>
# Extract YAML (OLM already exists on cluster).
px deploy --extract_yaml <NAME_OF_PIXIE_YAMLS_FOLDER> --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false
# Deploy Pixie with a specific memory limit (2Gi is the default, 1Gi is the minimum recommended)
px deploy --extract_yaml <NAME_OF_PIXIE_YAMLS_FOLDER> --deploy_key <PIXIE_DEPLOYMENT_KEY> --pem_memory_limit=1Gi

Note: The extracted YAMls does not include manifests for each sub-component of Pixie. It includes manifests for etcd, NATS and the cloud-connector service which downloads the manifests for the necessary services and daemonsets.

5. Deploy Pixie

Deploy Pixie in your target cluster by running:

# Deploy
kubectl apply --recursive -f <NAME_OF_PIXIE_YAMLS_FOLDER>

Pixie will deploy pods to the pl, px-operator, and olm(if deploying the OLM) namespaces.

More Deploy Options

For more deploy options that you can specify to configure Pixie, refer to our deploy options.

6. Verify

To verify that Pixie is running in your environment you can check the admin page or run:

# Check pods are up
kubectl get pods -n pl
# Check Pixie Platform status
px get viziers
# Check PEM stats
px get pems
© 2018-21 New Relic, Inc. All Rights Reserved.
This site uses cookies to provide you with a better user experience. By using Pixie, you consent to our use of cookies.