Apinizer Installation with Helm
This document describes the basic steps for installing Apinizer in a Kubernetes environment using Helm.
Apinizer requires MongoDB during installation. If MongoDB is not already installed, it must be set up first.
Prerequisites
A ready and accessible Kubernetes cluster
Helm installed in your environment
- MongoDB must be installed.
If Helm is not installed, you can refer to the Installation with Helm.
1) Adding the Repository
The Apinizer chart repository is added to Helm.
helm repo add apinizer-charts https://apinizer1.github.io/apinizer-charts
helm repo update2) Apinizer Installation
You can install Apinizer without any custom configuration by running the following command:
helm install apinizer-charts apinizer-charts/apinizerNote: The current installation uses Apinizer version 2025.07.0. You can browse all available Apinizer versions on Docker Hub.
Optional Parameters
| options | Default Value | Description |
|---|---|---|
| image.manager | apinizercloud/manager:2025.07.0 | Specifies the version of the Apinizer manager image. |
| image.worker | apinizercloud/worker:2025.07.0 | Specifies the version of the Apinizer worker image. |
| image.cache | apinizercloud/cache:2025.07.0 | Specifies the version of the Apinizer cache image. |
| mongoDB.hostNames[0] | mongo-db-0.mongo-service.mongo.svc.cluster.local | If you installed MongoDB using Helm, this value should be used as the default and must not be changed. If you want to use your own MongoDB instance, you can modify this value according to your needs. |
| mongoDB.username | If MongoDB was installed using Helm: kubectl get secret -n mongo mongodb-secret -o jsonpath="{.data.MONGO_ROOT_USERNAME}" | base64 --decode; echo | If you installed MongoDB using Helm, this value should be used as the default and must not be changed. If you want to use your own MongoDB instance, you can modify this value according to your needs. |
| mongoDB.password | If MongoDB was installed using Helm: kubectl get secret -n mongo mongodb-secret -o jsonpath="{.data.MONGO_ROOT_PASSWORD}" | base64 --decode; echo | If you installed MongoDB using Helm, this value should be used as the default and must not be changed. If you want to use your own MongoDB instance, you can modify this value according to your needs. |
| mongoDB.dbName | apinizerdb | If you installed MongoDB using Helm, this value should be used as the default and must not be changed. If you want to use your own MongoDB instance, you can modify this value according to your needs. |
| mongoDB.authSource | admin | If you installed MongoDB using Helm, this value should be used as the default and must not be changed. If you want to use your own MongoDB instance, you can modify this value according to your needs. |
| mongoDB.port | 25080 | If you installed MongoDB using Helm, this value should be used as the default and must not be changed. If you want to use your own MongoDB instance, you can modify this value according to your needs. |
| environment.deploy | true | This value enables the creation and deployment of an environment in Apinizer. If you do not want an environment to be created, you can set this value to 'false'. |
| ns.namespace | prod | Apinizer operates under the specified namespace when adding an environment. |
| access.url | apigateway.apinizer.com | By default, this value is added to the Access URL field of environments. You can specify your own DNS address or IP address during the Helm installation, and you can easily update it via the interface after installation. |
While installing Apinizer components, the MongoDB connection details and environment deployment status can be specified using the following optional parameters with example usage:
helm install apinizer-charts apinizer-charts/apinizer \
--set mongoDB.hostNames[0]=<mongo-hostname0> \
--set mongoDB.hostNames[1]=<mongo-hostname1> \
--set mongoDB.hostNames[2]=<mongo-hostname2> \
--set mongoDB.username=<username> \
--set mongoDB.password=<passoword> \
--set mongoDB.port=<port> \
--set environment.deploy=<true|false>