wlan-cloud-owprov/helm

owprov

This Helm chart helps to deploy OpenWIFI Provisioning service (further on refered as Provisioning) to the Kubernetes clusters. It is mainly used in assembly chart as Provisioning service requires other services as dependencies that are considered in that Helm chart. This chart is purposed to define deployment logic close to the application code itself and define default values that could be overriden during deployment.

TL;DR;

$ helm install .

Introduction

This chart bootstraps the Provisioning on a Kubernetes cluster using the Helm package manager.

Installing the Chart

Currently this chart is not assembled in charts archives, so helm-git is required for remote the installation

To install the chart with the release name my-release:

$ helm install --name my-release git+https://github.com/Telecominfraproject/wlan-cloud-owprov@helm/owprov-0.1.0.tgz?ref=main

The command deploys the Provisioning on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the chart and their default values. If Default value is not listed in the table, please refer to the Values files for details.

Parameter	Type	Description	Default
replicaCount	number	Amount of replicas to be deployed	1
strategyType	string	Application deployment strategy	'Recreate'
nameOverride	string	Override to be used for application deployment
fullnameOverride	string	Override to be used for application deployment (has priority over nameOverride)
images.owprov.repository	string	Docker image repository
images.owprov.tag	string	Docker image tag	'master'
images.owprov.pullPolicy	string	Docker image pull policy	'Always'
services.owprov.type	string	OpenWIFI Provisioning service type	'LoadBalancer'
services.owprov.ports.restapi.servicePort	number	REST API endpoint port to be exposed on service	16001
services.owprov.ports.restapi.targetPort	number	REST API endpoint port to be targeted by service	16001
services.owprov.ports.restapi.protocol	string	REST API endpoint protocol	'TCP'
services.owprov.ports.restapiinternal.servicePort	string	Internal REST API endpoint port to be exposed on service	17001
services.owprov.ports.restapiinternal.targetPort	number	Internal REST API endpoint port to be targeted by service	17001
services.owprov.ports.restapiinternal.protocol	string	Internal REST API endpoint protocol	'TCP'
checks.owprov.liveness.httpGet.path	string	Liveness check path to be used	'/'
checks.owprov.liveness.httpGet.port	number	Liveness check port to be used (should be pointint to ALB endpoint)	16101
checks.owprov.readiness.httpGet.path	string	Readiness check path to be used	'/'
checks.owprov.readiness.httpGet.port	number	Readiness check port to be used (should be pointint to ALB endpoint)	16101
ingresses.restapi.enabled	boolean	Defines if REST API endpoint should be exposed via Ingress controller	False
ingresses.restapi.hosts	array	List of hosts for exposed REST API
ingresses.restapi.paths	array	List of paths to be exposed for REST API
volumes.owprov	array	Defines list of volumes to be attached to the Provisioning
persistence.enabled	boolean	Defines if the Provisioning requires Persistent Volume (required for permanent files storage and SQLite DB if enabled)	True
persistence.accessModes	array	Defines PV access modes
persistence.size	string	Defines PV size	'10Gi'
public_env_variables	hash	Defines list of environment variables to be passed to the Provisioning
configProperties	hash	Configuration properties that should be passed to the application in owprov.properties. May be passed by key in set (i.e. configProperties."rtty\.token")
existingCertsSecret	string	Existing Kubernetes secret containing all required certificates and private keys for microservice operation. If set, certificates from certs key are ignored	""
certs	hash	Defines files (keys and certificates) that should be passed to the Gateway (PEM format is adviced to be used) (see volumes.owprov on where it is mounted). If existingCertsSecret is set, certificates passed this way will not be used.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set replicaCount=1 \
    .

The above command sets that only 1 instance of your app should be running

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml .

Tip

: You can use the default values.yaml as a base for customization.