.. SPDX-FileCopyrightText: 2024 Univention GmbH
..
.. SPDX-License-Identifier: AGPL-3.0-only

.. _changelog:

******************
Document changelog
******************

This section shows the history of updates to the *Nubus for Kubernetes - Architecture Manual* since its publication on
27. March 2024.

Year 2026
=========

.. list-table::
   :header-rows: 1
   :widths: 2 3 7

   * - Date
     - Chapter or topic
     - Change

   * - 23. Mar 2026
     - :ref:`data-objects-udm`
     - Move section about UDM object fields and types to
       :external+uv-nubus-customization:ref:`customization-api-udm-rest-udm-object-field-types`
       in :cite:t:`uv-nubus-customization`.

   * - 09. Feb 2026
     - :ref:`component-portal-service`
     - Remove S3 references for portal assets.
       The *Portal Frontend* now serves assets directly through a sidecar container.

Year 2025
=========

.. list-table::
   :header-rows: 1
   :widths: 2 3 7

   * - Date
     - Chapter or topic
     - Change

   * - 28. Nov 2025
     - :ref:`architecture-auth-flow`
     - Add section about authentication flow.

   * - 30. Oct 2025
     - :ref:`component-nubus-directory-importer`
     - Add deep link to installation section of *Nubus Directory Importer*.

   * - 07. Oct 2025
     - :ref:`changelog`
     - Remove version numbers from document changelog.

   * - 29. Jul 2025
     - :ref:`overview-components-2fa-helpdesk`
     - Add architecture for functional component *2FA Helpdesk*.

   * - 29. Jul 2025
     - :ref:`deployment-2fa-helpdesk`
     - Deployment view for *2FA Helpdesk*.

   * - 29. Jul 2025
     - :ref:`interfaces-2fa-helpdesk`
     - Interfaces and protocols for *2FA Helpdesk*.

   * - 29. Jul 2025
     - :ref:`component-2fa-helpdesk`
     - Functional component *2FA Helpdesk*.

   * - 29. Jul 2025
     - :ref:`component-dependencies`
     - Dependencies for the *2FA Helpdesk*.

   * - 01. Jul 2025
     - :ref:`overview-components-connectors-nubus-directory-importer`
       and :ref:`component-nubus-directory-importer`
     - Adjust links to Nubus Operation Manual referring to the *Nubus Directory Importer* usage.

Year 2024
=========

.. list-table::
   :header-rows: 1
   :widths: 2 3 7

   * - Date
     - Chapter or topic
     - Change

   * - 10. Dec 2024
     - :ref:`component-identity-store-notifications-object-modification`
     - Add note about tight relationship between *LDAP Primary* and *UDM Listener*.
       Update related ArchiMate views to reflect updated relationship.

   * - 10. Dec 2024
     - :ref:`scalability-directory-service`
     - *LDAP Primary* scalability is no longer an experimental feature.

   * - 02. Dec 2024
     - :ref:`overview-message-queue`
     - Add section about relationships to :program:`NATS` message queues
       from the perspective of the message queues.

   * - 14. Nov 2024
     - :ref:`overview-s3-compatible-storage`
     - Add section about relationships to S3-compatible object storage
       from the perspective of the object storage.

   * - 13. Nov 2024
     - :ref:`overview-scalability`
     - Add section describing scalability of function components.

   * - 05. Nov 2024
     - Document
     - Make figures clickable so that readers can easier view the images in a large zoom level.

   * - 30. Oct 2024
     - Document
     - Bump to version ``1.0.0`` for the first production release of Nubus for Kubernetes.

   * - 17. Oct 2024
     - :ref:`deployment-ingress`
     - Replace *Stack Gateway* with Ingress configuration.

   * - 17. Oct 2024
     - :ref:`component-identity-provider`
     - Use *Keycloak Proxy* and *Keycloak Handler* in views and text throughout the manual.

   * - 16. Oct 2024
     - :ref:`component-dependencies`
     - Add *Identity Provider* as dependency to the *Management UI*
       in :numref:`component-dependencies-internal-figure`
       and :numref:`component-dependencies-details-internal-figure`.

   * - 16. Oct 2024
     - :ref:`overview-interfaces-protocols`
     - Update ArchiMate figures to current version of architecture model
       and fix consistent naming of *Prefill Service*.

   * - 16. Oct 2024
     - :ref:`overview-deployment`
     - Update ArchiMate figures to current version of architecture model:

       * Fix layout in :numref:`deployment-portal-fig`.
       * Use *Self Service Consumer* instead of listener in :numref:`deployment-end-user-self-service-fig`.
       * Use *Prefill Service* and ensure consistent naming in :numref:`deployment-provisioning-fig`.
       * Use *Guardian Authorization HTTP REST API*.
       * Use *Guardian Management HTTP REST API* in :numref:`deployment-postgresql-fig`.

   * - 16. Oct 2024
     - :ref:`component-provisioning-service`
     - Use *Prefill Service control queue* consistently in
       :numref:`component-provisioning-service-complete-figure`,
       :numref:`component-provisioning-service-consumer-registration-figure`,
       and :numref:`component-provisioning-service-startup-figure`.

   * - 16. Oct 2024
     - :ref:`component-end-user-self-service`
     - Remove redundant serving relation from *SMTP to send invitation email* to *User invitation /
       User self registration* in :numref:`component-end-user-self-service-invitation-registration-figure`.

   * - 16. Oct 2024
     - :ref:`component-identity-store-directory-service`
     - Use aggregation relation from *LDAP Server* to primary, secondary, and proxy
       in :numref:`deployment-identity-store-fig`
       and :numref:`component-identity-store-figure`.

   * - 30. Sep 2024
     - :ref:`component-end-user-self-service`
     - Add section about the *End User Self Service* functional component.

   * - 25. Sep 2024
     - :ref:`component-portal-service`
     - Add section about *Portal Service* functional component.

   * - 25. Sep 2024
     - :ref:`interfaces-portal-service`
     - Replace *Portal Listener* with *Portal Consumer* and their relationships.
       The *Portal Service* uses the *Provisioning Service* and no longer the legacy Listener-/Notifier mechanism.

   * - 23. Sep 2024
     - :ref:`component-management-ui`
     - Add section about *Management UI* functional component.

   * - 20. Sep 2024
     - :ref:`overview-capabilities`
     - Clarify minor statements in capabilities and the mapping to functional components.

   * - 20. Sep 2024
     - :ref:`capbilitiy-mapping-end-user`
     - Remove realization relationship between *Portal Service*
       and *Single Sign-On / Single Sign-Out*.

   * - 18. Sep 2024
     - :ref:`component-dependencies`
     - Add section about dependencies on functional component and on application component behavior level.

   * - 18. Sep 2024
     - :ref:`architecture-data-flow`
     - Add section about data flow.

   * - 17. Sep 2024
     - :ref:`architecture-data-objects`
     - Add section about the data objects *Directory objects*, *UDM objects*, and *Event objects*.

   * - 5. Sep 2024
     - :ref:`component-connectors`
     - Add section about the *Connectors* functional component,
       including *IAM Connector* and *Nubus Directory Importer*.

   * - 30. Aug 2024
     - :ref:`component-intercom-service`
     - Add section about the *Intercom Service* functional component.

   * - 28. Aug 2024
     - :ref:`component-provisioning-service`
     - Add section about the *Provisioning Service* functional component.

   * - 21. Aug 2024
     - :ref:`component-authorization-service`
     - Add section about the *Authorization Service* functional component.

   * - 19. Aug 2024
     - :ref:`component-directory-manager`
     - Add section about the *Directory Manager* functional component.

   * - 14. Aug 2024
     - :ref:`component-identity-provider-identity-store`
     - Add section about the *Identity Store and Directory Service* functional component.

   * - 06. Aug 2024
     - :ref:`component-identity-provider`
     - Add section about the *Identity Provider* functional component.

   * - 27. Jun 2024
     - :ref:`overview-tls`
     - Add section about Nubus' handling of certificates for transport security.

   * - 26. Jun 2024
     - :numref:`interfaces-external-perspective-detail-fig`: :ref:`interfaces-external-perspective-detail-fig`
     - Add missing aggregation relationship from *HTTP to Nubus* to *HTTP multiplex RPC endpoints*.

   * - 21. Jun 2024
     - :ref:`overview-components-connectors-nubus-directory-importer`
     - Rename *UDM Directory Connector* to *Nubus Directory Importer*

   * - 20. Jun 2024
     - :ref:`overview-deployment`
     - Add deployment view for functional components.

   * - 20. Jun 2024
     - :ref:`overview-interfaces-protocols`
     - Change relations in figures for *Identity Provider* and *Provisioning Service*.

       Use Kubernetes Service objects for description of ports.
       Update ArchiMate views and add text to describe mapping between service objects and
       container ports.

   * - 20. Jun 2024
     - :ref:`appendix-indices`
     - Add document index with entries for deployment view, functional components and capabilities.

   * - 12. Jun 2024
     - :numref:`interfaces-identity-provider-fig`: :ref:`interfaces-identity-provider-fig`
     - Change relation for OpenID Connect and SAML to Keycloak from composition to aggregation.

   * - 12. Jun 2024
     - :ref:`interfaces-identity-store`
     - Clarify support for LDAP read-only operation and access within cluster namespace.

   * - 12. Jun 2024
     - :ref:`interfaces-external-perspective`
     - Add section about external view on protocols and interfaces.

   * - 31. May 2024
     - Document
     - Bump version to 0.5.0 to reflect status of Nubus for Kubernetes alpha release.

   * - 22. May 2024
     - Document title
     - Change document title to *Nubus for Kubernetes - Architecture Manual*.

   * - 16. May 2024
     - :ref:`interfaces-portal-service`
     - Clarify *Portal Frontend* connections and introduce *Portal Frontend in User Browser*.

   * - 15. May 2024
     - :ref:`overview-interfaces-protocols`
     - Add OpenID Connect, SAML, and make a statement about LDAP support.

       Add ArchiMate views for the interfaces and protocols of the functional components.

   * - 07. May 2024
     - :ref:`overview-components-authorization-service`
     - Clarify Nubus components using the *Authorization Service*.

   * - 06. May 2024
     - :ref:`overview-components-connectors-nubus-directory-importer`
     - Add section about *Nubus Directory Importer* in overview of functional components.

   * - 06. May 2024
     - :ref:`overview-components`
     - Remove references to UCS and its glossary entry.

   * - 27. Mar 2024
     - Document
     - Initial release.
