EXPAND ALL
  • Home

Quick Start

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:

  1. Using the install script (easiest)
# Copy and run command to install the Pixie CLI.
bash -c "$(curl -fsSL https://withpixie.ai/install.sh)"
  1. 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
  1. Using Docker
alias px="docker run -i --rm -v ${HOME}/.pixie:/root/.pixie pixielabs/px"
  1. Using Debian package
# Install Pixie .deb package.
dpkg -i pixie-px.x86_64.deb
  1. 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 --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 --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
# Simulate load using the load generator:
# [note: edit command with the right ports before running]
kubectl port-forward --namespace \
px-sock-shop $(kubectl get pod --namespace px-sock-sh \
--selector="name=load-test" \
--output jsonpath='{.items[0].metadata.name}') 8080:8089

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
# You have lift off! start exploring scripts:
px scripts list

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

Copyright © 2020 Pixie Labs Inc.