Skip to content

docs: document the credentials API and the ApplicationDefinition credentials block #753

Open

Description

The Cozystack API is gaining a credentials API (design: https://github.com/cozystack/community/blob/main/design-proposals/user-secrets-api/README.md, implementation in cozystack/cozystack on branch feat/user-secrets-api, PR link to follow in a comment). Two pages need updating once it lands, under content/en/docs/next/:

  • cozystack-api/application-definitions.md: the ApplicationDefinition gains an optional spec.credentials block (format, secretLabels, valuesPath, accounts) whose presence converts a kind to platform-minted credentials. The field reference in the CRD at packages/system/application-definition-crd/definition/cozystack.io_applicationdefinitions.yaml carries the descriptions.
  • A new page for the core.cozystack.io/v1alpha1 credentials resource and its mint and revoke subresources: what a Credential shows (status.password.origin, status.history), that a mint returns the password once and a revoke discards it, the preconditions.resourceVersion conflict, and which tenant tiers may read, mint and revoke.

The operations page on the kube-apiserver audit log, with the policy for distributions that ship none and the fluent-bit.extraOutputs value of monitoring-agents, lives in the cozystack repository at docs/operations/audit-log.md and can be mirrored under the install or operations section.

No managed application is converted yet; the first wave (PostgreSQL, MariaDB, ClickHouse) follows in separate PRs, each of which will reference this issue for the per-application pages.

Activity

  1. lllamnyp commented on Oct 14, 2026

    @lllamnyp
    MemberAuthor

    Implementation PR: cozystack/cozystack#4921

  2. lllamnyp commented on Oct 14, 2026

    @lllamnyp
    MemberAuthor

    PostgreSQL conversion (wave 1): cozystack/cozystack#4922. The managed PostgreSQL page should say that user passwords are issued by a mint on the credential postgres-<name>.<user> and are no longer readable from postgres-<name>-credentials.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions