Skip to main content
Apinizer requires MongoDB during installation. If MongoDB is not installed, it needs to be installed first.

​
Prerequisites

Before starting the installation, make sure the following requirements are met:
  • Kubernetes cluster is ready and accessible
  • Helm is installed in your environment
  • MongoDB application is installed
If Helm is not installed, you can review the Helm Installation Document page.

​
1) Adding Repository

Add apinizer chart repo to Helm. 
helm repo add apinizer-charts https://apinizer1.github.io/apinizer-charts
helm repo update

​
2) Apinizer Installation

You can perform Apinizer installation without any special settings by running the following command: 
helm install apinizer-charts apinizer-charts/apinizer
Note: Apinizer version 2025.07.0 is used in the current installation. You can review all Apinizer versions on Docker Hub.

​
Optional Parameters

OptionDefault ValueDescription
image.managerapinizercloud/manager:2025.07.0Specifies the version of Apinizer manager image.
image.workerapinizercloud/worker:2025.07.0Specifies the version of Apinizer worker image.
image.cacheapinizercloud/cache:2025.07.0Specifies the version of Apinizer cache image.
mongoDB.hostNames[0]mongo-db-0.mongo-service.mongo.svc.cluster.localIf you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.
mongoDB.usernameIf MongoDB installation was done with Helm: kubectl get secret -n mongo mongodb-secret -o jsonpath="{.data.MONGO_ROOT_USERNAME}" | base64 --decode; echoIf you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.
mongoDB.passwordIf MongoDB installation was done with Helm: kubectl get secret -n mongo mongodb-secret -o jsonpath="{.data.MONGO_ROOT_PASSWORD}" | base64 --decode; echoIf you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.
mongoDB.dbNameapinizerdbIf you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.
mongoDB.authSourceadminIf you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.
mongoDB.port25080If you installed MongoDB with Helm, this value should be used by default and should not be changed. If you want to use your own MongoDB, you can change this value according to your needs.
environment.deploytrueThis value enables creating and deploying an environment in Apinizer. If you do not want environment creation, you can set this value to false.
ns.namespaceprodApinizer runs under the specified namespace when adding environment.
access.urlapigateway.apinizer.comBy default, this value is added to the Access URL field of environments. You can specify your own DNS address or IP address during Helm installation; you can also easily update it through the interface after installation.
When installing Apinizer components, MongoDB connection information and environment deploy status can be specified with example usage of the following optional parameters: 
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=<password> \
  --set mongoDB.port=<port> \
  --set environment.deploy=<true|false>