|
| 1 | +--- |
| 2 | +title: "Cosmic Cloud" |
| 3 | +metaTitle: "Install | Install Guides | Cosmic Cloud" |
| 4 | +metaDescription: "Getting started guide to setup Pixie" |
| 5 | +order: 1 |
| 6 | +--- |
| 7 | + |
| 8 | +## Prerequisites |
| 9 | + |
| 10 | +- Review Pixie's [requirements](/installing-pixie/requirements) to make sure that your Kubernetes cluster is supported. |
| 11 | + |
| 12 | +- Determine if you already have [Operator Lifecycle Manager](https://docs.openshift.com/container-platform/4.5/operators/understanding/olm/olm-understanding-olm.html) (OLM) deployed to your cluster, possibly to the default `olm` namespace. Pixie uses the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to manage its Vizier, which handles data collection and query execution (see the [Architecture](/about-pixie/what-is-pixie/#architecture) diagram). The OLM is used to install, update and manage the Vizier Operator. |
| 13 | + |
| 14 | +- Pixie interacts with the Linux kernel to install BPF programs to collect telemetry data. In order to install BPF programs, Pixie [`vizier-pem-*`](/about-pixie/what-is-pixie/#architecture) pods require [privileged access](https://github.com/pixie-io/pixie/blob/e03434a5e41d82159aa7602638804159830f9949/k8s/vizier/base/pem_daemonset.yaml#L115). |
| 15 | + |
| 16 | +## 1. Sign up |
| 17 | + |
| 18 | +Visit our [product page](https://work.getcosmic.ai/) and sign up. |
| 19 | + |
| 20 | +## 2. Set up a Kubernetes cluster (optional) |
| 21 | + |
| 22 | +If you don't have a Kubernetes cluster available, you can set up Minikube as a local sandbox environment following these [instructions](/installing-pixie/setting-up-k8s/minikube-setup). |
| 23 | + |
| 24 | +## 3. Install the Pixie CLI |
| 25 | + |
| 26 | +The easiest way to install Pixie's CLI is using the install script: |
| 27 | + |
| 28 | +```bash |
| 29 | +# Copy and run command to install the Pixie CLI. |
| 30 | +bash -c "$(curl -fsSL https://getcosmic.ai/install.sh)" |
| 31 | +``` |
| 32 | + |
| 33 | +For alternate install options (Docker, Debian package, RPM, direct download of the binary) see the [CLI Install](/installing-pixie/install-schemes/cli/) page. |
| 34 | + |
| 35 | +## 4. Deploy Pixie 🚀 |
| 36 | + |
| 37 | +Pixie's CLI is the fastest and easiest way to deploy Pixie. You can also deploy Pixie using [YAML](/installing-pixie/install-schemes/yaml) or [Helm](/installing-pixie/install-schemes/helm). You can use these steps to install Pixie to one or more clusters. |
| 38 | + |
| 39 | +To deploy Pixie using the CLI: |
| 40 | + |
| 41 | +<Alert variant="outlined" severity="info"> |
| 42 | + If your cluster already has Operator Lifecycle Manager (OLM) deployed, deploy Pixie using the `--deploy_olm=false` flag. |
| 43 | +</Alert> |
| 44 | + |
| 45 | +<Alert variant="outlined" severity="info"> |
| 46 | + Please refer to <a href="/reference/admin/environment-configs">Environment-Specific Configurations</a> for other configurations that should be set for your specific Kubernetes environment. |
| 47 | +</Alert> |
| 48 | + |
| 49 | +```bash |
| 50 | +# PL_CLOUD_ADDR must be set before any pixie cli commands are run! |
| 51 | +export PL_CLOUD_ADDR=getcosmic.ai |
| 52 | + |
| 53 | +# List Pixie deployment options. |
| 54 | +px deploy --help |
| 55 | + |
| 56 | +# Deploy the Pixie Platform in your K8s cluster (No OLM present on cluster). |
| 57 | +px deploy |
| 58 | + |
| 59 | +# Deploy the Pixie Platform in your K8s cluster (OLM already exists on cluster). |
| 60 | +px deploy --deploy_olm=false |
| 61 | + |
| 62 | +# Deploy Pixie with a specific memory limit (2Gi is the default, 1Gi is the minimum recommended) |
| 63 | +px deploy --pem_memory_limit=1Gi |
| 64 | +``` |
| 65 | + |
| 66 | +Pixie deploys the following pods to your cluster. Note that the number of `vizier-pem` pods correlates with the number of nodes in your cluster, so your deployment may contain more PEM pods. |
| 67 | + |
| 68 | +```bash |
| 69 | +NAMESPACE NAME |
| 70 | +olm catalog-operator |
| 71 | +olm olm-operator |
| 72 | +pl kelvin |
| 73 | +pl nats-operator |
| 74 | +pl pl-nats-1 |
| 75 | +pl vizier-certmgr |
| 76 | +pl vizier-cloud-connector |
| 77 | +pl vizier-metadata |
| 78 | +pl vizier-pem |
| 79 | +pl vizier-pem |
| 80 | +pl vizier-proxy |
| 81 | +pl vizier-query-broker |
| 82 | +px-operator 77003c9dbf251055f0bb3e36308fe05d818164208a466a15d27acfddeejt7tq |
| 83 | +px-operator pixie-operator-index |
| 84 | +px-operator vizier-operator |
| 85 | +``` |
| 86 | + |
| 87 | +To deploy Pixie to another cluster, change your `kubectl config current-context` to point to that cluster. Then repeat the same deploy commands shown in this step. |
| 88 | + |
| 89 | +### More Deploy Options |
| 90 | + |
| 91 | +For more deploy options that you can specify to configure Pixie, refer to our [deploy options](/reference/admin/deploy-options). |
| 92 | + |
| 93 | +## 5. Invite others to your organization (optional) |
| 94 | + |
| 95 | +Add users to your organization to share access to Pixie Live Views, query running clusters, and deploy new Pixie clusters. For instructions, see the [User Management & Sharing](/reference/admin/user-mgmt) reference docs. |
| 96 | + |
| 97 | +## 6. Use Pixie |
| 98 | + |
| 99 | +### Deploy a demo microservices app (optional) |
| 100 | + |
| 101 | +Deploy a simple demo app to monitor using Pixie: |
| 102 | + |
| 103 | +```bash |
| 104 | +# List available demo apps. |
| 105 | +px demo list |
| 106 | + |
| 107 | +# Example: deploy Weaveworks' "sock-shop". |
| 108 | +px demo deploy px-sock-shop |
| 109 | +``` |
| 110 | + |
| 111 | +This demo application takes several minutes to stabilize after deployment. |
| 112 | + |
| 113 | +To check the status of the application's pods, run: |
| 114 | + |
| 115 | +```bash |
| 116 | +kubectl get pods -n px-sock-shop |
| 117 | +``` |
| 118 | + |
| 119 | +### Test out the CLI |
| 120 | + |
| 121 | +Use `px live` to run a script to demonstrate observability. The `http_data` script shows a sample of the HTTP/2 traffic flowing through your cluster. |
| 122 | + |
| 123 | +```bash |
| 124 | +# List built-in scripts |
| 125 | +px scripts list |
| 126 | + |
| 127 | +# Run a script |
| 128 | +px live px/http_data |
| 129 | +``` |
| 130 | + |
| 131 | +For more information, checkout our [CLI guide](/using-pixie/using-cli/). |
| 132 | + |
| 133 | +### Explore the web app |
| 134 | + |
| 135 | +Open [Pixie's Live UI](https://work.getcosmic.ai) in a new tab. |
| 136 | + |
| 137 | +1. After reviewing the hints, click the X in the upper left hand corner of the screen. |
| 138 | +2. Select your cluster (you may see other clusters from members of your organization). |
| 139 | +3. Now, select a script, e.g. `px/cluster` or `px/http_data`. |
| 140 | + |
| 141 | +For more information, check out our [Live UI guide](/using-pixie/using-live-ui/). |
| 142 | + |
| 143 | +### Check out the tutorials |
| 144 | + |
| 145 | +Learn how to use Pixie for |
| 146 | + |
| 147 | +- [Network Monitoring](/tutorials/pixie-101/network-monitoring/) |
| 148 | +- [Infra Health](/tutorials/pixie-101/infra-health/) |
| 149 | +- [Service Performance](/tutorials/pixie-101/service-performance/) |
| 150 | +- [Database Query Profiling](/tutorials/pixie-101/database-query-profiling/) |
| 151 | +- [Request Tracing](/tutorials/pixie-101/request-tracing/) |
| 152 | +- [Kafka Monitoring](/tutorials/pixie-101/kafka-monitoring/) |
| 153 | + |
| 154 | +## Get Help |
| 155 | + |
| 156 | +Please see our [Troubleshooting](/about-pixie/troubleshooting/) guide, reach out on our [Community Slack](https://slackin.px.dev/) or file an issue on [GitHub](https://github.com/pixie-io/pixie/issues). |
0 commit comments