> For the complete documentation index, see [llms.txt](https://docs.atfinity.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.atfinity.io/deploying/deploying-on-site/kubernetes.md).

# Kubernetes

You can deploy Atfinity in a Kubernetes Cluster. For this, we provide a helm chart, that also includes descriptions of necessary dependencies.

**Note:** All support files and credentials are available via your dedicated support agent.

### Requirements

Atfinity needs a Kubernetes cluster (at least Version 1.27) that can be prepared to run Atfinity. It needs to be possible to install a custom ingress and cert manager in the cluster. If you would like to run an external database (MariaDB and MySQL, inquire for versions) those also need to be available in a recent version. Apart from that, no further components are required.

### Preparing the cluster

Atfinity needs a few components to be installed in the cluster.

* Atfinity Registry Secrets (will be provided through your support agent)
* NGINX Ingress
* Cert Manager

Our readme file outlines our recommended installation procedure.

### Installation

Once you have all the necessary credentials and a prepared cluster, you can install or upgrade a release like this

```
helm upgrade --install NAME oci://atfinity.azurecr.io/helm/atfinity --version 16.0.0
```

Make sure to change the version to the one you would like to install.

### List and description of Pods

#### "api" Pod

This pod runs the backend of Atfinity. It provides the API for both external systems and the Atfinity Frontend. This pod mounts a persistent volume to store all uploaded files.

#### "mariadb" Pod (optional)

This runs a MariaDB, to be used as the Atfinity database if you do not choose the external option. All data points about configuration and clients will be stored here. The pod uses a persistent volume for the database.

#### "elastic" Pod

An ephemeral Elasticsearch is used to provide overviews and full text search.

#### "web" Pod

This runs a hardened nginx server to serve the web frontend application.

#### "euw" Pod (optional)

This runs the End User Wizard (EUW), a Next.js application that provides externally facing wizard forms. Enabled by setting `wizard.enabled: true` in the Helm values. The EUW is served on its own hostname.

## Routes overview (ingress)

* `/api/1` serves the API backend
* `/auth/` serves the Atfinity login page
* `/` serves the Atfinity web frontend
* `wizard.host` (separate hostname) serves the End User Wizard (when enabled)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.atfinity.io/deploying/deploying-on-site/kubernetes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.