yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2026-01-07 13:07:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Improve docs for k8s with updated references (#16186)

Browse Source
This commit is contained in:
Akash Jain 2024-05-09 11:49:46 +05:30 committed by GitHub
parent eaf066312a
commit e890a6d807
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 34 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
openmetadata-docs/content/v1.3.x/deployment/kubernetes/faqs.md
View File

@ -212,3 +212,15 @@ MountVolume.SetUp failed for volume "openmetadata-dependencies-dags-pv" : rpc er
This error is typically related to EKS Cluster not able to reach to EFS File systems. You can check the security groups associated between the connectivity EFS and EKS. [Here is an article](https://github.com/kubernetes-sigs/aws-efs-csi-driver/blob/master/docs/efs-create-filesystem.md) which further describes the steps required to create Security Group Rules for EKS to use EFS over `port 2049`.
It can also happen if the mount targets are already available for EKS Nodes but the Nodes do not pick that up. In such cases, you can do an [AWS AutoScaling Group instance refresh](https://docs.aws.amazon.com/autoscaling/ec2/userguide/start-instance-refresh.html) in order for EKS nodes to get the available mount targets.
# How to customize OpenMetadata Dependencies Helm Chart with custom helm values
Our OpenMetadata Dependencies Helm Charts are internally depends on three sub-charts -
- [Bitnami MySQL](https://artifacthub.io/packages/helm/bitnami/mysql/9.7.2) (helm chart version 9.7.2)
- [OpenSearch](https://artifacthub.io/packages/helm/opensearch-project-helm-charts/opensearch/2.12.2) (helm chart version 2.12.2)
- [Airflow](https://artifacthub.io/packages/helm/airflow-helm/airflow/8.8.0) (helm chart version 8.8.0)
If you are looking to customize the deployments of any of the above dependencies, please refer to the above links for customizations of helm values for further references.
By default, OpenMetadata Dependencies helm chart provides initial generic customization of these helm values in order to get you started quickly. You can refer to the openmetadata-dependencies helm charts default values [here](https://github.com/open-metadata/openmetadata-helm-charts/blob/main/charts/deps/values.yaml).

2
openmetadata-docs/content/v1.3.x/deployment/kubernetes/values.md
View File

@ -238,7 +238,7 @@ This page list all the supported helm values for OpenMetadata Helm Charts.
| fullnameOverride | string | `"openmetadata"` |
| image.pullPolicy | string | `"Always"` |
| image.repository | string | `"docker.getcollate.io/openmetadata/server"` |
| image.tag | string | `1.3.3` |
| image.tag | string | `1.3.4` |
| imagePullSecrets | list | `[]` |
| ingress.annotations | object | `{}` |
| ingress.className | string | `""` |

8
openmetadata-docs/content/v1.3.x/quick-start/local-kubernetes-deployment.md
View File

@ -86,7 +86,7 @@ Run `kubectl get pods` to check whether all the pods for the dependencies are ru
```commandline
NAME READY STATUS RESTARTS AGE
elasticsearch-0 1/1 Running 0 4m26s
opensearch-0 1/1 Running 0 4m26s
mysql-0 1/1 Running 0 4m26s
openmetadata-dependencies-db-migrations-5984f795bc-t46wh 1/1 Running 0 4m26s
openmetadata-dependencies-scheduler-5b574858b6-75clt 1/1 Running 0 4m26s
@ -104,9 +104,9 @@ Please note that the pods names above as `openmetadata-dependencies-*` are part
{%/note%}
Helm Chart for OpenMetadata Dependencies uses the following helm charts:
- [Bitnami MySQL](https://artifacthub.io/packages/helm/bitnami/mysql/9.7.1) (helm chart version 9.7.1)
- [ElasticSearch](https://artifacthub.io/packages/helm/elastic/elasticsearch/7.16.3) (helm chart version 7.16.3)
- [Airflow](https://artifacthub.io/packages/helm/airflow-helm/airflow/8.6.1) (helm chart version 8.6.1)
- [Bitnami MySQL](https://artifacthub.io/packages/helm/bitnami/mysql/9.7.2) (helm chart version 9.7.2)
- [OpenSearch](https://artifacthub.io/packages/helm/opensearch-project-helm-charts/opensearch/2.12.2) (helm chart version 2.12.2)
- [Airflow](https://artifacthub.io/packages/helm/airflow-helm/airflow/8.8.0) (helm chart version 8.8.0)
### 5. Install OpenMetadata Helm Chart

12
openmetadata-docs/content/v1.4.x-SNAPSHOT/deployment/kubernetes/faqs.md
View File

@ -212,3 +212,15 @@ MountVolume.SetUp failed for volume "openmetadata-dependencies-dags-pv" : rpc er
This error is typically related to EKS Cluster not able to reach to EFS File systems. You can check the security groups associated between the connectivity EFS and EKS. [Here is an article](https://github.com/kubernetes-sigs/aws-efs-csi-driver/blob/master/docs/efs-create-filesystem.md) which further describes the steps required to create Security Group Rules for EKS to use EFS over `port 2049`.
It can also happen if the mount targets are already available for EKS Nodes but the Nodes do not pick that up. In such cases, you can do an [AWS AutoScaling Group instance refresh](https://docs.aws.amazon.com/autoscaling/ec2/userguide/start-instance-refresh.html) in order for EKS nodes to get the available mount targets.
# How to customize OpenMetadata Dependencies Helm Chart with custom helm values
Our OpenMetadata Dependencies Helm Charts are internally depends on three sub-charts -
- [Bitnami MySQL](https://artifacthub.io/packages/helm/bitnami/mysql/9.7.2) (helm chart version 9.7.2)
- [OpenSearch](https://artifacthub.io/packages/helm/opensearch-project-helm-charts/opensearch/2.12.2) (helm chart version 2.12.2)
- [Airflow](https://artifacthub.io/packages/helm/airflow-helm/airflow/8.8.0) (helm chart version 8.8.0)
If you are looking to customize the deployments of any of the above dependencies, please refer to the above links for customizations of helm values for further references.
By default, OpenMetadata Dependencies helm chart provides initial generic customization of these helm values in order to get you started quickly. You can refer to the openmetadata-dependencies helm charts default values [here](https://github.com/open-metadata/openmetadata-helm-charts/blob/main/charts/deps/values.yaml).

2
openmetadata-docs/content/v1.4.x-SNAPSHOT/deployment/kubernetes/values.md
View File

@ -238,7 +238,7 @@ This page list all the supported helm values for OpenMetadata Helm Charts.
| fullnameOverride | string | `"openmetadata"` |
| image.pullPolicy | string | `"Always"` |
| image.repository | string | `"docker.getcollate.io/openmetadata/server"` |
| image.tag | string | `1.3.3` |
| image.tag | string | `1.3.4` |
| imagePullSecrets | list | `[]` |
| ingress.annotations | object | `{}` |
| ingress.className | string | `""` |

8
openmetadata-docs/content/v1.4.x-SNAPSHOT/quick-start/local-kubernetes-deployment.md
View File

@ -86,7 +86,7 @@ Run `kubectl get pods` to check whether all the pods for the dependencies are ru
```commandline
NAME READY STATUS RESTARTS AGE
elasticsearch-0 1/1 Running 0 4m26s
opensearch-0 1/1 Running 0 4m26s
mysql-0 1/1 Running 0 4m26s
openmetadata-dependencies-db-migrations-5984f795bc-t46wh 1/1 Running 0 4m26s
openmetadata-dependencies-scheduler-5b574858b6-75clt 1/1 Running 0 4m26s
@ -104,9 +104,9 @@ Please note that the pods names above as `openmetadata-dependencies-*` are part
{%/note%}
Helm Chart for OpenMetadata Dependencies uses the following helm charts:
- [Bitnami MySQL](https://artifacthub.io/packages/helm/bitnami/mysql/9.7.1) (helm chart version 9.7.1)
- [ElasticSearch](https://artifacthub.io/packages/helm/elastic/elasticsearch/7.16.3) (helm chart version 7.16.3)
- [Airflow](https://artifacthub.io/packages/helm/airflow-helm/airflow/8.6.1) (helm chart version 8.6.1)
- [Bitnami MySQL](https://artifacthub.io/packages/helm/bitnami/mysql/9.7.2) (helm chart version 9.7.2)
- [OpenSearch](https://artifacthub.io/packages/helm/opensearch-project-helm-charts/opensearch/2.12.2) (helm chart version 2.12.2)
- [Airflow](https://artifacthub.io/packages/helm/airflow-helm/airflow/8.8.0) (helm chart version 8.8.0)
### 5. Install OpenMetadata Helm Chart