> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Provides all the information that needs to be known before starting the installation of Apinizer on Kubernetes. Covers critical topics such as pre-installation decisions, access and port requirements, and installation directory guide.

<Info>
  **Note:** This documentation has been checked and approved for Kubernetes 1.34.0 and Flannel 0.27.4 versions. Ports may vary in different Kubernetes and Flannel versions.
</Info>

<Warning>
  **Apinizer does not recommend installing on a single server for production environments. Consider such an installation configuration only for PoC environments.**
</Warning>

## Before Starting Installation

Before starting the Apinizer installation, you need to prepare and make decisions on the following topics:

### 1. Deployment Model Selection

Apinizer offers three basic deployment models suitable for different requirements:

<CardGroup cols={3}>
  <Card title="All-in-One (Standalone)" icon="server" href="/en/concepts/deployment/deployment-models">
    Deployment model suitable for test and PoC environments
  </Card>

  <Card title="Distributed" icon="network-wired" href="/en/concepts/deployment/deployment-models">
    Deployment model suitable for medium-scale production environments
  </Card>

  <Card title="Clustered (HA)" icon="layer-group" href="/en/concepts/deployment/deployment-models">
    Deployment model suitable for production environments with high availability requirements
  </Card>
</CardGroup>

### 2. Pre-Installation Decisions

You need to make decisions on the following topics before installation:

<CardGroup cols={2}>
  <Card title="Infrastructure" icon="server" href="/en/setup/pre-installation-decisions">
    Kubernetes and MongoDB installation method, internet access status, server allocation
  </Card>

  <Card title="Network and Security" icon="shield" href="/en/setup/pre-installation-decisions">
    WAF and firewall products, IP block usage, SSL termination point
  </Card>

  <Card title="Port and DNS" icon="network-wired" href="/en/setup/pre-installation-decisions">
    Port configuration, DNS resolution method, DNS addresses
  </Card>

  <Card title="Logging" icon="file-lines" href="/en/setup/pre-installation-decisions">
    Traffic log destination, backup strategy, sensitive information protection
  </Card>

  <Card title="User Management" icon="users" href="/en/setup/pre-installation-decisions">
    Admin account usage, LDAP/AD integration
  </Card>

  <Card title="Support" icon="headset" href="/en/setup/pre-installation-decisions">
    Support access method, VPN configuration
  </Card>
</CardGroup>

### 3. Access and Port Requirements

You should check the internet access and port requirements needed for installation. For detailed information, see the [Access and Port Requirements for Installation](/en/setup/access-and-port-requirements) page.

### 4. Installation Directory Guide

You can use the pages under the [/en/setup](/en/setup/overview) directory to perform installation operations. What each page is used for is explained below.

## Pre-Installation Decisions

For detailed information, see the [Pre-Installation Decisions](/en/setup/pre-installation-decisions) page.

## Access and Port Requirements

For detailed information, see the [Access and Port Requirements for Installation](/en/setup/access-and-port-requirements) page.

## Installation Directory Guide

All documentation related to Apinizer installation is located under the [/en/setup](/en/setup/overview) directory.

### Installation Group

<CardGroup cols={2}>
  <Card title="Apinizer" icon="layer-group" href="/en/setup/apinizer/apinizer">
    Basic Apinizer installation
  </Card>

  <Card title="Multi-Region" icon="globe" href="/en/setup/apinizer/multi-region">
    Multi-region installation
  </Card>

  <Card title="API Portal" icon="globe" href="/en/setup/apinizer/api-portal">
    API Portal installation
  </Card>

  <Card title="API Integration" icon="puzzle-piece" href="/en/setup/apinizer/api-integration">
    API integration installation
  </Card>
</CardGroup>

### Infrastructure Components Group

#### Kubernetes

<CardGroup cols={2}>
  <Card title="Ubuntu Kubernetes" icon="server" href="/en/setup/kubernetes/ubuntu-kubernetes">
    Kubernetes installation on Ubuntu
  </Card>

  <Card title="RHEL Kubernetes" icon="server" href="/en/setup/kubernetes/rhel-kubernetes">
    Kubernetes installation on Red Hat Enterprise Linux
  </Card>

  <Card title="Kubernetes Metric Server" icon="gauge" href="/en/setup/kubernetes/kubernetes-metric-server">
    Kubernetes Metric Server installation
  </Card>

  <Card title="Kubernetes HA Cluster" icon="layer-group" href="/en/setup/kubernetes/kubernetes-high-availability-cluster">
    Kubernetes cluster installation for high availability
  </Card>

  <Card title="Kubernetes Dashboard" icon="window-maximize" href="/en/setup/kubernetes/kubernetes-dashboard">
    Kubernetes Dashboard installation and usage
  </Card>

  <Card title="Prometheus and Grafana" icon="chart-line" href="/en/setup/kubernetes/prometheus-grafana">
    Prometheus and Grafana integration for monitoring
  </Card>
</CardGroup>

#### Elasticsearch

<CardGroup cols={2}>
  <Card title="Ubuntu Elasticsearch" icon="search" href="/en/setup/elasticsearch/ubuntu-elasticsearch">
    Elasticsearch installation on Ubuntu
  </Card>

  <Card title="RHEL Elasticsearch" icon="search" href="/en/setup/elasticsearch/rhel-elasticsearch">
    Elasticsearch installation on Red Hat Enterprise Linux
  </Card>

  <Card title="Simple Authentication" icon="key" href="/en/setup/elasticsearch/simple-authentication">
    Elasticsearch security configuration
  </Card>

  <Card title="Permission Requirements" icon="shield" href="/en/setup/elasticsearch/permission-requirements">
    Elasticsearch authorization settings
  </Card>

  <Card title="Backup Policy" icon="floppy-disk" href="/en/setup/elasticsearch/backup-policy">
    Elasticsearch backup strategies
  </Card>

  <Card title="Manual ILM Policy" icon="file-lines" href="/en/setup/elasticsearch/manual-ilm-policy-and-template-creation">
    Index Lifecycle Management configuration
  </Card>
</CardGroup>

#### MongoDB

<CardGroup cols={2}>
  <Card title="Ubuntu MongoDB" icon="database" href="/en/setup/mongodb/ubuntu-mongodb">
    MongoDB installation for Ubuntu operating system
  </Card>

  <Card title="RHEL MongoDB" icon="database" href="/en/setup/mongodb/rhel-mongodb">
    MongoDB installation for Red Hat Enterprise Linux
  </Card>
</CardGroup>

#### Cloud

<CardGroup cols={3}>
  <Card title="Amazon EKS" icon="cloud" href="/en/setup/cloud/amazon-eks-elastic-kubernetes-service">
    Installation on Amazon Elastic Kubernetes Service
  </Card>

  <Card title="Microsoft AKS" icon="cloud" href="/en/setup/cloud/microsoft-aks-azure-kubernetes-service">
    Installation on Azure Kubernetes Service
  </Card>

  <Card title="OpenShift Origin 3.11" icon="cloud" href="/en/setup/cloud/openshift-origin-311">
    Installation on OpenShift
  </Card>
</CardGroup>

#### Helm

<CardGroup cols={3}>
  <Card title="Apinizer Helm" icon="layer-group" href="/en/setup/helm/apinizer">
    Helm chart installation for Apinizer
  </Card>

  <Card title="Elasticsearch Installation" icon="search" href="/en/setup/elasticsearch/ubuntu-elasticsearch">
    Elasticsearch installation
  </Card>

  <Card title="MongoDB Helm" icon="database" href="/en/setup/helm/mongo">
    Helm chart installation for MongoDB
  </Card>
</CardGroup>

#### Offline

<CardGroup cols={2}>
  <Card title="Ubuntu Offline" icon="server" href="/en/setup/offline/ubuntu">
    Offline installation for Ubuntu
  </Card>

  <Card title="RHEL 8.x Offline" icon="server" href="/en/setup/offline/rhel-8x">
    Offline installation for Red Hat Enterprise Linux 8.x
  </Card>

  <Card title="RHEL 9.x Offline" icon="server" href="/en/setup/offline/rhel-9x">
    Offline installation for Red Hat Enterprise Linux 9.x
  </Card>
</CardGroup>

## Important Notes

<Info>
  * Making all decisions before installation and completing necessary preparations will speed up the installation process
  * Deployment model selection determines installation topology and resource requirements
  * It is important to check port and access requirements before installation
  * If you will do offline installation, you should prepare all necessary packages in advance
</Info>

<Warning>
  * Installing on a single server is not recommended for production environments
  * Do not use test/PoC installations for load testing purposes
  * Always take backups before critical operations
  * Port changes should be made carefully if they will be made
</Warning>

## Next Steps

<CardGroup cols={2}>
  <Card title="Deployment Models" href="/en/concepts/deployment/deployment-models">
    Learn which deployment model to choose
  </Card>

  <Card title="Network Connection Matrix" href="/en/concepts/deployment/network-connection-matrix">
    Learn port requirements between Apinizer components
  </Card>

  <Card title="Network Topology and Port Requirements" href="/en/concepts/deployment/network-topology">
    Get detailed information about port permissions
  </Card>

  <Card title="Apinizer Installation" href="/en/setup/apinizer/apinizer">
    Review Apinizer installation steps
  </Card>

  <Card title="Kubernetes Installation" href="/en/setup/kubernetes/kubernetes">
    Review Kubernetes installation steps
  </Card>

  <Card title="MongoDB Installation" href="/en/setup/mongodb/ubuntu-mongodb">
    Review MongoDB installation steps
  </Card>

  <Card title="Elasticsearch Installation" href="/en/setup/elasticsearch/ubuntu-elasticsearch">
    Review Elasticsearch installation steps
  </Card>
</CardGroup>