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

.. _doc-entry:

************
Introduction
************

.. Add the introduction to your document here.
   Answer the questions in https://hutten.knut.univention.de/mediawiki/index.php/Docs/Document_Scope_Definition
   Delete this comment after you wrote the content.

Welcome to the architecture documentation of Univention Nubus for Kubernetes.

This document describes the architecture of Univention Nubus for Kubernetes deployments.
It starts at a high level and goes down to the technical details level by level.
This document is work-in-progress and receives updates as soon as content is available.

This document doesn't cover the requirements and deployment of Univention Nubus for Kubernetes.
For information on deploying Univention Nubus for Kubernetes in Kubernetes clusters,
refer to the :cite:t:`uv-nubus-kubernetes-operation`.

.. _audience:

Audience
========

This document addresses individuals in organizations who have the role of either:

* Enterprise architect
* Software architect
* DevOps engineer

They want to understand the components of Univention Nubus for Kubernetes,
how they interact externally and internally,
what a reference deployment looks like,
and what interfaces and protocols it uses.

If this describes your role and what you want to know,
then this document is for you.

.. _knowledge-for-understanding:

Knowledge needed for understanding
==================================

This document assumes that you are familiar with information technology in general
and with the building blocks of software and computer networks.
General knowledge of enterprise and software architecture,
software engineering, and Kubernetes
is also helpful for understanding,
as Univention Nubus for Kubernetes requires deployment on a Kubernetes cluster.

The document uses the *ArchiMate* enterprise architecture modeling notation to visualize the architecture of Nubus for Kubernetes.
For more information, see
:external+uv-architecture:ref:`architecture-notation-archimate` in :cite:t:`uv-architecture`.

.. _feedback:

Feedback
========

Your feedback on this documentation is welcome and highly appreciated.
If you have any comments, suggestions, or criticisms,
please
`submit your feedback <https://www.univention.com/feedback/?nubus-kubernetes-architecture=generic>`_
to improve the document.