EXPAND ALL
  • Home

Quick Start

Please review Pixie's requirements to make sure that your Kubernetes cluster is supported.

These directions are for installing the hosted version of Pixie. A self-hosted install script is in the works. Track the status here.

1. Signup

Visit our product page and sign up with your google or gsuite account.

2. Install the CLI

You can install Pixie's CLI tool in one of 4 ways:

Using the install script (easiest)

# Copy and run command to install the Pixie CLI.
bash -c "$(curl -fsSL https://withpixie.ai/install.sh)"

Directly downloading the binary

# Download the latest Pixie binary.
curl -o px https://storage.googleapis.com/pixie-prod-artifacts/cli/latest/cli_darwin_amd64
# Check the signature matches.
sha256sum px
# Make it executable.
chmod +x px
# (Optional) Move it to another location that has executables.
mv px /usr/local/bin

Using Docker

alias px="docker run -i --rm -v ${HOME}/.pixie:/root/.pixie pixielabs/px"

Using Debian package

# Install Pixie .deb package.
dpkg -i pixie-px.x86_64.deb

Using RPM

# Install Pixie .rpm package.
rpm -i pixie-px.x86_64.rpm

3. Setup a sandbox (optional)

Set-up a local K8s environment

You can use Minikube to set-up a local K8s environment.

On Linux, run:

`minikube start --driver=kvm2 --cpus=4 --memory=6000 --driver=kvm2 -p=<cluster-name>`

The default docker driver is not currently supported, so using the kvm2 driver is important.

On Mac, run:

`minikube start --driver=hyperkit --cpus=4 --memory=6000 -p=<cluster-name>`

More detailed instructions are available here.

Start a demo-app

Deploy a simple demo app to monitor:

# View available demo apps:
px demo list
# Example: deploy Weaveworks' "sock-shop":
px demo deploy px-sock-shop

Note that it will take several minutes for the application to stabilize after deployment. You can use kubectl get pods -n px-sock-shop to check the status of the application's pods.

4. Deploy Pixie 🚀

You can deploy Pixie to your Kubernetes cluster with the Pixie CLI, YAML, or Helm.

Pixie's CLI is the fastest and easiest way to deploy Pixie:

# Deploy the Pixie Platform in your K8s cluster by running:
px deploy

For more CLI deployment configuration options, see here.

5. Run a script

Use px run to run a script to demonstrate observability. The demo_script script shows the latency and request path of http traffic hitting your cluster.

# List built-in scripts
px scripts list
# Run a script
px run px/demo_script

For more information, checkout our CLI guide or see our PxL script documentation, but first, go on to the next step and explore our web app.

6. Explore the web app

Open Pixie's live UI in a new tab.

  1. After reviewing the hints, click the X in the upper left hand corner of the screen.
  2. Select your cluster (you may see other clusters from members of your organization).
  3. Now, select a script, e.g. px/demo_script or px/http_data.

For more information, check out our Live UI guide.

Need help? Something went wrong?

Reach out to us on Slack or file an issue on GitHub if you face issues during installation.

Copyright © 2018- The Pixie Authors. 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.