{"id":22690031,"url":"https://github.com/yahoojapan/k2hr3_helm_chart","last_synced_at":"2025-06-25T02:35:40.733Z","repository":{"id":43268324,"uuid":"454222229","full_name":"yahoojapan/k2hr3_helm_chart","owner":"yahoojapan","description":"Helm Chart for K2HR3","archived":false,"fork":false,"pushed_at":"2025-03-27T06:58:58.000Z","size":255,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-08T16:02:50.302Z","etag":null,"topics":["antpickax","chart","chmpx","helm","helm-chart","helm-charts","k2hash","k2hdkc","k2hr3","k2hr3-setup","k8s","kubernetes","kvs","nosql","rancher","rancher2","rbac"],"latest_commit_sha":null,"homepage":"https://k2hr3.antpick.ax/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yahoojapan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-02-01T01:01:57.000Z","updated_at":"2025-03-27T06:58:29.000Z","dependencies_parsed_at":"2023-01-30T18:10:18.372Z","dependency_job_id":"602fe752-1af3-42cb-9516-69bd9ace1442","html_url":"https://github.com/yahoojapan/k2hr3_helm_chart","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/yahoojapan/k2hr3_helm_chart","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoojapan%2Fk2hr3_helm_chart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoojapan%2Fk2hr3_helm_chart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoojapan%2Fk2hr3_helm_chart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoojapan%2Fk2hr3_helm_chart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yahoojapan","download_url":"https://codeload.github.com/yahoojapan/k2hr3_helm_chart/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoojapan%2Fk2hr3_helm_chart/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261791753,"owners_count":23210192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antpickax","chart","chmpx","helm","helm-chart","helm-charts","k2hash","k2hdkc","k2hr3","k2hr3-setup","k8s","kubernetes","kvs","nosql","rancher","rancher2","rbac"],"created_at":"2024-12-10T00:25:11.758Z","updated_at":"2025-06-25T02:35:40.710Z","avatar_url":"https://github.com/yahoojapan.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"K2HR3 Helm Chart\n----------------\n[![Helm AntPickax CI](https://github.com/yahoojapan/k2hr3_helm_chart/workflows/Helm%20AntPickax%20CI/badge.svg)](https://github.com/yahoojapan/k2hr3_helm_chart/actions)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/yahoojapan/k2hr3_helm_chart/master/LICENSE)\n[![GitHub forks](https://img.shields.io/github/forks/yahoojapan/k2hr3_helm_chart.svg)](https://github.com/yahoojapan/k2hr3_helm_chart/network)\n[![GitHub stars](https://img.shields.io/github/stars/yahoojapan/k2hr3_helm_chart.svg)](https://github.com/yahoojapan/k2hr3_helm_chart/stargazers)\n[![GitHub issues](https://img.shields.io/github/issues/yahoojapan/k2hr3_helm_chart.svg)](https://github.com/yahoojapan/k2hr3_helm_chart/issues)\n[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/k2hr3)](https://artifacthub.io/packages/helm/k2hr3/k2hr3)\n\n## Helm Chart for K2HR3 (K2Hdkc based Resource and Roles and policy Rules)\nThis repository defines a **Helm Chart** for deploying **K2HR3 systems** on Kubernetes cluster.  \nThe code in this repository is packaged as Helm Chart and distributed from [Artifact Hub](https://artifacthub.io/packages/helm/k2hr3/k2hr3).  \n\nYou can download the Helm Chart for K2HR3 from Artifact Hub and use it right away.\n\n\u003cimg src=\"https://k2hr3.antpick.ax/images/top_k2hr3_helm.png\" width=\"60%\" height=\"60%\"\u003e\n\nK2HR3 is built [k2hdkc](https://github.com/yahoojapan/k2hdkc), [k2hash](https://github.com/yahoojapan/k2hash), [chmpx](https://github.com/yahoojapan/chmpx) and [k2hash transaction plugin](https://github.com/yahoojapan/k2htp_dtor) components by [AntPickax](https://antpick.ax/).\n\n## Customization\nThe following options/values are supported. See values.yaml for more detailed documentation and examples:\n\n| Parameter                      | Type         | Description                                                                                                                         | Default |\n|--------------------------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------|---------|\n| `nameOverride`                 | optional     | Override release part of fully name, if not specified fullnameOverride value.                                                       | `k2hr3` |\n| `fullnameOverride`             | optional     | Override fully chart/release name                                                                                                   | n/a     |\n| `serviceAccount.create`        | optional     | Specifies whether to create a service account, default is true.                                                                     | true    |\n| `serviceAccount.annotations`   | optional     | Annotations to add to the service account, default is empty.                                                                        | {}      |\n| `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.   | \"\"      |\n| `antpickax.configDir`          | optional     | Configration directory path for AntPickax products.                                                                                 | \"/etc/antpickax\" |\n| `antpickax.certPeriodYear`     | optional     | Period years for self signed certificates using in pods.                                                                            | 5       |\n| `minikube`                     | optional     | Specify whether or not it is a minikube environment.                                                                                | false   |\n| `k2hr3.clusterName`            | optional     | Specify a cluster name for K2HR3 system, default is empty. If not set, a name is Release name(.Release.Name).                       | \"\"      |\n| `k2hr3.startManual`            | optional     | Specifies whether to boot the k2hr3 system manually. This is a flag for debugging.                                                  | false   |\n| `k2hr3.baseDomain`             | optional     | Specifies the base domain name for the k2hr3 system. The default is empty, if empty k8s.domain is used.                             | \"\"      |\n| `k2hr3.dkc.baseName`           | optional     | Specify the base name for K2HDKC cluster, default is empty in which case \"r3dkc\" will be used.                                      | \"\"      |\n| `k2hr3.dkc.count`              | optional     | Specify the server count in K2HKDC cluster.                                                                                         | 2       |\n| `k2hr3.api.baseName`           | optional     | Specify the base name for K2HR3 REST API, default is empty in which case \"r3api\" will be used.                                      | \"\"      |\n| `k2hr3.api.count`              | optional     | Specify the server count of K2HR3 REST API.                                                                                         | 2       |\n| `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.       | \"\"      |\n| `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       |\n| `k2hr3.api.customConf`         | optional     | Specify the custom configuration file content formatted by json string(config/local.json(local.json5)).                             | \"\"      |\n| `k2hr3.api.localTenant`        | optional     | Specifies whether to support the LOCAL TENANT API.                                                                                  | true    |\n| `k2hr3.app.baseName`           | optional     | Specify the base name for K2HR3 Web Application, default is empty in which case \"r3app\" will be used.                               | \"\"      |\n| `k2hr3.app.count`              | optional     | Specify the server count of K2HR3 Web Application.                                                                                  | 2       |\n| `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.| \"\"      |\n| `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       |\n| `k2hr3.app.customConf`         | optional     | Specify the custom configuration file content formatted by json string(config/local.json(local.json5)).                             | \"\"      |\n| `k2hr3.app.localTenant`        | optional     | Specifies whether to support the LOCAL TENANT.                                                                                      | true    |\n| `k2hr3.env.httpProxy`          | optional     | Specify the HTTP PROXY(ex. \"http://proxy.local:8080\") for K2HR3 system, default is empty.                                           | \"\"      |\n| `k2hr3.env.httpsProxy`         | optional     | Specify the HTTPS PROXY(ex. \"http://proxy.local:8080\") for K2HR3 system, default is empty.                                          | \"\"      |\n| `k2hr3.env.noProxy`            | optional     | Specify the NO PROXY(ex. \"internal,127.1.1.1\") for K2HR3 system, default is empty.                                                  | \"\"      |\n| `images.app.fullImageName`     | optional     | Specify the image full name(organaization/name/version) for K2HR3 Web Application.                                                  | \"\"      |\n| `images.app.organization`      | optional     | Specify the organaization for K2HR3 Web Application, Valid only when images.app.fullImageName is not specified.                     | \"\"      |\n| `images.app.imageName`         | optional     | Specify the image name for K2HR3 Web Application, Valid only when images.app.fullImageName is not specified.                        | \"\"      |\n| `images.app.version`           | optional     | Specify the image version for K2HR3 Web Application, Valid only when images.app.fullImageName is not specified.                     | \"\"      |\n| `images.api.fullImageName`     | optional     | Specify the image full name(organaization/name/version) for K2HR3 REST API.                                                         | \"\"      |\n| `images.api.organization`      | optional     | Specify the organaization for K2HR3 REST API, Valid only when images.app.fullImageName is not specified.                            | \"\"      |\n| `images.api.imageName`         | optional     | Specify the image name for K2HR3 REST API, Valid only when images.app.fullImageName is not specified.                               | \"\"      |\n| `images.api.version`           | optional     | Specify the image version for K2HR3 REST API, Valid only when images.app.fullImageName is not specified.                            | \"\"      |\n| `images.dkc.fullImageName`     | optional     | Specify the image full name(organaization/name/version) for the backend K2HDKC.                                                     | \"\"      |\n| `images.dkc.organization`      | optional     | Specify the organaization for the backend K2HDKC, Valid only when images.app.fullImageName is not specified.                        | \"\"      |\n| `images.dkc.imageName`         | optional     | Specify the image name for the backend K2HDKC, Valid only when images.app.fullImageName is not specified.                           | \"\"      |\n| `images.dkc.version`           | optional     | Specify the image version for the backend K2HDKC, Valid only when images.app.fullImageName is not specified.                        | \"\"      |\n| `images.chmpx.fullImageName`   | optional     | Specify the image full name(organaization/name/version) for the backend CHMPX.                                                      | \"\"      |\n| `images.chmpx.organization`    | optional     | Specify the organaization for the backend CHMPX, Valid only when images.app.fullImageName is not specified.                         | \"\"      |\n| `images.chmpx.imageName`       | optional     | Specify the image name for the backend CHMPX, Valid only when images.app.fullImageName is not specified.                            | \"\"      |\n| `images.chmpx.version`         | optional     | Specify the image version for the backend CHMPX, Valid only when images.app.fullImageName is not specified.                         | \"\"      |\n| `images.init.fullImageName`    | optional     | Specify the image full name(organaization/name/version) for the init container.                                                     | \"\"      |\n| `images.init.organization`     | optional     | Specify the organaization for the init container, Valid only when images.app.fullImageName is not specified.                        | \"\"      |\n| `images.init.imageName`        | optional     | Specify the image name for the init container, Valid only when images.app.fullImageName is not specified.                           | \"\"      |\n| `images.init.version`          | optional     | Specify the image version for the init container, Valid only when images.app.fullImageName is not specified.                        | \"\"      |\n| `mountPoint.configMap`         | optional     | Specify the directory path in each pods to mount the configmap.                                                                     | \"/configmap\" |\n| `mountPoint.ca`                | optional     | Specify the directory path in each pods to mount the secret which has CA self signed certificates.                                  | \"/secret-ca\" |\n| `k8s.namespace`                | optional     | Specify the kubernetes namespace to deploy K2HR3 system, default is empty. If not set, use Release.Namespace.                       | \"\"      |\n| `k8s.domain`                   | optional     | Specify the domain name of the kubernetes cluster to deploy K2HR3 system.                                                           | \"svc.cluster.local\" |\n| `k8s.caCert`                   | optional     | Specify the CA certificate file path for the kubernetes API.                                                                        | \"/var/run/secrets/kubernetes.io/serviceaccount/ca.crt\" |\n| `k8s.saToken`                  | optional     | Specify the token file path for the Service account.                                                                                | \"/var/run/secrets/kubernetes.io/serviceaccount/token\" |\n| `k8s.apiUrl`                   | optional     | Specify the kubernetes API URL.                                                                                                     | \"https://kubernetes.default.svc\" |\n| `oidc.clientId`                | **required** | Specify the OpenID Connect Client ID.                                                                                               | n/a     |\n| `oidc.clientSecret`            | **required** | Specify the OpenID Connect Secret.                                                                                                  | n/a     |\n| `oidc.cookieExpire`            | **required** | Specify the OpenID Connect Cookie Expire.                                                                                           | n/a     |\n| `oidc.cookieName`              | **required** | Specify the OpenID Connect Cookie Name.                                                                                             | n/a     |\n| `oidc.issuerUrl`               | **required** | Specify the OpenID Connect Issuer URL.                                                                                              | n/a     |\n| `oidc.usernameKey`             | optional     | Specify the OpenID Connect user key name, default is empty.                                                                         | \"\"      |\n| `unconvertedFiles.k2hr3`       | optional     | Specify the files(unconverted) to be placed in configmap. Normally, you do not need to change this value.                           | files/*.sh |\n| `convertedFiles.k2hr3`         | optional     | Specify the files(converted) to be placed in configmap. Normally, you do not need to change this value.                             | files/*.sh |\n\n## Usage\nYou can deploy and remove K2HR3 systems to your Kubernetes cluster in the order shown below.\n\n### Add Helm Chart repository\n```\n$ helm repo add k2hr3 https://helm.k2hr3.antpick.ax/\n```\n\n### Install\nYou can install by specifying the `release name` and `required options`.  \nIf you are using the `minikube` environment and want to install to that minikube, please add `--set minikube=true` option.  \n```\n$ helm install \u003crelease name\u003e k2hr3 \\\n    --set k2hr3.api.extHostname=\u003cendpoint hostname for k2hr3 api\u003e \\\n    --set k2hr3.app.extHostname=\u003cendpoint hostname for k2hr3 app\u003e \\\n    --set oidc.clientId=\u003cOpenID Connect Client ID\u003e \\\n    --set oidc.clientSecret=\u003cOpenID Connect Secret\u003e \\\n    --set oidc.cookieExpire=\u003cOpenID Connect Cookie Expire(ex, 120)\u003e \\\n    --set oidc.cookieName=\u003cOpenID Connect Cookie Name(ex, id_token)\u003e \\\n    --set oidc.issuerUrl=\u003cOpenID Connect Issuer URL(ex, https://hoge/dex)\u003e \\\n    --set oidc.usernameKey=\u003cOpenID Connect user key name\u003e \\\n    (--set minikube=true)\n```\n\n### Test after install\nYou can check whether the installed Helm Chart is working properly as follows.  \n```\n$ helm test \u003crelease name\u003e\n```\n\n### Uninstall\nYou can uninstall the installed Helm Chart by doing the following.  \n```\n$ helm uninstall \u003crelease name\u003e\n```\n\n### Other operation\nOther operations can be performed using the Helm command.  \nSee `helm --help` for more information.\n\n## Use with RANCHER\nK2HR3 Helm Chart can be used by registering the repository in [RANCHER](https://rancher.com/).  \n[RANCHER](https://rancher.com/) allows you to use K2HR3 Helm Chart with more intuitive and simpler operations than using the `helm` command.  \nSee the [K2HR3 Helm Chart documentation](https://github.com/yahoojapan/k2hr3_helm_chart) for more details.  \n\n## Documents\n[K2HR3 Document](https://k2hr3.antpick.ax/index.html)  \n[K2HR3 Web Application Usage](https://k2hr3.antpick.ax/usage_app.html)  \n[K2HR3 Command Line Interface Usage](https://k2hr3.antpick.ax/cli.html)  \n[K2HR3 REST API Usage](https://k2hr3.antpick.ax/api.html)  \n[K2HR3 Demonstration](https://demo.k2hr3.antpick.ax/)\n\n[About AntPickax](https://antpick.ax/)  \n\n## Repositories\n[K2HR3 Helm Chart](https://github.com/yahoojapan/k2hr3_helm_chart)  \n[K2HR3 main repository](https://github.com/yahoojapan/k2hr3)  \n[K2HR3 Web Application repository](https://github.com/yahoojapan/k2hr3_app)  \n[K2HR3 Command Line Interface repository](https://github.com/yahoojapan/k2hr3_cli)  \n[K2HR3 REST API repository](https://github.com/yahoojapan/k2hr3_api)  \n\n## License\nThis software is released under the MIT License, see the license file.\n\n## AntPickax\nK2HR3 is one of [AntPickax](https://antpick.ax/) products.\n\nCopyright(C) 2022 Yahoo Japan Corporation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyahoojapan%2Fk2hr3_helm_chart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyahoojapan%2Fk2hr3_helm_chart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyahoojapan%2Fk2hr3_helm_chart/lists"}