KONGA MODULE

This repo bring to use Konga as manager for ours Kong API Gateways.

Konga

An open source tool that enables you to manage your Kong API Gateway with ease

Stable Version

Name	Version
Konga Module	0.1.0

Requirements

Name	Version
Terraform	>= 0.13
Kubernetes	>= 1.16
PostgreSQL	>= 9.5
LDAP(optional)	""

Components

Previously we used a copy of the full panzel chart in this module and update it locally, now we will use our chart with those modifications.

We decide going to use our chart by default because they have the changes we need to be able to directly integrate an adapter for postgres or mysql.

These changes have already been requested to be accepted in the official konga chart pantsel/konga#622

Name	Repository	Version
Konga Chart	https://charts.bennu.cl	>= 1.0.2

Example main.tf

module "konga" {
  source  = "bennu/konga/helm"
  version = "0.0.8"

  db_host   = var.db_host
  db_name   = var.db_name
  db_pass   = var.db_pass
  db_user   = var.db_user
  namespace = "default"

  user_data = {
    "username"  = "xyz_admin",
    "email"     = "[email protected]",
    "firstName" = "xyz",
    "lastName"  = "domain",
  }
}

module "konga-prod" {
  source  = "bennu/konga/helm"

  db_host   = var.db_host
  db_name   = var.db_name
  db_pass   = var.db_pass
  db_user   = var.db_user
  namespace = "api-management"

  user_data = {
    "username"  = "management",
  }

  # It is possible to set a definition about the resources pods, so you only need to declare it.
  # using "resources" variable to map the limits as you need.
  resources = {
    requests = {
      memory = "150Mi"
      cpu    = "175m"
    }
    limits = {
      memory = "500Mi"
      cpu    = "650m"
    }
  }
}

Module Variables

Some details about variables for this Kong module.

Inputs

Name	Description	Type	Default	Required
db_host	PostgreSQL database hostname	string	n/a	yes
db_name	PostgreSQL database name	string	n/a	yes
db_pass	PostgreSQL database password	string	n/a	yes
db_user	PostgreSQL database user	string	n/a	yes
chart_extra_set_configs	Using a list of maps as [{"name"="foo", "value"="bar"},] to create dynamics blocks of 'set' to merge with values	list	[]	no
chart_name	Helm chart name for Konga	string	"konga"	no
chart_repository	Helm chart repository for Konga	string	"https://charts.bennu.cl"	no
db_port	PostgreSQL database port	string	"5432"	no
enable_ingress	Enable ingress for Konga	bool	false	no
enable_ldap	Enable LDAP connection for Konga. We can use configuration defined on https://github.com/pantsel/konga/blob/master/docs/LDAP.md if enable LDAP	bool	false	no
ingress_annotations	Ingress annotations for Konga	map	{}	no
ingress_host	Ingress host for Konga	string	"konga.local"	no
ingress_path	Ingress path for Konga	string	"/"	no
kong_endpoints	List of Kong endpoints connections used in Konga UI, Example: [{"kong_admin_url"="http://admin.local:8001", "name"="kong-admin", "type"="default"},]	list	[]	no
konga_image	Docker image for Konga	string	"pantsel/konga"	no
konga_tag	Docker tag image for Konga	string	"0.14.9"	no
ldap_attr_email	LDAP attribute name that should be used as the konga user's email address. Example: "mail"	string	null	no
ldap_attr_firstname	LDAP attribute name that should be used as the konga user's first name. Example: "givenName"	string	null	no
ldap_attr_lastname	LDAP attribute name that should be used as the konga user's last name. Example: "sn"	string	null	no
ldap_attr_username	LDAP attribute name that should be used as the konga username. Example: "sAMAccountName"	string	null	no
ldap_bind_dn	BIND DN to konga should use to login to LDAP to search users. Example: "cn=konga,ou=admin,dc=example,dc=com"	string	"dc=example,dc=com"	no
ldap_bind_pass	BIND PASS for the user konga will use to search for users	string	"secret"	no
ldap_group_attrs	List of attributes to pull from the LDAP server for groups. Example: "cn"	string	null	no
ldap_group_reg	Regular expression used to determine if a group should be considered as an admin user. Example: "^(admin|konga)$ "	string	null	no
ldap_group_search_base	Base DN used to search for groups. Example: "ou=groups,dc=com"	string	null	no
ldap_group_search_filter	Filter expression used to search for groups. Example: "(|(memberUid={{uid}})(memberUid={{uidNumber}})(sAMAccountName={{uid}}))"	string	null	no
ldap_host	LDAP Server connection as ldap://	string	"ldap://localhost:389"	no
ldap_user_attrs	List of attributes to pull from the LDAP server for users. Example: "sAMAccountName,uSNCreated,givenName,sn,mail"	string	null	no
ldap_user_search_base	Base DN used to search for users. Example: "ou=users,dc=com"	string	null	no
ldap_user_search_filter	The filter expression used to search for users. Example: "sAMAccountName={{username}}"	string	null	no
name	Value for konga name in pods	string	""	no
namespace	Namespace where resources are deployed	string	"default"	no
recreate_pods	Used for restart pods when some changes in configmap are doing for Konga	bool	true	no
reg_cred	Registry secret credential	list	[]	no
registry	Custom registry host for be used in all the containers	string	""	no
resources	Define the limits and/or requests on pod resources	map	{}	no
user_data	User default data information used to autoconfigure when run Konga	map	{ "email": "[email protected]", "firstName": "Admin", "lastName": "Konga", "username": "devops" }	no

Outputs

Name	Description
hostname	Konga hostname
password	Password for default user, valid when LDAP is disable