From 9ca05b0e12875ac959c01d39efa0e62a21d33c6e Mon Sep 17 00:00:00 2001 From: Hannah Troisi Date: Thu, 18 Aug 2022 16:44:07 -0700 Subject: [PATCH 1/4] Add dev_cloud_namespace flag to Helm, YAML install guides. Signed-off-by: Hannah Troisi --- .../04-install-schemes/02-yaml.md | 12 ++++++++++-- .../04-install-schemes/03-helm.md | 6 +++++- 2 files changed, 15 insertions(+), 3 deletions(-) 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 2e8a9e5c..96c659d1 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 @@ -34,7 +34,11 @@ Create a deployment key following the directions [here](/reference/admin/deploy- Create a directory to save Pixie's manifest files and run the following CLI commands to extract them: - If your cluster already has Operator Lifecycle Manager (OLM) deployed, install Pixie using the `deploy_olm=false` flag. + If you are self-hosting Pixie Cloud use the `--dev_cloud_namespace plc` flag. + + + + If your cluster already has Operator Lifecycle Manager (OLM) deployed, use the `deploy_olm=false` flag. @@ -42,13 +46,17 @@ Create a directory to save Pixie's manifest files and run the following CLI comm ```bash + +# Extract YAML (No OLM present on cluster). +px deploy --extract_yaml --deploy_key + # Extract YAML (No OLM present on cluster). px deploy --extract_yaml --deploy_key # Extract YAML (OLM already exists on cluster). px deploy --extract_yaml --deploy_key --deploy_olm=false -# Deploy Pixie with a specific memory limit (2Gi is the default, 1Gi is the minimum recommended) +# Extract YAML (configure Pixie with a specific memory limit - 2Gi is the default, 1Gi is the minimum recommended) px deploy --extract_yaml --deploy_key --pem_memory_limit=1Gi ``` 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 10c7f2ae..c1d90a2c 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 @@ -36,7 +36,11 @@ Create a deployment key following the directions [here](/reference/admin/deploy- Deploy Pixie in your target cluster by running: - If your cluster already has Operator Lifecycle Manager (OLM) deployed, install Pixie using the `deployOLM=false` flag. + If you are self-hosting Pixie Cloud set `devCloudNamespace plc` flag. + + + + If your cluster already has Operator Lifecycle Manager (OLM) deployed, set `deployOLM=false`. From 4a2954f66782efa0ea385992c22c8d687c28a68a Mon Sep 17 00:00:00 2001 From: Hannah Troisi Date: Thu, 18 Aug 2022 16:50:44 -0700 Subject: [PATCH 2/4] tweak Signed-off-by: Hannah Troisi --- .../en/02-installing-pixie/04-install-schemes/02-yaml.md | 8 ++++---- .../en/02-installing-pixie/04-install-schemes/03-helm.md | 5 ++++- 2 files changed, 8 insertions(+), 5 deletions(-) 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 96c659d1..1d752571 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 @@ -34,7 +34,7 @@ Create a deployment key following the directions [here](/reference/admin/deploy- Create a directory to save Pixie's manifest files and run the following CLI commands to extract them: - If you are self-hosting Pixie Cloud use the `--dev_cloud_namespace plc` flag. + If you are self-hosting Pixie Cloud, use the `--dev_cloud_namespace plc` flag. @@ -50,12 +50,12 @@ Create a directory to save Pixie's manifest files and run the following CLI comm # Extract YAML (No OLM present on cluster). px deploy --extract_yaml --deploy_key -# Extract YAML (No OLM present on cluster). -px deploy --extract_yaml --deploy_key - # Extract YAML (OLM already exists on cluster). px deploy --extract_yaml --deploy_key --deploy_olm=false +# Extract YAML (Self-hosting Pixie Cloud). +px deploy --extract_yaml --deploy_key --dev_cloud_namespace plc + # Extract YAML (configure Pixie with a specific memory limit - 2Gi is the default, 1Gi is the minimum recommended) px deploy --extract_yaml --deploy_key --pem_memory_limit=1Gi 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 c1d90a2c..9bbcc630 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 @@ -36,7 +36,7 @@ Create a deployment key following the directions [here](/reference/admin/deploy- Deploy Pixie in your target cluster by running: - If you are self-hosting Pixie Cloud set `devCloudNamespace plc` flag. + If you are self-hosting Pixie Cloud, set `devCloudNamespace`. @@ -60,6 +60,9 @@ helm install pixie pixie-operator/pixie-operator-chart --set deployKey= --set clusterName= --namespace pl --create-namespace --set deployOLM=false +# 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 + # 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 deployKey= --set clusterName= --namespace pl --create-namespace --set deployOLM=false --set pemMemoryLimit=1Gi ``` From 67b53bb6d4d6aa403e66672a08d13e8327374f76 Mon Sep 17 00:00:00 2001 From: Hannah Troisi Date: Thu, 18 Aug 2022 16:52:57 -0700 Subject: [PATCH 3/4] Tweak Signed-off-by: Hannah Troisi --- content/en/02-installing-pixie/04-install-schemes/02-yaml.md | 1 - 1 file changed, 1 deletion(-) 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 1d752571..22bd0dc4 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 @@ -46,7 +46,6 @@ Create a directory to save Pixie's manifest files and run the following CLI comm ```bash - # Extract YAML (No OLM present on cluster). px deploy --extract_yaml --deploy_key From 14b4f67ef76c2911ab55c1e04885691484f02bb1 Mon Sep 17 00:00:00 2001 From: Hannah Troisi Date: Fri, 19 Aug 2022 11:05:03 -0700 Subject: [PATCH 4/4] Tweak Signed-off-by: Hannah Troisi --- .../04-install-schemes/02-yaml.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) 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 22bd0dc4..74766785 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 @@ -31,7 +31,7 @@ Create a deployment key following the directions [here](/reference/admin/deploy- ## 4. Extract Manifests -Create a directory to save Pixie's manifest files and run the following CLI commands to extract them: +Run the following CLI command to extract Pixie's manifest files: If you are self-hosting Pixie Cloud, use the `--dev_cloud_namespace plc` flag. @@ -47,16 +47,16 @@ Create a directory to save Pixie's manifest files and run the following CLI comm ```bash # Extract YAML (No OLM present on cluster). -px deploy --extract_yaml --deploy_key +px deploy --extract_yaml ./ --deploy_key # Extract YAML (OLM already exists on cluster). -px deploy --extract_yaml --deploy_key --deploy_olm=false +px deploy --extract_yaml ./ --deploy_key --deploy_olm=false # 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 # Extract YAML (configure Pixie with a specific memory limit - 2Gi is the default, 1Gi is the minimum recommended) -px deploy --extract_yaml --deploy_key --pem_memory_limit=1Gi +px deploy --extract_yaml ./ --deploy_key --pem_memory_limit=1Gi ``` @@ -67,8 +67,9 @@ px deploy --extract_yaml --deploy_key +# Deploy Pixie +tar -xvf yamls.tar +kubectl apply -f pixie_yamls/ ``` Pixie will deploy pods to the `pl`, `px-operator`, and `olm`(if deploying the OLM) namespaces.