mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-26 15:36:26 +00:00
# Which Problems Are Solved
When Postgres was not ready when the API was started, the API failed
immediately.
This made task orchestration hard, especially in a platform agnostic
way:
- The current health check in the Nx target `@zitadel/api:prod` uses the
timeout command, which is not installed on all platforms and behaves
unpredictably
- The current health check in the Nx target `@zitadel/api:prod` requires
the DB to have been started using `@zitadel/zitadel:db`
# How the Problems Are Solved
- Additional configuration option `Database.Postgres.AwaitInitialConn`
is added and defaults to *0m* for backwards compatibility.
- If a duration is configured, the API retries to ping the database
until it succeeds
- The API sleeps for a second between each ping.
- It emits an info-level log with the error on each try.
- When the configured duration times out before the ping is successful,
the error is returned and the command exits with a failure code.
- When the ping succeeds within the configured duration, the API goes on
with the init, setup or start phase.
# Additional Context
- Relates to internally reported problems with the current DB health
check command
[here](https://zitadel.slack.com/archives/C07EUL5H83A/p1759915009839269?thread_ts=1759912259.410789&cid=C07EUL5H83A)
and
[here](https://zitadel.slack.com/archives/C07EUL5H83A/p1759918324246249?thread_ts=1759912259.410789&cid=C07EUL5H83A).
(cherry picked from commit 7ba6870baf)
129 lines
4.3 KiB
YAML
129 lines
4.3 KiB
YAML
Database:
|
|
Postgres:
|
|
AwaitInitialConn: 5m
|
|
MaxOpenConns: 20
|
|
MaxIdleConns: 20
|
|
MaxConnLifetime: 1h
|
|
MaxConnIdleTime: 5m
|
|
Database: zitadel
|
|
FirstInstance:
|
|
Skip: false
|
|
PatPath: .artifacts/api-test-integration/admin-pat.txt
|
|
InstanceName: ZITADEL
|
|
DefaultLanguage: en
|
|
Org:
|
|
Name: ZITADEL
|
|
Machine:
|
|
Machine:
|
|
Username: boss
|
|
Name: boss
|
|
Pat:
|
|
ExpirationDate: 2099-01-01T00:00:00Z
|
|
Human:
|
|
PasswordChangeRequired: false
|
|
|
|
Log:
|
|
Level: info
|
|
|
|
ExternalSecure: false
|
|
|
|
TLS:
|
|
Enabled: false
|
|
|
|
Caches:
|
|
Connectors:
|
|
Memory:
|
|
Enabled: true
|
|
Postgres:
|
|
Enabled: true
|
|
Redis:
|
|
Enabled: true
|
|
Instance:
|
|
Connector: "memory"
|
|
MaxAge: 5m
|
|
LastUsage: 1m
|
|
Log:
|
|
Level: info
|
|
Milestones:
|
|
Connector: "postgres"
|
|
MaxAge: 5m
|
|
LastUsage: 1m
|
|
Log:
|
|
Level: info
|
|
Organization:
|
|
Connector: "redis"
|
|
MaxAge: 5m
|
|
LastUsage: 1m
|
|
Log:
|
|
Level: info
|
|
|
|
Quotas:
|
|
Access:
|
|
Enabled: true
|
|
|
|
Telemetry:
|
|
Enabled: true
|
|
Endpoints:
|
|
- http://localhost:8081/milestone
|
|
Headers:
|
|
single-value: "single-value"
|
|
multi-value:
|
|
- "multi-value-1"
|
|
- "multi-value-2"
|
|
|
|
LogStore:
|
|
Execution:
|
|
Stdout:
|
|
Enabled: true
|
|
|
|
Projections:
|
|
HandleActiveInstances: 30m
|
|
RequeueEvery: 20s
|
|
Customizations:
|
|
NotificationsQuotas:
|
|
RequeueEvery: 1s
|
|
telemetry:
|
|
HandleActiveInstances: 60s
|
|
RequeueEvery: 1s
|
|
|
|
DefaultInstance:
|
|
LoginPolicy:
|
|
MfaInitSkipLifetime: "0"
|
|
|
|
SystemAPIUsers:
|
|
- tester:
|
|
KeyData: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF6aStGRlNKTDdmNXl3NEtUd3pnTQpQMzRlUEd5Y20vTStrVDBNN1Y0Q2d4NVYzRWFESXZUUUtUTGZCYUVCNDV6YjlMdGpJWHpEdzByWFJvUzJoTzZ0CmgrQ1lRQ3ozS0N2aDA5QzBJenhaaUIySVMzSC9hVCs1Qng5RUZZK3ZuQWtaamNjYnlHNVlOUnZtdE9sbnZJZUkKSDdxWjB0RXdrUGZGNUdFWk5QSlB0bXkzVUdWN2lvZmRWUVMxeFJqNzMrYU13NXJ2SDREOElkeWlBQzNWZWtJYgpwdDBWajBTVVgzRHdLdG9nMzM3QnpUaVBrM2FYUkYwc2JGaFFvcWRKUkk4TnFnWmpDd2pxOXlmSTV0eXhZc3duCitKR3pIR2RIdlczaWRPRGxtd0V0NUsycGFzaVJJV0syT0dmcSt3MEVjbHRRSGFidXFFUGdabG1oQ2tSZE5maXgKQndJREFRQUIKLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0tCg=="
|
|
Memberships:
|
|
- MemberType: System
|
|
Roles:
|
|
- "SYSTEM_OWNER"
|
|
- "IAM_OWNER"
|
|
- "ORG_OWNER"
|
|
- cypress:
|
|
KeyData: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF6aStGRlNKTDdmNXl3NEtUd3pnTQpQMzRlUEd5Y20vTStrVDBNN1Y0Q2d4NVYzRWFESXZUUUtUTGZCYUVCNDV6YjlMdGpJWHpEdzByWFJvUzJoTzZ0CmgrQ1lRQ3ozS0N2aDA5QzBJenhaaUIySVMzSC9hVCs1Qng5RUZZK3ZuQWtaamNjYnlHNVlOUnZtdE9sbnZJZUkKSDdxWjB0RXdrUGZGNUdFWk5QSlB0bXkzVUdWN2lvZmRWUVMxeFJqNzMrYU13NXJ2SDREOElkeWlBQzNWZWtJYgpwdDBWajBTVVgzRHdLdG9nMzM3QnpUaVBrM2FYUkYwc2JGaFFvcWRKUkk4TnFnWmpDd2pxOXlmSTV0eXhZc3duCitKR3pIR2RIdlczaWRPRGxtd0V0NUsycGFzaVJJV0syT0dmcSt3MEVjbHRRSGFidXFFUGdabG1oQ2tSZE5maXgKQndJREFRQUIKLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0tCg=="
|
|
- system-user-with-no-permissions:
|
|
KeyData: "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqTVdFWDZtK0gzWndaV1ptTUhxbApHbVoxa0wvRVlWZzJCb24yQm5wOU5LTXdoVTlpK29CcUwrR0FzVVZYdnBkMmhVTy9ZK1VpVzlRdnJ4K3ZBeVpNCmdrNjRRNlFFNm5ZMWJncnV3aEJDUC85ZWlMMzVvOTRHelhiS2RDSEF5bFNBQmRHemZaTDN1YUgwVndvRk9neU0KZkJveTdGMHFLRXA0bVp5ZUhmMFo3ZXZacVVyRDVNcEZMTjBhUnRqVWpwOTFpd0tGU29kYXY1S25sYW4vSGtQaQpzN3NnLzBmVURRRDRzZ2ZvcndManJWYnI1aUtxSTBHQ3VhUEwzazRQOEdnY1haczVJcHUzb1BDZXdWUTBvd1hoCjJvRXVTdlNDYS8wTmxYanRLMlRqbmlYeTVSL2NaVXF3NzNOd0NFdjl4N1pLaU51dkpEWkw2UnM5Q0xJT3RhVkUKTFFJREFRQUIKLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0tCg=="
|
|
Memberships:
|
|
# MemberType System allows the user to access all APIs for all instances or organizations
|
|
- MemberType: IAM
|
|
Roles:
|
|
- "NO_ROLES"
|
|
|
|
InitProjections:
|
|
Enabled: true
|
|
|
|
# Extend key lifetimes so we do not see more legacy keys when
|
|
# integration tests are rerun on the same DB with more than 6 hours apart.
|
|
# The test counts the amount of keys returned from the JWKS endpoint and fails
|
|
# with 2 or more legacy public keys,
|
|
SystemDefaults:
|
|
KeyConfig:
|
|
PrivateKeyLifetime: 7200h
|
|
PublicKeyLifetime: 14400h
|
|
|
|
OIDC:
|
|
DefaultLoginURLV2: "/login?authRequest=" # ZITADEL_OIDC_DEFAULTLOGINURLV2
|
|
DefaultLogoutURLV2: "/logout?post_logout_redirect=" # ZITADEL_OIDC_DEFAULTLOGOUTURLV2
|
|
|
|
SAML:
|
|
DefaultLoginURLV2: "/login?authRequest=" # ZITADEL_SAML_DEFAULTLOGINURLV2 |