From cd000a799e9d8fe8d03726d7a66a9ae574d13250 Mon Sep 17 00:00:00 2001 From: David Schmidt Date: Wed, 19 Jun 2024 15:51:55 +0200 Subject: [PATCH] feat(image registry): add documentation of schema registry override --- charts/datahub/README.md | 9 ++++++++- charts/datahub/subcharts/acryl-datahub-actions/README.md | 1 + charts/datahub/subcharts/datahub-frontend/README.md | 5 +++-- charts/datahub/subcharts/datahub-gms/README.md | 5 +++-- .../datahub/subcharts/datahub-ingestion-cron/README.md | 3 ++- charts/datahub/subcharts/datahub-mae-consumer/README.md | 7 ++++--- charts/datahub/subcharts/datahub-mce-consumer/README.md | 5 +++-- 7 files changed, 24 insertions(+), 11 deletions(-) diff --git a/charts/datahub/README.md b/charts/datahub/README.md index 9bfd248fd..5954d80e8 100644 --- a/charts/datahub/README.md +++ b/charts/datahub/README.md @@ -104,7 +104,7 @@ helm install datahub datahub/datahub --values <> | postgresqlSetupJob.extraSidecars | list | `[]` | Add additional sidecar containers to the job pod | | datahubSystemUpdate.extraSidecars | list | `[]` | Add additional sidecar containers to the job pod | | global.strict_mode | boolean | true | Enables validations in helm charts to ensure features work as expected. Recommended NOT TO CHANGE. | -| global.datahub_standalone_consumers_enabled | boolean | false | Enable standalone consumers for kafka | +| global.datahub_standalone_consumers_enabled | boolean | false | Enable standalone consumers for kafka | | global.datahub_analytics_enabled | boolean | true | Enable datahub usage analytics | | global.datahub.appVersion | string | `"1.0"` | App version for annotation | | global.datahub.gms.protocol | string | `"http"` | Protocol of GMS service | @@ -159,10 +159,12 @@ helm install datahub datahub/datahub --values <> | mysqlSetupJob.password.secretRef | string | `"mysql-secrets"` | Secret that contains the mysqlSetupJob SQL password (overrides global value) | | mysqlSetupJob.password.secretKey | string | `"mysql-password"` | Secret key that contains the mysqlSetupJob SQL password (overrides global value) | | mysqlSetupJob.password.value | string | `"mysql-password"` | Alternative to using the secret above, uses raw string value for mysqlSetupJob SQL login (overrides global value) | +| mysqlSetupJob.image.registry | string | `"docker.io"` | Default image registry to be used by the job. | | postgresqlSetupJob.username | string | `root` | SQL username for postgresqlSetupJob (overrides global value) | | postgresqlSetupJob.password.secretRef | string | `"mysql-secrets"` | Secret that contains the postgresqlSetupJob SQL password (overrides global value) | | postgresqlSetupJob.password.secretKey | string | `"mysql-password"` | Secret key that contains the postgresqlSetupJob SQL password (overrides global value) | | postgresqlSetupJob.password.value | string | `"mysql-password"` | Alternative to using the secret above, uses raw string value for postgresqlSetupJob SQL login (overrides global value) | +| postgresqlSetupJob.image.registry | string | `"docker.io"` | Default image registry to be used by the job. | | acryl-datahub-actions.ingestionSecretFiles.name | string | `""` | Name of the k8s secret that holds any secret files (e.g., SSL certificates and private keys) that are used in your ingestion recipes. The keys in the secret will be mounted as individual files under `/etc/datahub/ingestion-secret-files` | | acryl-datahub-actions.ingestionSecretFiles.defaultMode | string | `""` | The permission mode for the volume that mounts k8s secret under `/etc/datahub/ingestion-secret-files`, default value is 0444 which allows read access by owner, group, and other users | | global.credentialsAndCertsSecrets.name | string | `""` | Name of the secret that holds SSL certificates (keystores, truststores) | @@ -178,6 +180,10 @@ helm install datahub datahub/datahub --values <> | global.kafka.schemaregistry.glue.region | string | `""` | Region of the AWS Glue schema registry | | global.kafka.schemaregistry.glue.registry | string | `""` | Name of the AWS Glue schema registry | | datahub.metadata_service_authentication.enabled | bool | `true` | Whether Metadata Service Authentication is enabled. | +| elasticsearchSetupJob.image.registry | string | `docker.io` | Default image registry to be used by the job. | +| kafkaSetupJob.image.registry | string | `docker.io` | Default image registry to be used by the job. | +| datahubUpgrade.image.registry | string | `docker.io` | Default image registry to be used by the job. | +| datahubSystemUpdate.image.registry | string | `docker.io` | Default image registry to be used by the job. | | global.datahub.metadata_service_authentication.systemClientId | string | `"__datahub_system"` | The internal system id that is used to communicate with DataHub GMS. Required if metadata_service_authentication is 'true'. | | global.datahub.metadata_service_authentication.systemClientSecret.secretRef | string | `datahub-auth-secrets` | The reference to a secret containing the internal system secret that is used to communicate with DataHub GMS. If a secret reference is not provided, a random one will be generated for you in a Kubernetes secret called `datahub-auth-secrets`. | | global.datahub.metadata_service_authentication.systemClientSecret.secretKey | string | `system_client_secret` | The key of a secret containing the internal system secret that is used to communicate with DataHub GMS. If a secret reference is not provided, a random one will be generated for you in a Kubernetes secret value named `system_client_secret` within a secret named `datahub-auth-secrets`. | @@ -199,3 +205,4 @@ helm install datahub datahub/datahub --values <> | global.datahub.encryptionKey.provisionSecret.secretValues.encryptionKey | string | `` | The encryption key value to be used if specified directly. | | global.datahub.enable_retention | bool | `false` | Whether or not to enable retention on local DB | | global.sql.datasource.hostForpostgresqlClient | string | `""` | SQL database host (without port) when using postgresqlSetupJob | +| global.imageRegistry | string | `""` | Optional docker image registry to be used by all services. | diff --git a/charts/datahub/subcharts/acryl-datahub-actions/README.md b/charts/datahub/subcharts/acryl-datahub-actions/README.md index 603ad195f..e653d3678 100644 --- a/charts/datahub/subcharts/acryl-datahub-actions/README.md +++ b/charts/datahub/subcharts/acryl-datahub-actions/README.md @@ -19,6 +19,7 @@ Current chart version is `0.0.3` | image.args | list | `[]` | Override the image's args. Used to configure custom startup or shutdown behavior | | image.command | list | `[]` | Override the image's command. Used to configure custom startup or shutdown behavior | | image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"docker.io"` | Optional configuration of image registry to be used. | | image.repository | string | `"acryldata/datahub-actions"` | | | image.tag | string | `"v0.0.6"` | | | imagePullSecrets | list | `[]` | | diff --git a/charts/datahub/subcharts/datahub-frontend/README.md b/charts/datahub/subcharts/datahub-frontend/README.md index 3067e9928..9d2ae5bfc 100644 --- a/charts/datahub/subcharts/datahub-frontend/README.md +++ b/charts/datahub/subcharts/datahub-frontend/README.md @@ -24,7 +24,8 @@ Current chart version is `0.2.0` | image.args | list | `[]` | Override the image's args. Used to configure custom startup or shutdown behavior | | image.command | list | `[]` | Override the image's command. Used to configure custom startup or shutdown behavior | | image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"acryldata/datahub-frontend-react"` | | +| image.registry | string | `"docker.io"` | Optional configuration of image registry to be used. | +| image.repository | string | `"linkedin/datahub-frontend-react"` | | | image.tag | string | `"head"` | | | imagePullSecrets | list | `[]` | | | ingress.annotations | object | `{}` | | @@ -63,7 +64,7 @@ Current chart version is `0.2.0` | service.port | int | `9001` | | | service.nodePort | int | `""` | | | service.type | string | `"LoadBalancer"` | | -| service.extraLabels | object | `{}` | | +| service.extraLabels | object | `{}` | | | serviceAccount.annotations | object | `{}` | | | serviceAccount.create | bool | `true` | | | serviceAccount.name | string | `nil` | | diff --git a/charts/datahub/subcharts/datahub-gms/README.md b/charts/datahub/subcharts/datahub-gms/README.md index 71b772c5a..b94d9f5f3 100644 --- a/charts/datahub/subcharts/datahub-gms/README.md +++ b/charts/datahub/subcharts/datahub-gms/README.md @@ -29,7 +29,7 @@ Current chart version is `0.2.0` | global.kafka.schemaregistry.url | string | `"http://schema-registry:8081"` | | | global.neo4j.host | string | `"neo4j:7474"` | | | global.neo4j.uri | string | `"bolt://neo4j"` | | -| global.neo4j.database | string | `"graph.db"` | Neo4J database | +| global.neo4j.database | string | `"graph.db"` | Neo4J database | | global.neo4j.username | string | `"neo4j"` | | | global.neo4j.password.secretRef | string | `"neo4j-secrets"` | | | global.neo4j.password.secretKey | string | `"neo4j-password"` | | @@ -43,7 +43,8 @@ Current chart version is `0.2.0` | image.args | list | `[]` | Override the image's args. Used to configure custom startup or shutdown behavior | | image.command | list | `[]` | Override the image's command. Used to configure custom startup or shutdown behavior | | image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"acryldata/datahub-gms"` | | +| image.registry | string | `"docker.io"` | Optional configuration of image registry to be used. | +| image.repository | string | `"linkedin/datahub-gms"` | | | image.tag | string | `"head"` | | | imagePullSecrets | list | `[]` | | | ingress.annotations | object | `{}` | | diff --git a/charts/datahub/subcharts/datahub-ingestion-cron/README.md b/charts/datahub/subcharts/datahub-ingestion-cron/README.md index e0a543298..3e4c93423 100644 --- a/charts/datahub/subcharts/datahub-ingestion-cron/README.md +++ b/charts/datahub/subcharts/datahub-ingestion-cron/README.md @@ -7,7 +7,8 @@ A Helm chart for datahub's metadata-ingestion framework with kerberos authentica | Key | Type | Default | Description | |----------------------------------|---------|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | image.pullPolicy | string | `"IfNotPresent"` | Image pull policy | -| image.repository | string | `"acryldata/datahub-ingestion"` | DataHub Ingestion image repository | +| image.registry | string | `"docker.io"` | Optional configuration of image registry to be used. | +| image.repository | string | `"acryldata/datahub-ingestion"` | DataHub Ingestion image repository | | image.tag | string | `"head"` | DataHub Ingestion image tag | | imagePullSecrets | array | `[]` (does not add image pull secrets to deployed pods) | Docker registry secret names as an array | | labels | string | `{}` | Metadata labels to be added to each crawling cron job | diff --git a/charts/datahub/subcharts/datahub-mae-consumer/README.md b/charts/datahub/subcharts/datahub-mae-consumer/README.md index 862878250..1dc90381f 100644 --- a/charts/datahub/subcharts/datahub-mae-consumer/README.md +++ b/charts/datahub/subcharts/datahub-mae-consumer/README.md @@ -24,7 +24,7 @@ Current chart version is `0.2.0` | global.kafka.schemaregistry.url | string | `"http://schema-registry:8081"` | | | global.neo4j.host | string | `"neo4j:7474"` | | | global.neo4j.uri | string | `"bolt://neo4j"` | | -| global.neo4j.database | string | `"graph.db"` | Neo4J database | +| global.neo4j.database | string | `"graph.db"` | Neo4J database | | global.neo4j.username | string | `"neo4j"` | | | global.neo4j.password.secretRef | string | `"neo4j-secrets"` | | | global.neo4j.password.secretKey | string | `"neo4j-password"` | | @@ -37,7 +37,8 @@ Current chart version is `0.2.0` | image.args | list | `[]` | Override the image's args. Used to configure custom startup or shutdown behavior | | image.command | list | `[]` | Override the image's command. Used to configure custom startup or shutdown behavior | | image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"acryldata/datahub-mae-consumer"` | | +| image.registry | string | `"docker.io"` | Optional configuration of image registry to be used. | +| image.repository | string | `"linkedin/datahub-mae-consumer"` | | | image.tag | string | `"head"` | | | imagePullSecrets | list | `[]` | | | ingress.annotations | object | `{}` | | @@ -65,7 +66,7 @@ Current chart version is `0.2.0` | serviceAccount.create | bool | `true` | | | serviceAccount.name | string | `nil` | | | serviceMonitor.create | bool | `false` | If set true and `global.datahub.monitoring.enablePrometheus` is set `true` it will create a ServiceMonitor resource | -| serviceMonitor.extraLabels | object | `{}` | | +| serviceMonitor.extraLabels | object | `{}` | | | tolerations | list | `[]` | | | datahub.metadata_service_authentication.enabled | bool | `true` | Whether Metadata Service Authentication is enabled. | | global.datahub.metadata_service_authentication.systemClientId | string | `"__datahub_system"` | The internal system id that is used to communicate with DataHub GMS. Required if metadata_service_authentication is 'true'. | diff --git a/charts/datahub/subcharts/datahub-mce-consumer/README.md b/charts/datahub/subcharts/datahub-mce-consumer/README.md index 9dab83e44..9ab7c3de4 100644 --- a/charts/datahub/subcharts/datahub-mce-consumer/README.md +++ b/charts/datahub/subcharts/datahub-mce-consumer/README.md @@ -26,7 +26,8 @@ Current chart version is `0.2.0` | image.args | list | `[]` | Override the image's args. Used to configure custom startup or shutdown behavior | | image.command | list | `[]` | Override the image's command. Used to configure custom startup or shutdown behavior | | image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"acryldata/datahub-mce-consumer"` | | +| image.registry | string | `"docker.io"` | Optional configuration of image registry to be used. | +| image.repository | string | `"linkedin/datahub-mce-consumer"` | | | image.tag | string | `"head"` | | | imagePullSecrets | list | `[]` | | | ingress.annotations | object | `{}` | | @@ -54,7 +55,7 @@ Current chart version is `0.2.0` | serviceAccount.create | bool | `true` | | | serviceAccount.name | string | `nil` | | | serviceMonitor.create | bool | `false` | If set true and `global.datahub.monitoring.enablePrometheus` is set `true` it will create a ServiceMonitor resource | -| serviceMonitor.extraLabels | object | `{}` | | +| serviceMonitor.extraLabels | object | `{}` | | | tolerations | list | `[]` | | | datahub.metadata_service_authentication.enabled | bool | `true` | Whether Metadata Service Authentication is enabled. | | global.datahub.metadata_service_authentication.systemClientId | string | `"__datahub_system"` | The internal system id that is used to communicate with DataHub GMS. Required if metadata_service_authentication is 'true'. |