MAINTENANCE.md

MAINTENANCE.md

This file serves as a reference for the lifecycle of this project. Note: Ensure to keep this document updated with any changes in maintenance procedures, dependencies, actions, or restrictions.

Maintenance Procedures

Before New Releases

• Update documentation related to new features or changes.

  • README.md
  • DockerHub Camunda Keycloak Docker Hub
  • Official Camunda documentation:
    • Amazon EKS IRSA

• Make internal announcements on slack regarding upcoming releases.

  • #infex-internal
  • #engineering if relevant

• Refer to DEVELOPER.md to see the release process.

After New Releases

Nothing referenced yet.

Dependencies

Upstream Dependencies: dependencies of this project

• bitnami/containers: This project uses the Keycloak image from Bitnami Containers Repository.

Downstream Dependencies: things that depend on this project

• Distribution Team: Utilizes this project in various aspects, including the Camunda Platform Helm Chart.

Actions

• Notify the Distribution Team of any new releases, especially if there are breaking changes or critical updates.

Restrictions

• Versions of Keycloak maintained should align with those supported by the Camunda platform. Refer to the supported environments documentation for the latest information (make sure to browse other supported Camunda versions of the documentation to have a complete list of the versions).
• Never remove images from the registry, even if the sources are deprecated or removed.