yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-16 19:28:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Update Troublesbooting docs for SSL to new env and keys (#14654)

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

* Update PipelineServiceClientConfig
This commit is contained in:
Mohit Yadav 2024-01-09 21:24:56 +05:30 committed by GitHub
parent 3ed8a4223f
commit dbd9f1381a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 88 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
openmetadata-docs/content/v1.0.x/deployment/security/azure/bare-metal.md
View File

@ -62,11 +62,23 @@ airflowConfiguration:
**After 0.12.1** **After 0.12.1**
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080} apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
username: ${AIRFLOW_USERNAME:-admin}
password: ${AIRFLOW_PASSWORD:-admin}
metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api} 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 %} {% note %}

10
openmetadata-docs/content/v1.0.x/deployment/security/enable-ssl/ssl-troubleshooting.md
View File

@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=validate PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
``` ```
- In **bare metal**: - In **bare metal**:
@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "validate" verifySSL: "validate"
sslConfig: sslConfig:
validate: validate:
@ -91,7 +91,7 @@ When doing any call to the secured OM server, the certificate validation will be
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=ignore PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
``` ```
- In **bare metal**: - In **bare metal**:
@ -99,7 +99,7 @@ AIRFLOW_VERIFY_SSL=ignore
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "ignore" verifySSL: "ignore"
``` ```

10
openmetadata-docs/content/v1.1.x/deployment/security/enable-ssl/ssl-troubleshooting.md
View File

@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=validate PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
``` ```
- In **bare metal**: - In **bare metal**:
@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "validate" verifySSL: "validate"
sslConfig: sslConfig:
validate: validate:
@ -92,7 +92,7 @@ When doing any call to the secured OM server, the certificate validation will be
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=ignore PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
``` ```
- In **bare metal**: - In **bare metal**:
@ -100,7 +100,7 @@ AIRFLOW_VERIFY_SSL=ignore
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "ignore" verifySSL: "ignore"
``` ```

21
openmetadata-docs/content/v1.1.x/deployment/security/okta/bare-metal.md
View File

@ -59,11 +59,24 @@ airflowConfiguration:
**After 0.12.1** **After 0.12.1**
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080} apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
username: ${AIRFLOW_USERNAME:-admin}
password: ${AIRFLOW_PASSWORD:-admin}
metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api} 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 **Note:** Follow [this](/how-to-guides/quick-start-guide-for-admins/bots) guide to configure the `ingestion-bot` credentials for

10
openmetadata-docs/content/v1.2.x/deployment/security/enable-ssl/ssl-troubleshooting.md
View File

@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=validate PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
``` ```
- In **bare metal**: - In **bare metal**:
@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "validate" verifySSL: "validate"
sslConfig: sslConfig:
validate: validate:
@ -92,7 +92,7 @@ When doing any call to the secured OM server, the certificate validation will be
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=ignore PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
``` ```
- In **bare metal**: - In **bare metal**:
@ -100,7 +100,7 @@ AIRFLOW_VERIFY_SSL=ignore
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "ignore" verifySSL: "ignore"
``` ```

23
openmetadata-docs/content/v1.2.x/deployment/security/okta/bare-metal.md
View File

@ -42,7 +42,7 @@ Finally, update the Airflow information:
**Before 0.12.1** **Before 0.12.1**
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080} apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080}
username: ${AIRFLOW_USERNAME:-admin} username: ${AIRFLOW_USERNAME:-admin}
password: ${AIRFLOW_PASSWORD:-admin} password: ${AIRFLOW_PASSWORD:-admin}
@ -60,11 +60,24 @@ airflowConfiguration:
**After 0.12.1** **After 0.12.1**
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080} apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
username: ${AIRFLOW_USERNAME:-admin}
password: ${AIRFLOW_PASSWORD:-admin}
metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api} 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 **Note:** Follow [this](/developers/bots) guide to configure the `ingestion-bot` credentials for

10
openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/enable-ssl/ssl-troubleshooting.md
View File

@ -57,8 +57,8 @@ We specify which public certificate must be used to validate the OM server conne
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=validate PIPELINE_SERVICE_CLIENT_VERIFY_SSL=validate
AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow PIPELINE_SERVICE_CLIENT_SSL_CERT_PATH=/path/to/certificate/in/airflow
``` ```
- In **bare metal**: - In **bare metal**:
@ -66,7 +66,7 @@ AIRFLOW_SSL_CERT_PATH=/path/to/certificate/in/airflow
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "validate" verifySSL: "validate"
sslConfig: sslConfig:
validate: validate:
@ -92,7 +92,7 @@ When doing any call to the secured OM server, the certificate validation will be
- In **docker**: - In **docker**:
```yaml ```yaml
AIRFLOW_VERIFY_SSL=ignore PIPELINE_SERVICE_CLIENT_VERIFY_SSL=ignore
``` ```
- In **bare metal**: - In **bare metal**:
@ -100,7 +100,7 @@ AIRFLOW_VERIFY_SSL=ignore
Edit the `conf/openmetadata.yaml` file: Edit the `conf/openmetadata.yaml` file:
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
verifySSL: "ignore" verifySSL: "ignore"
``` ```

21
openmetadata-docs/content/v1.3.x-SNAPSHOT/deployment/security/okta/bare-metal.md
View File

@ -60,11 +60,24 @@ airflowConfiguration:
**After 0.12.1** **After 0.12.1**
```yaml ```yaml
airflowConfiguration: pipelineServiceClientConfiguration:
apiEndpoint: ${AIRFLOW_HOST:-http://localhost:8080} apiEndpoint: ${PIPELINE_SERVICE_CLIENT_ENDPOINT:-http://localhost:8080}
username: ${AIRFLOW_USERNAME:-admin}
password: ${AIRFLOW_PASSWORD:-admin}
metadataApiEndpoint: ${SERVER_HOST_API_URL:-http://localhost:8585/api} 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 **Note:** Follow [this](/developers/bots) guide to configure the `ingestion-bot` credentials for