K2HR3 Helm Chart

Helm Chart for K2HR3 (K2Hdkc based Resource and Roles and policy Rules)

This repository defines a Helm Chart for deploying K2HR3 systems on Kubernetes cluster.
The code in this repository is packaged as Helm Chart and distributed from Artifact Hub.

You can download the Helm Chart for K2HR3 from Artifact Hub and use it right away.

K2HR3 is built k2hdkc, k2hash, chmpx and k2hash transaction plugin components by AntPickax.

Customization

The following options/values are supported. See values.yaml for more detailed documentation and examples:

Parameter	Type	Description	Default
nameOverride	optional	Override release part of fully name, if not specified fullnameOverride value.	k2hr3
fullnameOverride	optional	Override fully chart/release name	n/a
serviceAccount.create	optional	Specifies whether to create a service account, default is true.	true
serviceAccount.annotations	optional	Annotations to add to the service account, default is empty.	{}
serviceAccount.name	optional	Specifies Service account name, default is empty. If not set and create is true, a name is generated using the fullname template.	""
antpickax.configDir	optional	Configration directory path for AntPickax products.	"/etc/antpickax"
antpickax.certPeriodYear	optional	Period years for self signed certificates using in pods.	5
minikube	optional	Specify whether or not it is a minikube environment.	false
k2hr3.clusterName	optional	Specify a cluster name for K2HR3 system, default is empty. If not set, a name is Release name(.Release.Name).	""
k2hr3.startManual	optional	Specifies whether to boot the k2hr3 system manually. This is a flag for debugging.	false
k2hr3.baseDomain	optional	Specifies the base domain name for the k2hr3 system. The default is empty, if empty k8s.domain is used.	""
k2hr3.dkc.baseName	optional	Specify the base name for K2HDKC cluster, default is empty in which case "r3dkc" will be used.	""
k2hr3.dkc.count	optional	Specify the server count in K2HKDC cluster.	2
k2hr3.api.baseName	optional	Specify the base name for K2HR3 REST API, default is empty in which case "r3api" will be used.	""
k2hr3.api.count	optional	Specify the server count of K2HR3 REST API.	2
k2hr3.api.extHostname	optional	Specify the external hostname(FQDN) for K2HR3 REST API system, default is empty in which case internal hostanme will be used.	""
k2hr3.api.extPort	optional	Specify the external port number for K2HR3 REST API system, default is 0 in which case 31443 will be used.	0
k2hr3.api.customConf	optional	Specify the custom configuration file content formatted by json string(config/local.json(local.json5)).	""
k2hr3.api.localTenant	optional	Specifies whether to support the LOCAL TENANT API.	true
k2hr3.app.baseName	optional	Specify the base name for K2HR3 Web Application, default is empty in which case "r3app" will be used.	""
k2hr3.app.count	optional	Specify the server count of K2HR3 Web Application.	2
k2hr3.app.extHostname	optional	Specify the external hostname(FQDN) for K2HR3 Web Application system, default is empty in which case internal hostanme will be used.	""
k2hr3.app.extPort	optional	Specify the external port number for K2HR3 Web Application system, default is 0 in which case 32443 will be used.	0
k2hr3.app.customConf	optional	Specify the custom configuration file content formatted by json string(config/local.json(local.json5)).	""
k2hr3.app.localTenant	optional	Specifies whether to support the LOCAL TENANT.	true
k2hr3.env.httpProxy	optional	Specify the HTTP PROXY(ex. "http://proxy.local:8080") for K2HR3 system, default is empty.	""
k2hr3.env.httpsProxy	optional	Specify the HTTPS PROXY(ex. "http://proxy.local:8080") for K2HR3 system, default is empty.	""
k2hr3.env.noProxy	optional	Specify the NO PROXY(ex. "internal,127.1.1.1") for K2HR3 system, default is empty.	""
images.app.fullImageName	optional	Specify the image full name(organaization/name/version) for K2HR3 Web Application.	""
images.app.organization	optional	Specify the organaization for K2HR3 Web Application, Valid only when images.app.fullImageName is not specified.	""
images.app.imageName	optional	Specify the image name for K2HR3 Web Application, Valid only when images.app.fullImageName is not specified.	""
images.app.version	optional	Specify the image version for K2HR3 Web Application, Valid only when images.app.fullImageName is not specified.	""
images.api.fullImageName	optional	Specify the image full name(organaization/name/version) for K2HR3 REST API.	""
images.api.organization	optional	Specify the organaization for K2HR3 REST API, Valid only when images.app.fullImageName is not specified.	""
images.api.imageName	optional	Specify the image name for K2HR3 REST API, Valid only when images.app.fullImageName is not specified.	""
images.api.version	optional	Specify the image version for K2HR3 REST API, Valid only when images.app.fullImageName is not specified.	""
images.dkc.fullImageName	optional	Specify the image full name(organaization/name/version) for the backend K2HDKC.	""
images.dkc.organization	optional	Specify the organaization for the backend K2HDKC, Valid only when images.app.fullImageName is not specified.	""
images.dkc.imageName	optional	Specify the image name for the backend K2HDKC, Valid only when images.app.fullImageName is not specified.	""
images.dkc.version	optional	Specify the image version for the backend K2HDKC, Valid only when images.app.fullImageName is not specified.	""
images.chmpx.fullImageName	optional	Specify the image full name(organaization/name/version) for the backend CHMPX.	""
images.chmpx.organization	optional	Specify the organaization for the backend CHMPX, Valid only when images.app.fullImageName is not specified.	""
images.chmpx.imageName	optional	Specify the image name for the backend CHMPX, Valid only when images.app.fullImageName is not specified.	""
images.chmpx.version	optional	Specify the image version for the backend CHMPX, Valid only when images.app.fullImageName is not specified.	""
images.init.fullImageName	optional	Specify the image full name(organaization/name/version) for the init container.	""
images.init.organization	optional	Specify the organaization for the init container, Valid only when images.app.fullImageName is not specified.	""
images.init.imageName	optional	Specify the image name for the init container, Valid only when images.app.fullImageName is not specified.	""
images.init.version	optional	Specify the image version for the init container, Valid only when images.app.fullImageName is not specified.	""
mountPoint.configMap	optional	Specify the directory path in each pods to mount the configmap.	"/configmap"
mountPoint.ca	optional	Specify the directory path in each pods to mount the secret which has CA self signed certificates.	"/secret-ca"
k8s.namespace	optional	Specify the kubernetes namespace to deploy K2HR3 system, default is empty. If not set, use Release.Namespace.	""
k8s.domain	optional	Specify the domain name of the kubernetes cluster to deploy K2HR3 system.	"svc.cluster.local"
k8s.caCert	optional	Specify the CA certificate file path for the kubernetes API.	"/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
k8s.saToken	optional	Specify the token file path for the Service account.	"/var/run/secrets/kubernetes.io/serviceaccount/token"
k8s.apiUrl	optional	Specify the kubernetes API URL.	"https://kubernetes.default.svc"
oidc.clientId	required	Specify the OpenID Connect Client ID.	n/a
oidc.clientSecret	required	Specify the OpenID Connect Secret.	n/a
oidc.cookieExpire	required	Specify the OpenID Connect Cookie Expire.	n/a
oidc.cookieName	required	Specify the OpenID Connect Cookie Name.	n/a
oidc.issuerUrl	required	Specify the OpenID Connect Issuer URL.	n/a
oidc.usernameKey	optional	Specify the OpenID Connect user key name, default is empty.	""
unconvertedFiles.k2hr3	optional	Specify the files(unconverted) to be placed in configmap. Normally, you do not need to change this value.	files/*.sh
convertedFiles.k2hr3	optional	Specify the files(converted) to be placed in configmap. Normally, you do not need to change this value.	files/*.sh

Usage

You can deploy and remove K2HR3 systems to your Kubernetes cluster in the order shown below.

Add Helm Chart repository

$ helm repo add k2hr3 https://helm.k2hr3.antpick.ax/

Install

You can install by specifying the release name and required options.
If you are using the minikube environment and want to install to that minikube, please add --set minikube=true option.

$ helm install <release name> k2hr3 \
    --set k2hr3.api.extHostname=<endpoint hostname for k2hr3 api> \
    --set k2hr3.app.extHostname=<endpoint hostname for k2hr3 app> \
    --set oidc.clientId=<OpenID Connect Client ID> \
    --set oidc.clientSecret=<OpenID Connect Secret> \
    --set oidc.cookieExpire=<OpenID Connect Cookie Expire(ex, 120)> \
    --set oidc.cookieName=<OpenID Connect Cookie Name(ex, id_token)> \
    --set oidc.issuerUrl=<OpenID Connect Issuer URL(ex, https://hoge/dex)> \
    --set oidc.usernameKey=<OpenID Connect user key name> \
    (--set minikube=true)

Test after install

You can check whether the installed Helm Chart is working properly as follows.

$ helm test <release name>

Uninstall

You can uninstall the installed Helm Chart by doing the following.

$ helm uninstall <release name>

Other operation

Other operations can be performed using the Helm command.
See helm --help for more information.

Use with RANCHER

K2HR3 Helm Chart can be used by registering the repository in RANCHER.
RANCHER allows you to use K2HR3 Helm Chart with more intuitive and simpler operations than using the helm command.
See the K2HR3 Helm Chart documentation for more details.

Documents

K2HR3 Document
K2HR3 Web Application Usage
K2HR3 Command Line Interface Usage
K2HR3 REST API Usage
K2HR3 Demonstration

About AntPickax

Repositories

K2HR3 Helm Chart
K2HR3 main repository
K2HR3 Web Application repository
K2HR3 Command Line Interface repository
K2HR3 REST API repository

License

This software is released under the MIT License, see the license file.

AntPickax

K2HR3 is one of AntPickax products.

Copyright(C) 2022 Yahoo Japan Corporation.