Skip to content

Commit 58f6c67

Browse files
authored
Reorganize hosted and self-hosted cloud pages. Add Cosmic cloud to list of clouds (#285)
* Reorganize hosted and self-hosted cloud pages. Add Cosmic Cloud to the list of available clouds Signed-off-by: Dom Del Nano <ddelnano@gmail.com> * Fix grammar Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
1 parent 8800064 commit 58f6c67

12 files changed

Lines changed: 203 additions & 25 deletions

File tree

content/en/01-about-pixie/05-faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ Yes. See the self-hosted [Install Guide](/installing-pixie/install-guides/self-h
6060

6161
### Does Pixie offer a hosted cloud offering?
6262

63-
Yes. Pixie Community Cloud is a hosted version of Pixie. Pixie stores all data on the customer's cluster, resulting in a very small cloud footprint which allows Pixie to offer the Community Cloud offering 100% free for all Pixie users. See the Community Cloud [Install Guide](/installing-pixie/install-guides/community-cloud-for-pixie) to get started.
63+
Yes, there are a few versions of hosted Pixie. Please see the [Hosted Pixie](/installing-pixie/install-guides/hosted-pixie) page for all the current offerings.
6464

6565
## Data Collection
6666

6767
### Where does Pixie store its data?
6868

69-
Pixie stores the data it collects in-memory on the nodes in your cluster; no data is sent to a centralized backend outside of the cluster. This is true for both self-hosted Pixie and [Pixie Community Cloud](#general-does-pixie-offer-a-hosted-cloud-offering).
69+
Pixie stores the data it collects in-memory on the nodes in your cluster; no data is sent to a centralized backend outside of the cluster. This is true for both [hosted](#general-does-pixie-offer-a-hosted-cloud-offering) and self-hosted Pixie.
7070

7171
Pixie has a [1GiB memory requirement](/installing-pixie/requirements/#memory) per node. After installing Pixie, it is normal to see a temporary increase in memory usage of the `vizier-pem` pods as they begin to fill their [data tables](/reference/datatables/).
7272

@@ -80,7 +80,7 @@ Pixie's [Plugin System](/reference/plugins/plugin-system) integrates with third-
8080

8181
Pixie stores the telemetry data it collects in-memory on the nodes in your cluster. Data processing and script execution are also performed in the cluster. End-to-end encryption is offered for data in flight between in-cluster storage and presentation in the UI, CLI, and API.
8282

83-
Pixie Cloud (self-hosted or Pixie Community Cloud) hosts the UI and stores limited metadata related to account (user, organization) and Kubernetes control data (cluster name, number of nodes, etc). All communication with Pixie Cloud is TLS encrypted.
83+
Pixie Cloud (hosted or self-hosted Pixie) hosts the UI and stores limited metadata related to account (user, organization) and Kubernetes control data (cluster name, number of nodes, etc). All communication with Pixie Cloud is TLS encrypted.
8484

8585
Data flows through Pixie's Cloud via a reverse proxy as encrypted traffic without any persistence. This allows developers to access data without being in the same network as the cluster.
8686

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
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).

content/en/02-installing-pixie/03-install-guides/01-community-cloud-for-pixie.md renamed to content/en/02-installing-pixie/03-install-guides/01-hosted-pixie/02-new-relic-cloud.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "New Relic - Community Cloud"
3-
metaTitle: "Install | Install Guides | New Relic - Community Cloud"
2+
title: "New Relic Cloud"
3+
metaTitle: "Install | Install Guides | New Relic Cloud"
44
metaDescription: "Getting started guide to setup Pixie"
5-
order: 1
5+
order: 2
66
---
77

88
## Prerequisites
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Hosted Pixie"
3+
metaTitle: "Hosted Pixie"
4+
metaDescription: "Install instructions for the various Hosted Pixie offerings"
5+
order: 1
6+
redirect_from:
7+
- /installing-pixie/install-guides/community-cloud-for-pixie
8+
---
9+
10+
This page lists all of the current hosted Pixie offerings. Use the links below to navigate to the install instructions for your preferred Cloud:
11+
- [Cosmic Cloud](/installing-pixie/install-guides/hosted-pixie/cosmic-cloud)
12+
- [New Relic Cloud](/installing-pixie/install-guides/hosted-pixie/new-relic-cloud)
13+
14+
When browsing this site, use the "Cloud backend" dropdown to update the links to match your selected Cloud.
15+
16+
17+
## Add Your Own
18+
19+
Does your organization offer Pixie? [Open a PR](https://github.com/pixie-io/pixie-docs) to list it here.

content/en/02-installing-pixie/03-install-guides/03-airgap-pixie.md renamed to content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/01-airgap-pixie.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ metaDescription: "How to install Pixie in an air gapped environment."
55
order: 3
66
redirect_from:
77
- /airgap
8+
- /installing-pixie/install-guides/airgap-pixie
89
---
910

1011
Follow these instructions to install Pixie in an air gapped environment. An air gapped environment is any environment that is not directly connected to the Internet.

content/en/02-installing-pixie/03-install-guides/04-production-readiness.md renamed to content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/02-production-readiness.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Production Readiness"
33
metaTitle: "Production Readiness"
44
metaDescription: "Sharing a single Pixie Cloud across multiple Pixie deployments"
55
order: 4
6+
redirect_from:
7+
- /installing-pixie/install-guides/production-readiness
68
---
79

810
Pixie allows you to connect multiple Kubernetes clusters to a single Pixie Cloud instance. The main advantage of such a deployment is that you can monitor all your Kubernetes clusters from a single point.

content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie.md renamed to content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metaDescription: "Getting started guide to setup 100% self-hosted Pixie"
55
order: 2
66
---
77

8-
Get Pixie fully managed with [Pixie Community Cloud](/installing-pixie/install-guides/community-cloud-for-pixie) (free forever) or run on your own infrastructure with the following self-managed option.
8+
Get Pixie fully managed with one of the [Hosted Pixie offerings](/installing-pixie/install-guides/hosted-pixie) or run on your own infrastructure with the following self-managed option.
99

1010
## Prerequisites
1111

@@ -19,10 +19,6 @@ Get Pixie fully managed with [Pixie Community Cloud](/installing-pixie/install-g
1919

2020
## 1. Deploy Pixie Cloud
2121

22-
<Alert variant="outlined" severity="info">
23-
Pixie also offers a free account with Pixie Community Cloud to make getting started even easier and faster. To get Pixie Cloud, check out the community cloud <a href="/installing-pixie/install-guides/community-cloud-for-pixie">Install Guide</a>.
24-
</Alert>
25-
2622
<Alert variant="outlined" severity="warning">
2723
There is a known issue with login on self-managed Pixie Cloud on Safari and Firefox. For now, use Chrome.
2824
</Alert>

content/en/02-installing-pixie/03-install-guides/index.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,23 @@ redirect_from:
99

1010
There are multiple hosting options for Pixie.
1111

12-
- [Community Cloud for Pixie (easiest)](/installing-pixie/install-guides/community-cloud-for-pixie)
12+
- [Hosted Pixie (easiest)](/installing-pixie/install-guides/hosted-pixie)
1313
- [Self-Hosted Pixie](/installing-pixie/install-guides/self-hosted-pixie)
14-
- [Air Gapped Pixie](/installing-pixie/install-guides/airgap-pixie)
1514

1615
Pixie is a hybrid system, with a cloud component (Pixie Cloud) and an in-cluster component for data persistence and storage (Vizier). See [Architecture](/about-pixie/what-is-pixie/#architecture) for more details.
1716

1817
While Vizier will always be deployed directly onto your Kubernetes cluster, there are multiple options for Pixie Cloud.
1918

20-
## Community Cloud for Pixie (easiest)
19+
## Hosted Pixie (easiest)
2120

22-
Follow the [Community Cloud for Pixie Guide](/installing-pixie/install-guides/community-cloud-for-pixie) if you want to deploy Pixie without needing to host your own version of Pixie Cloud. Community Cloud for Pixie provides community hosting of the cloud component to simplify your Pixie deployment.
21+
If you want to deploy Pixie without needing to host your own version of Pixie Cloud, select one of the Cloud offerings on the [Hosted Pixie](/installing-pixie/install-guides/hosted-pixie) page and following the install instructions.
2322

24-
With Community Cloud for Pixie, telemetry data is exclusively stored on your Kubernetes cluster (not in Pixie Cloud).
23+
When using a hosted Pixie backend, telemetry data is exclusively stored on your Kubernetes cluster (not in Pixie Cloud).
2524

2625
## Self-Hosted Pixie
2726

2827
Pixie also supports for self-hosting of the entire platform, including Pixie Cloud. Follow the [Self-Hosted Pixie Guide](/installing-pixie/install-guides/self-hosted-pixie) for the steps.
2928

30-
## Air Gapped Pixie
31-
32-
Pixie works in air gapped environments. Follow the [Air Gapped Pixie Guide](/installing-pixie/install-guides/airgap-pixie) for the install steps.
33-
3429
## Add Your Own
3530

3631
Does your organization offer Pixie? [Open a PR](https://github.com/pixie-io/pixie-docs) to list it here.

content/en/02-installing-pixie/04-install-schemes/01-cli.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,15 @@ rpm -i pixie-px.x86_64.rpm
108108
px deploy --help
109109

110110
# Deploy the Pixie Platform in your K8s cluster (No OLM present on cluster).
111+
export PL_CLOUD_ADDR=<getcosmic.ai or withpixie.ai>
111112
px deploy
112113

113114
# Deploy the Pixie Platform in your K8s cluster (OLM already exists on cluster).
115+
export PL_CLOUD_ADDR=<getcosmic.ai or withpixie.ai>
114116
px deploy --deploy_olm=false
115117

116118
# Deploy Pixie with a specific memory limit (2Gi is the default, 1Gi is the minimum recommended)
119+
export PL_CLOUD_ADDR=<getcosmic.ai or withpixie.ai>
117120
px deploy --pem_memory_limit=1Gi
118121
```
119122

content/en/02-installing-pixie/04-install-schemes/03-helm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ helm repo add pixie-operator https://artifacts.px.dev/helm_charts/operator
5555
helm repo update
5656

5757
# Install the Pixie chart (No OLM present on cluster).
58-
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace
58+
helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=<getcosmic.ai:443 or withpixie.ai:443> --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace
5959

6060
# Install the Pixie chart (OLM already exists on cluster).
61-
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set deployOLM=false
61+
helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=<getcosmic.ai:443 or withpixie.ai:443> --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set deployOLM=false
6262

6363
# Install the Pixie chart (Self-hosting Pixie Cloud)
6464
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set devCloudNamespace=plc
6565

6666
# Install Pixie with a memory limit for the PEM pods (per node). 2Gi is the default, 1Gi is the minimum recommended.
67-
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set deployOLM=false --set pemMemoryLimit=1Gi
67+
helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=<getcosmic.ai:443 or withpixie.ai:443> --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set deployOLM=false --set pemMemoryLimit=1Gi
6868
```
6969

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

0 commit comments

Comments
 (0)