From dbd9f1381a1ef8bc1486a184f49f21ac776c1789 Mon Sep 17 00:00:00 2001
From: Mohit Yadav <105265192+mohityadav766@users.noreply.github.com>
Date: Tue, 9 Jan 2024 21:24:56 +0530
Subject: [PATCH] [DOCS] Update Troublesbooting docs for SSL to new env and
 keys (#14654)

* Update Troublesbooting docs for SSL to new env and keys in openmetadata.yaml

* Update PipelineServiceClientConfig
---
 .../deployment/security/azure/bare-metal.md   | 20 ++++++++++++----
 .../enable-ssl/ssl-troubleshooting.md         | 10 ++++----
 .../enable-ssl/ssl-troubleshooting.md         | 10 ++++----
 .../deployment/security/okta/bare-metal.md    | 21 +++++++++++++----
 .../enable-ssl/ssl-troubleshooting.md         | 10 ++++----
 .../deployment/security/okta/bare-metal.md    | 23 +++++++++++++++----
 .../enable-ssl/ssl-troubleshooting.md         | 10 ++++----
 .../deployment/security/okta/bare-metal.md    | 21 +++++++++++++----
 8 files changed, 88 insertions(+), 37 deletions(-)

diff --git a/openmetadata-docs/content/v1.0.x/deployment/security/azure/bare-metal.md b/openmetadata-docs/content/v1.0.x/deployment/security/azure/bare-metal.md
index 2b9eb6c1ed5..27c451ee213 100644
--- a/openmetadata-docs/content/v1.0.x/deployment/security/azure/bare-metal.md
+++ b/openmetadata-docs/content/v1.0.x/deployment/security/azure/bare-metal.md
@@ -62,11 +62,23 @@ airflowConfiguration:
 **After 0.12.1**
 
 ```yaml
-airflowConfiguration:
-  apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
-  username: ${AIRFLOW_USERNAME:-admin}
-  password: ${AIRFLOW_PASSWORD:-admin}
+pipelineServiceClientConfiguration:
+  apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
   metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api}
+  ingestionIpInfoEnabled: ${PIPELINE_SERVICE_IP_INFO_ENABLED:-false}
+  hostIp: ${PIPELINE_SERVICE_CLIENT_HOST_IP:-""}
+  verifySSL: ${PIPELINE_SERVICE_CLIENT_VERIFY_SSL:-"no-ssl"} # Possible values are "no-ssl", "ignore", "validate"
+  sslConfig:
+    certificatePath: ${PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH:-""} # Local path for the Pipeline Service Client
+
+  # Default required parameters for Airflow as Pipeline Service Client
+  parameters:
+    username: ${AIRFLOW_USERNAME:-admin}
+    password: ${AIRFLOW_PASSWORD:-admin}
+    timeout: ${AIRFLOW_TIMEOUT:-10}
+    # If we need to use SSL to reach Airflow
+    truststorePath: ${AIRFLOW_TRUST_STORE_PATH:-""}
+    truststorePassword: ${AIRFLOW_TRUST_STORE_PASSWORD:-""}
 ```
 
 {% note %}
diff --git a/openmetadata-docs/content/v1.0.x/deployment/security/enable-ssl/ssl-troubleshooting.md b/openmetadata-docs/content/v1.0.x/deployment/security/enable-ssl/ssl-troubleshooting.md
index 1f9f412fc2a..b52231cd6d7 100644
--- a/openmetadata-docs/content/v1.0.x/deployment/security/enable-ssl/ssl-troubleshooting.md
+++ b/openmetadata-docs/content/v1.0.x/deployment/security/enable-ssl/ssl-troubleshooting.md
@@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=validate
-AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
+PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
 ```
 
 - In **bare metal**:
@@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "validate"
   sslConfig:
     validate:
@@ -91,7 +91,7 @@ When doing any call to the secured OM server, the certificate validation will be
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=ignore
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
 ```
 
 - In **bare metal**:
@@ -99,7 +99,7 @@ AIRFLOW_VERIFY_SSL=ignore
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "ignore"
 ```
 
diff --git a/openmetadata-docs/content/v1.1.x/deployment/security/enable-ssl/ssl-troubleshooting.md b/openmetadata-docs/content/v1.1.x/deployment/security/enable-ssl/ssl-troubleshooting.md
index eb59d4961e1..5bc25fe020f 100644
--- a/openmetadata-docs/content/v1.1.x/deployment/security/enable-ssl/ssl-troubleshooting.md
+++ b/openmetadata-docs/content/v1.1.x/deployment/security/enable-ssl/ssl-troubleshooting.md
@@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=validate
-AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
+PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
 ```
 
 - In **bare metal**:
@@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "validate"
   sslConfig:
     validate:
@@ -92,7 +92,7 @@ When doing any call to the secured OM server, the certificate validation will be
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=ignore
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
 ```
 
 - In **bare metal**:
@@ -100,7 +100,7 @@ AIRFLOW_VERIFY_SSL=ignore
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "ignore"
 ```
 
diff --git a/openmetadata-docs/content/v1.1.x/deployment/security/okta/bare-metal.md b/openmetadata-docs/content/v1.1.x/deployment/security/okta/bare-metal.md
index 498cbf72b2a..f453927439f 100644
--- a/openmetadata-docs/content/v1.1.x/deployment/security/okta/bare-metal.md
+++ b/openmetadata-docs/content/v1.1.x/deployment/security/okta/bare-metal.md
@@ -59,11 +59,24 @@ airflowConfiguration:
 **After 0.12.1**
 
 ```yaml
-airflowConfiguration:
-  apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
-  username: ${AIRFLOW_USERNAME:-admin}
-  password: ${AIRFLOW_PASSWORD:-admin}
+pipelineServiceClientConfiguration:
+  apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
   metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api}
+  ingestionIpInfoEnabled: ${PIPELINE_SERVICE_IP_INFO_ENABLED:-false}
+  hostIp: ${PIPELINE_SERVICE_CLIENT_HOST_IP:-""}
+  healthCheckInterval: ${PIPELINE_SERVICE_CLIENT_HEALTH_CHECK_INTERVAL:-300}
+  verifySSL: ${PIPELINE_SERVICE_CLIENT_VERIFY_SSL:-"no-ssl"} # Possible values are "no-ssl", "ignore", "validate"
+  sslConfig:
+    certificatePath: ${PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH:-""} # Local path for the Pipeline Service Client
+
+  # Default required parameters for Airflow as Pipeline Service Client
+  parameters:
+    username: ${AIRFLOW_USERNAME:-admin}
+    password: ${AIRFLOW_PASSWORD:-admin}
+    timeout: ${AIRFLOW_TIMEOUT:-10}
+    # If we need to use SSL to reach Airflow
+    truststorePath: ${AIRFLOW_TRUST_STORE_PATH:-""}
+    truststorePassword: ${AIRFLOW_TRUST_STORE_PASSWORD:-""}
 ```
 
 **Note:** Follow [this](/how-to-guides/quick-start-guide-for-admins/bots) guide to configure the `ingestion-bot` credentials for
diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/enable-ssl/ssl-troubleshooting.md b/openmetadata-docs/content/v1.2.x/deployment/security/enable-ssl/ssl-troubleshooting.md
index a95db226a82..3c654e4867b 100644
--- a/openmetadata-docs/content/v1.2.x/deployment/security/enable-ssl/ssl-troubleshooting.md
+++ b/openmetadata-docs/content/v1.2.x/deployment/security/enable-ssl/ssl-troubleshooting.md
@@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=validate
-AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
+PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
 ```
 
 - In **bare metal**:
@@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "validate"
   sslConfig:
     validate:
@@ -92,7 +92,7 @@ When doing any call to the secured OM server, the certificate validation will be
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=ignore
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
 ```
 
 - In **bare metal**:
@@ -100,7 +100,7 @@ AIRFLOW_VERIFY_SSL=ignore
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "ignore"
 ```
 
diff --git a/openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md b/openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md
index fd55426cc78..69bbfff510b 100644
--- a/openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md
+++ b/openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md
@@ -42,7 +42,7 @@ Finally, update the Airflow information:
 **Before 0.12.1**
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
   username: ${AIRFLOW_USERNAME:-admin}
   password: ${AIRFLOW_PASSWORD:-admin}
@@ -60,11 +60,24 @@ airflowConfiguration:
 **After 0.12.1**
 
 ```yaml
-airflowConfiguration:
-  apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
-  username: ${AIRFLOW_USERNAME:-admin}
-  password: ${AIRFLOW_PASSWORD:-admin}
+pipelineServiceClientConfiguration:
+  apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
   metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api}
+  ingestionIpInfoEnabled: ${PIPELINE_SERVICE_IP_INFO_ENABLED:-false}
+  hostIp: ${PIPELINE_SERVICE_CLIENT_HOST_IP:-""}
+  healthCheckInterval: ${PIPELINE_SERVICE_CLIENT_HEALTH_CHECK_INTERVAL:-300}
+  verifySSL: ${PIPELINE_SERVICE_CLIENT_VERIFY_SSL:-"no-ssl"} # Possible values are "no-ssl", "ignore", "validate"
+  sslConfig:
+    certificatePath: ${PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH:-""} # Local path for the Pipeline Service Client
+    
+  # Default required parameters for Airflow as Pipeline Service Client
+  parameters:
+    username: ${AIRFLOW_USERNAME:-admin}
+    password: ${AIRFLOW_PASSWORD:-admin}
+    timeout: ${AIRFLOW_TIMEOUT:-10}
+    # If we need to use SSL to reach Airflow
+    truststorePath: ${AIRFLOW_TRUST_STORE_PATH:-""}
+    truststorePassword: ${AIRFLOW_TRUST_STORE_PASSWORD:-""}
 ```
 
 **Note:** Follow [this](/developers/bots) guide to configure the `ingestion-bot` credentials for
diff --git a/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/enable-ssl/ssl-troubleshooting.md b/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/enable-ssl/ssl-troubleshooting.md
index 9fc73570974..2fda1d95e6d 100644
--- a/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/enable-ssl/ssl-troubleshooting.md
+++ b/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/enable-ssl/ssl-troubleshooting.md
@@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=validate
-AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
+PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
 ```
 
 - In **bare metal**:
@@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "validate"
   sslConfig:
     validate:
@@ -92,7 +92,7 @@ When doing any call to the secured OM server, the certificate validation will be
 - In **docker**:
 
 ```yaml
-AIRFLOW_VERIFY_SSL=ignore
+PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
 ```
 
 - In **bare metal**:
@@ -100,7 +100,7 @@ AIRFLOW_VERIFY_SSL=ignore
 Edit the `conf/openmetadata.yaml` file:
 
 ```yaml
-airflowConfiguration:
+pipelineServiceClientConfiguration:
   verifySSL: "ignore"
 ```
 
diff --git a/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/okta/bare-metal.md b/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/okta/bare-metal.md
index 0cf9848f10d..dec3c81d25f 100644
--- a/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/okta/bare-metal.md
+++ b/openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/okta/bare-metal.md
@@ -60,11 +60,24 @@ airflowConfiguration:
 **After 0.12.1**
 
 ```yaml
-airflowConfiguration:
-  apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
-  username: ${AIRFLOW_USERNAME:-admin}
-  password: ${AIRFLOW_PASSWORD:-admin}
+pipelineServiceClientConfiguration:
+  apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
   metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api}
+  ingestionIpInfoEnabled: ${PIPELINE_SERVICE_IP_INFO_ENABLED:-false}
+  hostIp: ${PIPELINE_SERVICE_CLIENT_HOST_IP:-""}
+  healthCheckInterval: ${PIPELINE_SERVICE_CLIENT_HEALTH_CHECK_INTERVAL:-300}
+  verifySSL: ${PIPELINE_SERVICE_CLIENT_VERIFY_SSL:-"no-ssl"} # Possible values are "no-ssl", "ignore", "validate"
+  sslConfig:
+    certificatePath: ${PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH:-""} # Local path for the Pipeline Service Client
+
+  # Default required parameters for Airflow as Pipeline Service Client
+  parameters:
+    username: ${AIRFLOW_USERNAME:-admin}
+    password: ${AIRFLOW_PASSWORD:-admin}
+    timeout: ${AIRFLOW_TIMEOUT:-10}
+    # If we need to use SSL to reach Airflow
+    truststorePath: ${AIRFLOW_TRUST_STORE_PATH:-""}
+    truststorePassword: ${AIRFLOW_TRUST_STORE_PASSWORD:-""}
 ```
 
 **Note:** Follow [this](/developers/bots) guide to configure the `ingestion-bot` credentials for