diff --git a/charts/portal/README.md b/charts/portal/README.md index a15b2201..60780285 100644 --- a/charts/portal/README.md +++ b/charts/portal/README.md @@ -420,57 +420,67 @@ This section describes configurable parameters in **values.yaml**, there is also ### Database Node Pool Configurations #### Common configurations across multiple containers -| Parameter | Description | Default | Container | -|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------------------------------------------------------------------------------| -| `.additionalEnv.DATABASE_POOL_MINPOOLSIZE` | Minimum number of Connections a pool will maintain at any given time | `5` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| Parameter | Description | Default | Container | +|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------------------------------------------------------------------------------| +| `.additionalEnv.DATABASE_POOL_MINPOOLSIZE` | Minimum number of Connections a pool will maintain at any given time | `5` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | | `.additionalEnv.DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 (ms)` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_MAXSTATEMENTSPERCONNECTION` | The number of PreparedStatements to be cached for a single pooled Connection | `50` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_IDLECONNECTIONTESTPERIOD` | Test all idle, pooled but unchecked-out connections, every this number of seconds | `60 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_INITIALPOOLSIZE` | Number of Connections a pool will try to acquire upon startup | `5` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_MAXSTATEMENTS` | The size of global PreparedStatement cache | `300` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress`, | -| `.additionalEnv.DATABASE_POOL_MAXCONNECTIONAGE` | A Connection older than maxConnectionAge will be destroyed and purged from the pool | `0 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_MAXIDLETIME` | Seconds a Connection can remain pooled but unused before being discarded. | `0 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | -| `.additionalEnv.DATABASE_POOL_MAXIDLETIMEEXCESSCONNECTIONS` | Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled | `0 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_MAXSTATEMENTSPERCONNECTION` | The number of PreparedStatements to be cached for a single pooled Connection | `50` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_IDLECONNECTIONTESTPERIOD` | Test all idle, pooled but unchecked-out connections, every this number of seconds | `60 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_INITIALPOOLSIZE` | Number of Connections a pool will try to acquire upon startup | `5` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_MAXSTATEMENTS` | The size of global PreparedStatement cache | `300` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress`, | +| `.additionalEnv.DATABASE_POOL_MAXCONNECTIONAGE` | A Connection older than maxConnectionAge will be destroyed and purged from the pool | `0 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_MAXIDLETIME` | Seconds a Connection can remain pooled but unused before being discarded. | `0 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_MAXIDLETIMEEXCESSCONNECTIONS` | Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled | `0 seconds` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | +| `.additionalEnv.DATABASE_POOL_SOCKETTIMEOUT` | The number of milliseconds on network socket operations specified as socketTimeout property in the JDBC URL. Value 0 means no timeout. | `120000 (ms)`| `portalData`, `portalEnterprise`, `tenantProvisioner`,`ingress` | +| `.additionalEnv.DATABASE_POOL_CONNECTTIMEOUT` | The number of milliseconds timeout for socket connect specified as connectTimeout property in the JDBC URL. Value 0 means no timeout. | `10000 (ms)` | `portalData`, `portalEnterprise`, `tenantProvisioner`, `analytics`,`ingress` | #### Authenticator specific configurations -| Parameter | Description | Default | -|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------| -| `authenticator.additionalEnv.DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | -| `authenticator.additionalEnv.DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 ms` | -| `authenticator.additionalEnv.DATABASE_POOL_PINGCONNECTIONNOTUSERFOR` | Ping the database to make sure connection is still good if it has not been used in this many milliseconds, | `5000 ms` | -| `authenticator.additionalEnv.DATABASE_POOL_PINGENABLED` | Periodically pings and tests the connections in connection pool if they are alive and responsive | `true` | -| `authenticator.additionalEnv.DATABASE_POOL_PINGQUERY` | SQL query to be executed when connection pool is pinged to test the health of connections. | `select1` | -| `authenticator.additionalEnv.DATABASE_POOL_MAXIMUMIDLECONNECTIONS` | The maximum number of idle connections | `10` | +| Parameter | Description | Default | +|---------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| `authenticator.additionalEnv.DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | +| `authenticator.additionalEnv.DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 ms` | +| `authenticator.additionalEnv.DATABASE_POOL_PINGCONNECTIONNOTUSERFOR` | Ping the database to make sure connection is still good if it has not been used in this many milliseconds, | `5000 ms` | +| `authenticator.additionalEnv.DATABASE_POOL_PINGENABLED` | Periodically pings and tests the connections in connection pool if they are alive and responsive | `true` | +| `authenticator.additionalEnv.DATABASE_POOL_PINGQUERY` | SQL query to be executed when connection pool is pinged to test the health of connections. | `select1` | +| `authenticator.additionalEnv.DATABASE_POOL_MAXIMUMIDLECONNECTIONS` | The maximum number of idle connections | `10` | +| `authenticator.additionalEnv.DATABASE_POOL_SOCKETTIMEOUT` | The number of milliseconds on network socket operations specified as socketTimeout property in the JDBC URL. Value 0 means no timeout. | `120000 (ms)` | +| `authenticator.additionalEnv.DATABASE_POOL_CONNECTTIMEOUT` | The number of milliseconds timeout for socket connect specified as connectTimeout property in the JDBC URL. Value 0 means no timeout. | `10000 (ms)` | + #### Additional portalData configurations for File Repository Database -| Parameter | Description | Default | -|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MINPOOLSIZE` | Minimum number of Connections a pool will maintain at any given time | `5` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 (ms)` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXSTATEMENTSPERCONNECTION` | The number of PreparedStatements to be cached for a single pooled Connection | `50` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_IDLECONNECTIONTESTPERIOD` | Test all idle, pooled but unchecked-out connections, every this number of seconds | `60 seconds` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_INITIALPOOLSIZE` | Number of Connections a pool will try to acquire upon startup | `5` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXSTATEMENTS` | The size of global PreparedStatement cache | `300` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXCONNECTIONAGE` | A Connection older than maxConnectionAge will be destroyed and purged from the pool | `0 seconds` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXIDLETIME` | Seconds a Connection can remain pooled but unused before being discarded. | `0 seconds` | -| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXIDLETIMEEXCESSCONNECTIONS` | Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled | `0 seconds` | +| Parameter | Description | Default | +|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MINPOOLSIZE` | Minimum number of Connections a pool will maintain at any given time | `5` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 (ms)` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXSTATEMENTSPERCONNECTION` | The number of PreparedStatements to be cached for a single pooled Connection | `50` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_IDLECONNECTIONTESTPERIOD` | Test all idle, pooled but unchecked-out connections, every this number of seconds | `60 seconds` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_INITIALPOOLSIZE` | Number of Connections a pool will try to acquire upon startup | `5` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXSTATEMENTS` | The size of global PreparedStatement cache | `300` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXCONNECTIONAGE` | A Connection older than maxConnectionAge will be destroyed and purged from the pool | `0 seconds` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXIDLETIME` | Seconds a Connection can remain pooled but unused before being discarded. | `0 seconds` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_MAXIDLETIMEEXCESSCONNECTIONS` | Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled | `0 seconds` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_SOCKETTIMEOUT` | The number of milliseconds on network socket operations specified as socketTimeout property in the JDBC URL. Value 0 means no timeout. | `120000 (ms)` | +| `portalData.additionalEnv.FILE_REPOSITORY_DATABASE_POOL_CONNECTTIMEOUT` | The number of milliseconds timeout for socket connect specified as connectTimeout property in the JDBC URL. Value 0 means no timeout. | `10000 (ms)` | -#### Additional tenantProvisioner configurations for Portal Database -| Parameter | Description | Default | -|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MINPOOLSIZE` | Minimum number of Connections a pool will maintain at any given time | `5` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 (ms)` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXSTATEMENTSPERCONNECTION` | The number of PreparedStatements to be cached for a single pooled Connection | `50` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_IDLECONNECTIONTESTPERIOD` | Test all idle, pooled but unchecked-out connections, every this number of seconds | `60 seconds` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_INITIALPOOLSIZE` | Number of Connections a pool will try to acquire upon startup | `5` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXSTATEMENTS` | The size of global PreparedStatement cache | `300` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXCONNECTIONAGE` | A Connection older than maxConnectionAge will be destroyed and purged from the pool | `0 seconds` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXIDLETIME` | Seconds a Connection can remain pooled but unused before being discarded. | `0 seconds` | -| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXIDLETIMEEXCESSCONNECTIONS` | Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled | `0 seconds` | + +#### Additional tenantProvisioner configurations for Portal Database +| Parameter | Description | Default | +|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MINPOOLSIZE` | Minimum number of Connections a pool will maintain at any given time | `5` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXPOOLSIZE` | Maximum number of Connections a pool will maintain at any given time | `30` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_CHECKOUTTIMEOUT` | The number of milliseconds a client calling getConnection() will wait for a Connection to be checked-in or acquired when the pool is exhausted | `30000 (ms)` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXSTATEMENTSPERCONNECTION` | The number of PreparedStatements to be cached for a single pooled Connection | `50` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_IDLECONNECTIONTESTPERIOD` | Test all idle, pooled but unchecked-out connections, every this number of seconds | `60 seconds` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_INITIALPOOLSIZE` | Number of Connections a pool will try to acquire upon startup | `5` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXSTATEMENTS` | The size of global PreparedStatement cache | `300` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXCONNECTIONAGE` | A Connection older than maxConnectionAge will be destroyed and purged from the pool | `0 seconds` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXIDLETIME` | Seconds a Connection can remain pooled but unused before being discarded. | `0 seconds` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_MAXIDLETIMEEXCESSCONNECTIONS` | Number of seconds that Connections in excess of minPoolSize should be permitted to remain idle in the pool before being culled | `0 seconds` | +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_SOCKETTIMEOUT` | The number of milliseconds on network socket operations specified as socketTimeout property in the JDBC URL. Value 0 means no timeout. | `120000 (ms)`| +| `tenantProvisioner.additionalEvn.PORTAL_DATABASE_POOL_CONNECTTIMEOUT` | The number of milliseconds timeout for socket connect specified as connectTimeout property in the JDBC URL. Value 0 means no timeout. | `10000 (ms)` | ### Portal TLS Defaults Portal TLS defaults if the parameters are not set. | Parameter | Description | Default |