diff --git a/content/en/02-installing-pixie/03-install-guides/01-hosted-pixie/01-cosmic-cloud.md b/content/en/02-installing-pixie/03-install-guides/01-hosted-pixie/01-cosmic-cloud.md index 2327afb..88d3530 100644 --- a/content/en/02-installing-pixie/03-install-guides/01-hosted-pixie/01-cosmic-cloud.md +++ b/content/en/02-installing-pixie/03-install-guides/01-hosted-pixie/01-cosmic-cloud.md @@ -47,8 +47,8 @@ To deploy Pixie using the CLI: ```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 diff --git a/content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/index.md b/content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/index.md index ad0c87d..40097fd 100644 --- a/content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/index.md +++ b/content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie/index.md @@ -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: diff --git a/content/en/02-installing-pixie/04-install-schemes/01-cli.md b/content/en/02-installing-pixie/04-install-schemes/01-cli.md index b8d477e..6411793 100644 --- a/content/en/02-installing-pixie/04-install-schemes/01-cli.md +++ b/content/en/02-installing-pixie/04-install-schemes/01-cli.md @@ -103,22 +103,21 @@ rpm -i pixie-px.x86_64.rpm Please refer to Environment-Specific Configurations for other configurations that should be set for your specific Kubernetes environment. -```bash + -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= -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= +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. diff --git a/content/en/02-installing-pixie/04-install-schemes/02-yaml.md b/content/en/02-installing-pixie/04-install-schemes/02-yaml.md index a8d7d66..1e35f8a 100644 --- a/content/en/02-installing-pixie/04-install-schemes/02-yaml.md +++ b/content/en/02-installing-pixie/04-install-schemes/02-yaml.md @@ -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 + If your cluster fails any checks, you may still proceed with installation, but it is unlikely that Pixie will work on your cluster. @@ -45,20 +48,21 @@ Run the following CLI command to extract Pixie's manifest files: Please refer to Environment-Specific Configurations for other configurations that should be set for your specific Kubernetes environment. -```bash + - +export PX_CLOUD_ADDR=@PLACEHOLDER@ +px deploy --extract_yaml ./ --deploy_key \n # Extract YAML (OLM already exists on cluster). -px deploy --extract_yaml ./ --deploy_key --deploy_olm=false - +export PX_CLOUD_ADDR=@PLACEHOLDER@ +px deploy --extract_yaml ./ --deploy_key --deploy_olm=false \n # Extract YAML (Self-hosting Pixie Cloud). -px deploy --extract_yaml ./ --deploy_key --dev_cloud_namespace plc - +px deploy --extract_yaml ./ --deploy_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 --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. @@ -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 admin page or run: -```bash + diff --git a/content/en/02-installing-pixie/04-install-schemes/03-helm.md b/content/en/02-installing-pixie/04-install-schemes/03-helm.md index b33d6bd..06d50bd 100644 --- a/content/en/02-installing-pixie/04-install-schemes/03-helm.md +++ b/content/en/02-installing-pixie/04-install-schemes/03-helm.md @@ -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 + If your cluster fails any checks, you may still proceed with installation, but it is unlikely that Pixie will work on your cluster. @@ -47,25 +50,22 @@ Deploy Pixie in your target cluster by running: Please refer to Environment-Specific Configurations for other configurations that should be set for your specific Kubernetes environment. -```bash + --set deployKey= --set clusterName= --namespace pl --create-namespace - +helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=@PLACEHOLDER@ --set deployKey= --set clusterName= --namespace pl --create-namespace \n # Install the Pixie chart (OLM already exists on cluster). -helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr= --set deployKey= --set clusterName= --namespace pl --create-namespace --set deployOLM=false - +helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=@PLACEHOLDER@ --set deployKey= --set clusterName= --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= --set clusterName= --namespace pl --create-namespace --set devCloudNamespace=plc - +helm install pixie pixie-operator/pixie-operator-chart --set deployKey= --set clusterName= --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= --set deployKey= --set clusterName= --namespace pl --create-namespace --set deployOLM=false --set pemMemoryLimit=1Gi -``` +helm install pixie pixie-operator/pixie-operator-chart --set cloudAddr=@PLACEHOLDER@ --set deployKey= --set clusterName= --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. @@ -92,13 +92,13 @@ helm install pixie pixie-vizier/vizier-chart --set deployKey=admin page or run: -```bash + diff --git a/gatsby-node.js b/gatsby-node.js index d060182..8ccc0bf 100644 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -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', }, ]; diff --git a/src/components/cloudLinkProvider.tsx b/src/components/cloudLinkProvider.tsx index 5a38e93..f79181a 100644 --- a/src/components/cloudLinkProvider.tsx +++ b/src/components/cloudLinkProvider.tsx @@ -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( diff --git a/src/components/mdxComponents/baseComponents.tsx b/src/components/mdxComponents/baseComponents.tsx index 1528955..d655541 100644 --- a/src/components/mdxComponents/baseComponents.tsx +++ b/src/components/mdxComponents/baseComponents.tsx @@ -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; @@ -92,4 +92,5 @@ export default { Alert, PoiTooltip, CloudLink: (props: any) => , + TemplatedCodeBlock: (props: any) => , }; diff --git a/src/components/mdxComponents/cloud-link.tsx b/src/components/mdxComponents/cloud-link.tsx index 0b72525..dc9b254 100644 --- a/src/components/mdxComponents/cloud-link.tsx +++ b/src/components/mdxComponents/cloud-link.tsx @@ -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: { @@ -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 = ({ code }) => { + return ( + + {({ selectedCloud }) => ( + + )} + + ); +}; + +interface CloudLinkProps { children: string; url: string; } -const CloudLink: React.FC = ({ children, url }) => { +export const CloudLink: React.FC = ({ children, url }) => { const classes = useStyles(); return ( @@ -52,4 +71,3 @@ const CloudLink: React.FC = ({ children, url }) => { ); }; -export default CloudLink;