Skip to main content
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.
Apinizer does not recommend installing on a single server for production environments. Consider such an installation configuration only for PoC environments.

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:

All-in-One (Standalone)

Deployment model suitable for test and PoC environments

Distributed

Deployment model suitable for medium-scale production environments

Clustered (HA)

Deployment model suitable for production environments with high availability requirements

2. Pre-Installation Decisions

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

Infrastructure

Kubernetes and MongoDB installation method, internet access status, server allocation

Network and Security

WAF and firewall products, IP block usage, SSL termination point

Port and DNS

Port configuration, DNS resolution method, DNS addresses

Logging

Traffic log destination, backup strategy, sensitive information protection

User Management

Admin account usage, LDAP/AD integration

Support

Support access method, VPN configuration

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 page.

4. Installation Directory Guide

You can use the pages under the /en/setup 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 page.

Access and Port Requirements

For detailed information, see the Access and Port Requirements for Installation page.

Installation Directory Guide

All documentation related to Apinizer installation is located under the /en/setup directory.

Installation Group

Apinizer

Basic Apinizer installation

Multi-Region

Multi-region installation

API Portal

API Portal installation

API Integration

API integration installation

Infrastructure Components Group

Kubernetes

Ubuntu Kubernetes

Kubernetes installation on Ubuntu

RHEL Kubernetes

Kubernetes installation on Red Hat Enterprise Linux

Kubernetes Metric Server

Kubernetes Metric Server installation

Kubernetes HA Cluster

Kubernetes cluster installation for high availability

Kubernetes Dashboard

Kubernetes Dashboard installation and usage

Prometheus and Grafana

Prometheus and Grafana integration for monitoring

Elasticsearch

Ubuntu Elasticsearch

Elasticsearch installation on Ubuntu

RHEL Elasticsearch

Elasticsearch installation on Red Hat Enterprise Linux

Simple Authentication

Elasticsearch security configuration

Permission Requirements

Elasticsearch authorization settings

Backup Policy

Elasticsearch backup strategies

Manual ILM Policy

Index Lifecycle Management configuration

MongoDB

Ubuntu MongoDB

MongoDB installation for Ubuntu operating system

RHEL MongoDB

MongoDB installation for Red Hat Enterprise Linux

Cloud

Amazon EKS

Installation on Amazon Elastic Kubernetes Service

Microsoft AKS

Installation on Azure Kubernetes Service

OpenShift Origin 3.11

Installation on OpenShift

Helm

Apinizer Helm

Helm chart installation for Apinizer

Elasticsearch Installation

Elasticsearch installation

MongoDB Helm

Helm chart installation for MongoDB

Offline

Ubuntu Offline

Offline installation for Ubuntu

RHEL 8.x Offline

Offline installation for Red Hat Enterprise Linux 8.x

RHEL 9.x Offline

Offline installation for Red Hat Enterprise Linux 9.x

Important Notes

  • 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
  • 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

Next Steps

Deployment Models

Learn which deployment model to choose

Network Connection Matrix

Learn port requirements between Apinizer components

Network Topology and Port Requirements

Get detailed information about port permissions

Apinizer Installation

Review Apinizer installation steps

Kubernetes Installation

Review Kubernetes installation steps

MongoDB Installation

Review MongoDB installation steps

Elasticsearch Installation

Review Elasticsearch installation steps