Detailed configuration parameters

Whether deviceportal should be enabled. Per default, it is disabled. Should the deviceportal be deployed, it is necessary to set this value to "true" in the custom-values.

Yes

false

Domain for device mTLS communication.

Yes

-

Reference to a multiline variable containing the server certificate chain for the device mTLS domain. The chain must be provided in the following order: Server certificate → CA certificate → Root certificate.

Yes

-

Reference to a multiline variable containing the key of the server certificate for the device mTLS domain. In case an Ingress Controller is used as MTLS Gateway the private key must be unencrypted. In case you use the nginx and have an encrypted key you can set the password here.

Yes

-

Reference to a multiline variable containing multiple intermediate CA certificates that should be whitelisted for device mTLS authentication. See also Whitelist new certificate.

Yes

-

Active spring profiles. Value is retrieved from exported deviceportal-specific custom-values defined within the Helmchart. Valid profile combinations:

Yes

"docker,azure,nexeed"

Datasource URL. MSSQL needs additional parameter (sendStringParametersAsUnicode=false) which is set per default.

Yes

Datasource type. Supported datasources are MSSQL and Oracle. Value is retrieved from exported deviceportal-specific custom-values defined within the Helmchart. May be overwritten in the actual custom-values if an Oracle database should be used.

Yes

"MSSQL|Oracle"

Json configuration string for internal api keys (should contain the internal api key). Value is retrieved from deviceportal-specific custom-values that must be defined in the inventory and depends on the environment.

Yes

-

Public of the key pair from which the internal api keys are derived. Value is retrieved from deviceportal-specific custom-values that must be defined in the inventory and depends on the environment.

Yes

-

Api key for internal services. Value is retrieved from deviceportal-specific custom-values that must be defined in the inventory and depends on the environment.

Yes

-

Data source connection pool size. This value should be equal to the web client connection pool size of Solution BFF. Default connection pool size for other services is 32.

No

50

Whether the software sync should be enabled. In case software management functionality should not be needed, this can be set to false.

No

true

Minimum count of consumers for status update queue.

No

4

Maximum count of consumers for status update queue.

No

20

Prefetch count for status update queue.

No

1

Minimum count of consumers for event creation queue.

No

2

Maximum count of consumers for event creation queue.

No

10

Prefetch count for event creation queue.

No

1

Minimum count of consumers for event deletion queue.

No

1

Maximum count of consumers for event deletion queue.

No

5

Prefetch count for event deletion queue.

No

1

Defines the maximum number of days before which a device must be claimed. The value is equal to the number of years x 365 days + a buffer is included for different calculation methods e.g. leap years.

No

735

Web client connection pool size for Solution BFF. This value should be equal to the database connection pool size of Device Administration. Default web client connection pool size for other services is 32.

No

50

Is used to activate / deactivate the rate-limiting defined via rateLimitingRequestCountPerInterval.

No

true

Defines how many requests a solution (typically one customer) is allowed to perform in a given interval. Attention: this limit is applied per instance/pod.

No

30

Defines the interval (in seconds) which is the base for rate-limiting defined via rateLimitingRequestCountPerInterval.

No

1

Private key for device tunnel. Related variable: .Values.global.modules.deviceportal.deviceTunnel.remoteAccessPublicKey

Yes

-

If it is enabled, IPs from which recurring non-valid requests are sent are put on a blocklist for a certain period of time.

No

"false"

Ip blocking detection time frame in min.

No

60

Amount of invalid hostnames before blocking.

No

3

IP blocking duration in minutes.

No

720

Allows to define trusted IP ranges which will never be affected by IP-blocking. For example: 124.6.88.*,46.187.72.*

No

""

Public key for remote access. Related variable: .Values.global.modules.deviceportal.webapp.remoteAccessPrivateKey

Yes

-

The maximum size of the request and response body in megabytes. It is recommended to keep the value as low as possible and not to exceed the default value. Any increase leads to restrictions in terms of the number of concurrent users and the possible throughput. Can not be raised above 15 MB.

No

8

15

2

Flag, whether a managed (cluster internal) artifact repository is deployed.

Yes

false

The mTLS URL of the Artifact Repository (used for device access).

Yes

https://{{.Values.global.modules.deviceportal.mtlsGateway.deviceDomain }}/artifact-repository

Multiline variable with the SSL certificate.

Yes

-

Multiline variable with the unencrypted private key of the certificate.

Yes

-

Maximum supported file size in MB (excluding setup files, backups and diagnostic data). Should not be raised above 500 MB.

No

500

The mapping between the device type ID and the device type name visible to end users.

No

ctrlX CORE=MJ7YMNIWEeid1-7uCv8ViW,E2E=XrUuAB0_EeyOD-7uCv_B8g

Storage: upload part size in MB.

No

10

Storage: maximum number of concurrent requests.

No

64

Storage: URL lifetime in minutes (time before expiration).

No

30

S3 storage endpoint. For example: "https://rb-objectstorage.de.bosch.com:9021". Value is retrieved from global custom-values and depends on the environment.

Yes (only for on-premises deployment)

-

S3 storage bucket name. For example: "bci-nxiasdp-q". Value is retrieved from global custom-values and depends on the environment.

Yes (only for on-premises deployment)

-

S3 storage access key id. Value is retrieved from global custom-values and depends on the environment.

Yes (only for on-premises deployment)

-

Storage: direct upload timeout in minutes.

No

30

S3 storage secret access key. Value is retrieved from global custom-values and depends on the environment.

Yes (only for on-premises deployment)

-

Whether blob storage is enabled.

Yes

false

Azure blob storage endpoint. For example: "https://dpmanagedrepodev.blob.core.windows.net/". Value is retrieved from global custom-values and depends on the environment.

Yes (only for cloud deployment)

"https://{{.Values.global.modules.deviceportal.artifactRepo.blobStorage.name }}.blob.core.windows.net/"

Azure blob storage account name. For example: "dpmanagedrepodev". Value is retrieved from global custom-values and depends on the environment.

Yes (only for cloud deployment)

-

Azure blob storage account access key. Value is retrieved from global custom-values and depends on the environment.

Yes (only for cloud deployment)

-

Whether internal audit logging is enabled, see: https://docs.opensearch.org/latest/security/audit-logs/index/#disabling-audit-logs

Yes

true

Name of the Device Portal user

Yes

deviceportal

Name of the OpenSearch user for health monitoring

Yes

health_check

Name of the OpenSearch Dashboards user

Yes

dashboards

Name of the OpenSearch admin user

Yes

codeulhu

Initial password of the Device Portal user, the OpenSearch admin user and the OpenSearch Dashboards user. The passwords can and should be changed via OpenSearch Dashboards. Attention: When changing the password of the Device Portal user or the OpenSearch Dashboards user the configuration of these applications must be updated to use the new password.

Yes

-

BCrypt hash of the initial password of Device Portal user, the OpenSearch admin user and the OpenSearch Dashboards user.

Yes

-

BCrypt hash of the password of the OpenSearch user for health monitoring.

Yes

-

Reference to a multiline variable containing the root CA.

Yes

-

Reference to a multiline variable containing the admin certificate.

Yes

-

Reference to a multiline variable containing the admin certificate key.

Yes

-

Reference to a multiline variable containing the node certificate.

Yes

-

Reference to a multiline variable containing the node certificate key.

Yes

-