yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-26 15:10:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix(docs): Upgrade Kubernetes Docs (#11359)

Browse Source 
* Add pipelineServiceClient config breaking changes

* Add Helm lint section to verify schema changes
This commit is contained in:
Akash Jain 2023-04-28 14:43:06 +05:30 committed by GitHub
parent 73d5a29ea4
commit c63ccc0639
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 67 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
openmetadata-docs-v1/content/v1.0.0/deployment/upgrade/kubernetes.md
View File

@ -137,6 +137,73 @@ in the dialog box choose Recreate Indexes to All
## Troubleshooting
### Helm Upgrade fails with additional property airflow not allowed
With Release 1.0.0, if you see your helm charts failing to deploy with the below issue -
```
Error: INSTALLATION FAILED: values don't meet the specifications of the schema(s) in the following chart(s):
openmetadata:
- global: Additional property airflow is not allowed
```
This means the values passed to the helm charts has a section global.airflow. As per the breaking changes mentioned [here](/deployment/upgrade/versions/013-to-100#airflow-configuration-&-pipeline-service-client), Airflow configs are replaced with pipelineServiceClient for Helm Charts.
The Helm Chart Values JSON Schema helps to catch the above breaking changes and this section will help you resolve and update your configurations for the same. You can read more about JSON Schema with Helm Charts [here](https://helm.sh/docs/topics/charts/#schema-files).
You will need to update the existing section of `global.airflow` values to match the new configurations.
⛔ Before 1.0.0 Helm Chart Release, the `global.airflow` section would be like -
```yaml
global:
...
airflow:
enabled: true
# endpoint url for airflow
host: http://openmetadata-dependencies-web.default.svc.cluster.local:8080
# possible values are "no-ssl", "ignore", "validate"
verifySsl: "no-ssl"
# Local path in Airflow Pod
sslCertificatePath: "/no/path"
auth:
username: admin
password:
secretRef: airflow-secrets
secretKey: openmetadata-airflow-password
openmetadata:
# this will be the api endpoint url of OpenMetadata Server
serverHostApiUrl: "http://openmetadata.default.svc.cluster.local:8585/api"
...
```
✅ After 1.0.0 Helm Chart Release, the `global.pipelineServiceClient` section will replace the above `airflow` section -
```yaml
global:
...
pipelineServiceClientConfig:
enabled: true
className: "org.openmetadata.service.clients.pipeline.airflow.AirflowRESTClient"
# endpoint url for airflow
apiEndpoint: http://openmetadata-dependencies-web.default.svc.cluster.local:8080
# this will be the api endpoint url of OpenMetadata Server
metadataApiEndpoint: http://openmetadata.default.svc.cluster.local:8585/api
# possible values are "no-ssl", "ignore", "validate"
verifySsl: "no-ssl"
ingestionIpInfoEnabled: false
# local path in Airflow Pod
sslCertificatePath: "/no/path"
auth:
username: admin
password:
secretRef: airflow-secrets
secretKey: openmetadata-airflow-password
...
```
Run the [helm lint](https://helm.sh/docs/helm/helm_lint/) command on your custom values after making the changes to validate with the JSON Schema.
### With 0.13.0 Release
If your helm dependencies upgrade fails with the below command result -