Install Developer Portal on Kubernetes

​

Compatible Kubernetes Versions

​

Prerequisites

• Kubernetes
• Helm 3+
• Enterprise Edition License

​

Tyk Stack (New Helm Chart)

1. As part of Tyk Self-Managed - Enable global.components.devPortal during Tyk Self-Managed deployment using the tyk-stack chart
2. Standalone installation - Use the tyk-dev-portal Helm chart (described below)

​

Instructions

1. Create the tyk-dev-portal-conf secret Make sure the tyk-dev-portal-conf secret exists in your namespace. This secret will automatically be generated if Tyk Dashboard instance was bootstrapped with tyk-boostrap component chart and bootstrap.devPortal was set to true in the values.yaml. If the secret does not exist, you can create it by running the following command.
   kubectl create secret generic tyk-dev-portal-conf -n ${NAMESPACE} \
   --from-literal=TYK_ORG=${TYK_ORG} \
   --from-literal=TYK_AUTH=${TYK_AUTH}
   
   The fields TYK_ORG and TYK_AUTH are the Tyk Dashboard Organization ID and the Tyk Dashboard API Access Credentials respectively. These can be obtained under your profile in the Tyk Dashboard.
2. Config settings You must set the following values in the values.yaml or with --set {field-name}={field-value} using the helm upgrade command:

   Field Name	Description
   global.adminUser.email and global.adminUser.password	Set portal admin username and email for bootstrapping
   global.secrets.devPortal	Enable portal bootstrapping by providing secret name
   license	Tyk license key for your portal installation
   storage.type	Portal storage type, e.g. fs, s3 and db
   image.tag	Developer Portal version. You can get the latest version image tag from Docker Hub
   database.dialect	Portal database dialect, e.g. mysql, postgres
   database.connectionString	Connection string to the Portal’s database, e.g. for the mysql dialect: admin:secr3t@tcp(tyk-portal-mysql:3306)/portal?charset=utf8mb4&parseTime=true

   In addition to values.yaml, you can also define the environment variables described in the configuration section to further customize your portal deployment. These environment variables can also be listed as a name value list under the extraEnvs section of the helm chart.
3. Launch the portal using the helm chart Run the following command to update your infrastructure and install the developer portal:
   helm install tyk-dev-portal tyk-helm/tyk-dev-portal -f values.yaml -n tyk
   
4. Bootstrapping the Developer Portal Follow the bootstrapping section of the documentation to bootstrap the portal via the UI or the admin API.

​

Configuration

Note: Helm chart supports Developer Portal v1.2.0+.

​

Pod Security Context

securityContext:
  runAsNonRoot: true
  runAsUser: 1000
  fsGroup: 2000

containerSecurityContext:
  runAsNonRoot: true
  runAsUser: 1000
  allowPrivilegeEscalation: false
  privileged: false
  readOnlyRootFilesystem: true
  seccompProfile:
    type: RuntimeDefault
  capabilities:
    drop:
      - ALL

​

Bootstrap Job

kubectl get jobs -n <namespace>
kubectl logs job/dev-portal-job-<release-name> -n <namespace>

1. Set global.components.bootstrap: false in your values.yaml and deploy.
2. Wait for the Portal pod to be ready, then send the bootstrap request:

curl -X POST http://<portal-service>:<port>/portal-api/bootstrap \
  -H "Content-Type: application/json" \
  -d '{
    "username": "admin@example.com",
    "password": "your-password",
    "first_name": "Admin",
    "last_name": "User"
  }'

​

Storage

storage:
  type: fs
  persistence:
    storageClass: "standard"
    accessModes:
      - ReadWriteOnce
    size: 8Gi

​

Scaling and Replicas

kind: Deployment
replicaCount: 3

storage:
  type: db  # or s3; both support concurrent access from multiple replicas

​

Troubleshooting

​

Legacy Helm Chart

​

Instructions

1. Create the tyk-enterprise-portal-conf secret Make sure the tyk-enterprise-portal-conf secret exists in your namespace. This secret will automatically be generated during the Tyk Dashboard bootstrap if the dash.enterprisePortalSecret value is set to true in the values.yaml. If the secret does not exist, you can create it by running the following command.
   kubectl create secret generic tyk-enterprise-portal-conf -n ${NAMESPACE} \
   --from-literal=TYK_ORG=${TYK_ORG} \
   --from-literal=TYK_AUTH=${TYK_AUTH}
   
   Where TYK_ORG and TYK_AUTH are the Tyk Dashboard Organization ID and the Tyk Dashboard API Access Credentials respectively. Which can be obtained under your profile in the Tyk Dashboard.
2. Config settings You must set the following values in the values.yaml or with --set {field-name}={field-value} with the helm upgrade command:

   Field Name	Description
   enterprisePortal.enabled	Enable Portal installation
   enterprisePortal.bootstrap	Enable Portal bootstrapping
   enterprisePortal.license	Tyk license key for your portal installation
   enterprisePortal.storage.type	Portal database dialect, e.g mysql, postgres
   enterprisePortal.storage.connectionString	Connection string to the Portal’s database, e.g for the mysql dialect: admin:secr3t@tcp(tyk-portal-mysql:3306)/portal?charset=utf8mb4&parseTime=true

   In addition to values.yaml, you can also define the environment variables described in the configuration section to further customize your portal deployment. These environment variables can also be listed as a name value list under the extraEnvs section of the helm chart.
3. Launch the portal using the helm chart Run the following command to update your infrastructure and install the developer portal:
   helm upgrade tyk-pro tyk-helm/tyk-pro -f values.yaml -n tyk
   
   In case this is the first time you are launching the portal, it will be necessary to bootstrap it before you can use it. For detailed instructions, please refer to the bootstrapping documentation.

Note: Helm chart supports Developer Portal v1.2.0+.