diff --git a/INSTALL.md b/INSTALL.md index b1f608bb..1956ef14 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -31,22 +31,25 @@ By default, authentication is deactivated, please adjust `registry.authenticatio The Helm Chart can be configured using the following parameters (incomplete list). For a full overview, please see the [values.yaml](./backend/deployment/registry/values.yaml). ### Registry -| Parameter | Description | Default value | -| --- | --- | --- | -| `registry.image` | The image of the Registry | `registry:latest` | -| `registry.host` | This value is used by the `Ingress` object (if enabled) to route traffic. | `minikube` | -| `registry.authentication` | Enables OAuth2 based authentication/authorization. | `false` | -| `registry.idpIssuerUri` | The issuer URI of the OAuth2 identity provider. | `http://localhost:8080/auth/realms/catenax` | -| `registry.dataSource.driverClassName` | The driver class name for the database connection. | `org.postgresql.Driver` | -| `registry.dataSource.url` | The url of the relational database (ignored if `enablePostgres` is set to `true`) | `jdbc:postgresql://database:5432` | -| `registry.dataSource.user` (ignored if `enablePostgres` is set to `true`) | The database user | `user` | -| `registry.dataSource.password` (ignored if `enablePostgres` is set to `true`) | The database password | `org.postgresql.Driver` | -| `registry.ingress.enabled` | Configures if an `Ingress` resource is created. | `true` | -| `registry.ingress.tls` | Configures whether the `Ingress` should include TLS configuration. In that case, a separate `Secret` (as defined by `registry.ingress.tlsSecretName`) needs to be provided manually or by using [cert-manager](https://cert-manager.io/) | `true` | -| `registry.ingress.tlsSecretName` | The `Secret` name that contains a `tls.crt` and `tls.key` entry. Subject Alternative Name must match the `registry.host` | `registry-certificate-secret` | -| `registry.ingress.urlPrefix` | The url prefix that is used by the `Ingress` resource to route traffic | `/semantics/registry` | -| `registry.ingress.className` | The `Ingress` class name | `nginx` | -| `registry.ingress.annotations` | Annotations to further configure the `Ingress` resource, e.g. for using with `cert-manager`. | | +| Parameter | Description | Default value | +| --- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| `registry.image` | The image of the Registry | `registry:latest` | +| `registry.host` | This value is used by the `Ingress` object (if enabled) to route traffic. | `minikube` | +| `registry.authentication` | Enables OAuth2 based authentication/authorization. | `false` | +| `registry.idpIssuerUri` | The issuer URI of the OAuth2 identity provider. | `http://localhost:8080/auth/realms/catenax` | +| `registry.dataSource.driverClassName` | The driver class name for the database connection. | `org.postgresql.Driver` | +| `registry.dataSource.url` | The url of the relational database (ignored if `enablePostgres` is set to `true`) | `jdbc:postgresql://database:5432` | +| `registry.dataSource.user` (ignored if `enablePostgres` is set to `true`) | The database user | `user` | +| `registry.dataSource.password` (ignored if `enablePostgres` is set to `true`) | The database password | `org.postgresql.Driver` | +| `registry.ingress.enabled` | Configures if an `Ingress` resource is created. | `true` | +| `registry.ingress.tls` | Configures whether the `Ingress` should include TLS configuration. In that case, a separate `Secret` (as defined by `registry.ingress.tlsSecretName`) needs to be provided manually or by using [cert-manager](https://cert-manager.io/) | `true` | +| `registry.ingress.tlsSecretName` | The `Secret` name that contains a `tls.crt` and `tls.key` entry. Subject Alternative Name must match the `registry.host` | `registry-certificate-secret` | +| `registry.ingress.urlPrefix` | The url prefix that is used by the `Ingress` resource to route traffic | `/semantics/registry` | +| `registry.ingress.className` | The `Ingress` class name | `nginx` | +| `registry.ingress.annotations` | Annotations to further configure the `Ingress` resource, e.g. for using with `cert-manager`. | | +| `registry.tenantId` | TenantId which is the owner of the DTR. | | +| `registry.externalSubjectIdWildcardPrefix` | WildcardPrefix to make a specificAssetId visible for everyone. | `PUBLIC_READABLE` | +| `registry.externalSubjectIdWildcardAllowedTypes` | List of allowed types that can be made visible to everyone. | `manufacturerPartId,assetLifecyclePhase` | ### PostgreSQL | Parameter | Description | Default value | diff --git a/charts/registry/Chart.yaml b/charts/registry/Chart.yaml index 23a634bc..8a505014 100644 --- a/charts/registry/Chart.yaml +++ b/charts/registry/Chart.yaml @@ -26,7 +26,7 @@ sources: - https://github.com/eclipse-tractusx/sldt-digital-twin-registry type: application -version: 0.3.18 +version: 0.3.19 appVersion: 0.3.12-M1 dependencies: diff --git a/charts/registry/README.md b/charts/registry/README.md index b258470d..005a4d42 100644 --- a/charts/registry/README.md +++ b/charts/registry/README.md @@ -79,6 +79,8 @@ helm install registry -n semantics charts/registry | registry.service.port | int | `8080` | | | registry.service.type | string | `"ClusterIP"` | | | registry.tenantId | string | `"default-tenant"` | | +| registry.externalSubjectIdWildcardPrefix | string | `PUBLIC_READABLE` | | +| registry.externalSubjectIdWildcardAllowedTypes | string | `manufacturerPartId,assetLifecyclePhase` | | ---------------------------------------------- Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)