Skip to content

Update install scheme pages to reflect selected Cloud URL #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aimichelle merged 7 commits into from
Jul 12, 2024
Merged

Update install scheme pages to reflect selected Cloud URL #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d762ee3
Update CLI install scheme to update URLs based on selected Cloud
ddelnano Jul 11, 2024
7bb7ed7
Fix linting
ddelnano Jul 11, 2024
5d2ede6
Rename componet to be more generic. Pass code block via property to a…
ddelnano Jul 11, 2024
25ccb31
Update helm and YAML install instructions to incorporate cloud select…
ddelnano Jul 11, 2024
71343ac
Update docs to use PX_CLOUD_ADDR instead of legacy equivalent
ddelnano Jul 11, 2024
e96560b
Rename placeholder used for cloud templating from @@ to @PLACEHOLDER@
ddelnano Jul 11, 2024
4acaed2
Remove PX_CLOUD_ADDR reference from self hosted instructions
ddelnano Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...ent/en/02-installing-pixie/03-install-guides/01-hosted-pixie/01-cosmic-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ To deploy Pixie using the CLI:
</Alert>

```bash
# PL_CLOUD_ADDR must be set before any pixie cli commands are run!
export PL_CLOUD_ADDR=getcosmic.ai
# PX_CLOUD_ADDR must be set before any pixie cli commands are run!
export PX_CLOUD_ADDR=getcosmic.ai

# List Pixie deployment options.
px deploy --help
Expand Down
2 changes: 1 addition & 1 deletion content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Add users to your organization to share access to Pixie Live Views, query runnin
1. Set the cloud address with an environment variable. If you configured a custom domain name, use that as the variable's value:

```bash
export PL_CLOUD_ADDR=dev.withpixie.dev
export PX_CLOUD_ADDR=dev.withpixie.dev
```

1. Install Pixie's CLI. The easiest way to install Pixie's CLI is using the install script:
Expand Down
21 changes: 10 additions & 11 deletions content/en/02-installing-pixie/04-install-schemes/01-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,22 +103,21 @@ rpm -i pixie-px.x86_64.rpm
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.
</Alert>

```bash
<TemplatedCodeBlock
code={`
# List Pixie deployment options.
px deploy --help

px deploy --help \n
# Deploy the Pixie Platform in your K8s cluster (No OLM present on cluster).
Comment on lines +109 to 110
Copy link
Copy Markdown
Member Author

@ddelnano ddelnano Jul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aimichelle leaving the empty lines in this template string caused the following compilation issues:

 ERROR #11321  PLUGIN

"gatsby-plugin-mdx" threw an error while running the onCreateNode lifecycle:

unknown: Unexpected token, expected "{" (1:7)

> 1 | export PX_CLOUD_ADDR=@PLACEHOLDER@
    |        ^
  2 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false \n
  3 | # Extract YAML (Self-hosting Pixie Cloud).
  4 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc \n/home/ddelnano/code/docs.px.dev/content/en/02-installing-pixie/04-install-schemes/02-yaml.md: unknown: Unexpected token, expected "{" (1:7)

> 1 | export PX_CLOUD_ADDR=@PLACEHOLDER@
    |        ^
  2 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false \n
  3 | # Extract YAML (Self-hosting Pixie Cloud).
  4 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc \n

  31 |   const createAndProcessNode = path => {
  32 |     const fileNodePromise = createFileNode(path, createNodeId, pluginOptions).then(fileNode => {
> 33 |       createNode(fileNode);
     |       ^
  34 |       return null;
  35 |     });
  36 |     return fileNodePromise;

File: node_modules/gatsby-source-filesystem/gatsby-node.js:33:7



  SyntaxError: unknown: Unexpected token, expected "{" (1:7)
  > 1 | export PX_CLOUD_ADDR=@  9mPLACEHOLDER@
      |        ^
    2 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false  [39m \n
    3 | # Extract YAML (Self-hosting   Pixie Cloud).
    4 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc   1m\n/home/ddelnano/code/docs.px.dev/content/en/02-installing-pixie/04-instal  l-schemes/02-yaml.md: unknown: Unexpected token, expected "{" (1:7)
  > 1 | export PX_CLOUD_ADDR=@  9mPLACEHOLDER@
      |        ^
    2 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false  [39m \n
    3 | # Extract YAML (Self-hosting   Pixie Cloud).
    4 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc   1m\n
  SyntaxError: unknown: Unexpected token, expected "{" (1:7)
  > 1 | export PX_CLOUD_ADDR=@  9mPLACEHOLDER@
      |        ^
    2 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false  [39m \n
    3 | # Extract YAML (Self-hosting   Pixie Cloud).
    4 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc   1m\n/home/ddelnano/code/docs.px.dev/content/en/02-installing-pixie/04-instal  l-schemes/02-yaml.md: unknown: Unexpected token, expected "{" (1:7)
  > 1 | export PX_CLOUD_ADDR=@  9mPLACEHOLDER@
      |        ^
    2 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false  [39m \n
    3 | # Extract YAML (Self-hosting   Pixie Cloud).
    4 | px deploy --extract_yaml ./ --deploy_ke  y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc   1m\n

Adding \n here was required to keep the line spacing the same. The other thing I tried was adding \n on its own line, but that introduces more spacing than the approach I took as seen in the highlighted text below

Screen Shot 2024-07-11 at 2 40 02 PM

If you have any suggestions here, let me know.

export PL_CLOUD_ADDR=<getcosmic.ai or withpixie.ai>
px deploy

export PX_CLOUD_ADDR=@PLACEHOLDER@
px deploy \n
# Deploy the Pixie Platform in your K8s cluster (OLM already exists on cluster).
export PL_CLOUD_ADDR=<getcosmic.ai or withpixie.ai>
px deploy --deploy_olm=false

export PX_CLOUD_ADDR=@PLACEHOLDER@
px deploy --deploy_olm=false \n
# Deploy Pixie with a specific memory limit (2Gi is the default, 1Gi is the minimum recommended)
export PL_CLOUD_ADDR=<getcosmic.ai or withpixie.ai>
export PX_CLOUD_ADDR=@PLACEHOLDER@
px deploy --pem_memory_limit=1Gi
```
`}
/>

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

Expand Down
40 changes: 22 additions & 18 deletions content/en/02-installing-pixie/04-install-schemes/02-yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,12 @@ The CLI is used to get Pixie's YAML files. You can install the Pixie CLI followi

Check if your K8s cluster meets Pixie's [requirements](/installing-pixie/requirements) by running:

```bash
<TemplatedCodeBlock
code={`
export PX_CLOUD_ADDR=@PLACEHOLDER@
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.

Expand All @@ -45,20 +48,21 @@ Run the following CLI command to extract Pixie's manifest files:
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.
</Alert>

```bash
<TemplatedCodeBlock
code={`
# Extract YAML (No OLM present on cluster).
px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY>

export PX_CLOUD_ADDR=@PLACEHOLDER@
px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> \n
# Extract YAML (OLM already exists on cluster).
px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false

export PX_CLOUD_ADDR=@PLACEHOLDER@
px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false \n
# Extract YAML (Self-hosting Pixie Cloud).
px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc

px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc \n
# Extract YAML (configure Pixie with a specific memory limit - 2Gi is the default, 1Gi is the minimum recommended)
export PX_CLOUD_ADDR=@PLACEHOLDER@
px deploy --extract_yaml ./ --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.

Expand All @@ -82,13 +86,13 @@ For more deploy options that you can specify to configure Pixie, refer to our [d

To verify that Pixie is running in your environment you can check the <CloudLink url="/admin">admin page</CloudLink> or run:

```bash
<TemplatedCodeBlock
code={`
# Check pods are up
kubectl get pods -n pl

# Check Pixie Platform status
kubectl get pods -n pl \n
# Check Pixie Platform and PEM status
export PX_CLOUD_ADDR=@PLACEHOLDER@
px get viziers

# Check PEM stats
px get pems
```
`}
/>
44 changes: 22 additions & 22 deletions content/en/02-installing-pixie/04-install-schemes/03-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ Install the Pixie CLI following the directions [here](/installing-pixie/install-

Check if your K8s cluster meets Pixie's [requirements](/installing-pixie/requirements) by running:

```bash
<TemplatedCodeBlock
code={`
export PX_CLOUD_ADDR=@PLACEHOLDER@
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.

Expand All @@ -47,25 +50,22 @@ Deploy Pixie in your target cluster by running:
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.
</Alert>

```bash
<TemplatedCodeBlock
code={`
# Add the Pixie operator chart.
helm repo add pixie-operator https://artifacts.px.dev/helm_charts/operator

helm repo add pixie-operator https://artifacts.px.dev/helm_charts/operator \n
# Get latest information about Pixie chart.
helm repo update

helm repo update \n
# Install the Pixie chart (No OLM present on cluster).
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

helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=@PLACEHOLDER@ --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace \n
# Install the Pixie chart (OLM already exists on cluster).
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

helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=@PLACEHOLDER@ --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set deployOLM=false \n
# Install the Pixie chart (Self-hosting Pixie Cloud)
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

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 \n
# Install Pixie with a memory limit for the PEM pods (per node). 2Gi is the default, 1Gi is the minimum recommended.
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
```
helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=@PLACEHOLDER@ --set deployKey=<deploy-key-goes-here> --set clusterName=<cluster-name> --namespace pl --create-namespace --set deployOLM=false --set pemMemoryLimit=1Gi
`}
/>

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

Expand All @@ -92,13 +92,13 @@ helm install pixie pixie-vizier/vizier-chart --set deployKey=<deploy-key-goes-he

To verify that Pixie is running in your environment you can check the <CloudLink url="/admin">admin page</CloudLink> or run:

```bash
<TemplatedCodeBlock
code={`
# Check pods are up
kubectl get pods -n pl

# Check Pixie Platform status
kubectl get pods -n pl \n
# Check Pixie Platform and PEM status
export PX_CLOUD_ADDR=@PLACEHOLDER@
px get viziers

# Check PEM stats
px get pems
```
`}
/>
2 changes: 2 additions & 0 deletions gatsby-node.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ const availableClouds = [
{
name: 'New Relic Cloud',
baseUrl: 'https://work.withpixie.ai',
cloudAddr: 'withpixie.ai',
},
{
name: 'Cosmic Cloud',
baseUrl: 'https://work.getcosmic.ai',
cloudAddr: 'getcosmic.ai',
},
];

Expand Down
1 change: 1 addition & 0 deletions src/components/cloudLinkProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import * as React from 'react';
const initialCloud = {
name: 'New Relic Cloud',
baseUrl: 'https://work.withpixe.ai',
cloudAddr: 'withpixie.ai',
};

export const CloudLinkContext = React.createContext(
Expand Down
3 changes: 2 additions & 1 deletion src/components/mdxComponents/baseComponents.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import AnchorTag from './anchor';
import CodeRenderer from './codeRenderer';
import ListItem from './listItem';
import HLink from './h-link';
import CloudLink from './cloud-link';
import { CloudLink, TemplatedCodeBlock } from './cloud-link';
import PoiTooltip from '../poi-tooltip/poi-tooltip';

const getChildren = (props) => props.children;
Expand Down Expand Up @@ -92,4 +92,5 @@ export default {
Alert,
PoiTooltip,
CloudLink: (props: any) => <CloudLink {...props} />,
TemplatedCodeBlock: (props: any) => <TemplatedCodeBlock {...props} />,
};
22 changes: 20 additions & 2 deletions src/components/mdxComponents/cloud-link.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import * as React from 'react';
import path from 'path';
import { makeStyles } from '@material-ui/core/styles';
import { CloudLinkContext } from '../cloudLinkProvider';
import CodeRenderer from './codeRenderer';

const useStyles = makeStyles((theme: Theme) => ({
link: {
Expand All @@ -36,11 +37,29 @@ const useStyles = makeStyles((theme: Theme) => ({
}));

interface Props {
code: string;
}

// eslint-disable-next-line arrow-body-style
export const TemplatedCodeBlock: React.FC<Props> = ({ code }) => {
return (
<CloudLinkContext.Consumer>
{({ selectedCloud }) => (
<CodeRenderer
code={code.replaceAll('@PLACEHOLDER@', selectedCloud.cloudAddr)}
language='bash'
/>
)}
</CloudLinkContext.Consumer>
);
};

interface CloudLinkProps {
children: string;
url: string;
}

const CloudLink: React.FC<Props> = ({ children, url }) => {
export const CloudLink: React.FC<CloudLinkProps> = ({ children, url }) => {
const classes = useStyles();
return (
<CloudLinkContext.Consumer>
Expand All @@ -52,4 +71,3 @@ const CloudLink: React.FC<Props> = ({ children, url }) => {
</CloudLinkContext.Consumer>
);
};
export default CloudLink;