closes mosip/commons#1860 Merge changes from release-1.3.x to develop #213 by ckm007 · Pull Request #206 · mosip/keycloak

ckm007 · 2026-06-04T07:42:54Z

Summary by CodeRabbit

New Features
- Added automated Keycloak deployment scripts for installation, deletion, data export/import, and configuration management
- Added new Keycloak initialization Helm chart with built-in configuration support
Documentation
- Enhanced deployment documentation with comprehensive Keycloak setup and management instructions
- Updated README with contribution guidelines and community support information
Chores
- Added GitHub Actions workflows for automated chart linting, publishing, and verification
- Updated container base image

Signed-off-by: techno-467 <prafulrakhade02@gmail.com>

[MOSIP-35490] moved required helm and deploy scripts to modular repo

Signed-off-by: Rakshith B <79500257+Rakshithb1@users.noreply.github.com>

[DSD-7140] added view-users

Signed-off-by: Rakshith B <79500257+Rakshithb1@users.noreply.github.com>

[DSD-7140] added verify-keycloak-init.yml

Signed-off-by: Rakshitha650 <76676196+Rakshitha650@users.noreply.github.com>

Signed-off-by: Chandra Keshav Mishra <chandrakeshavmishra@gmail.com>

[MOSIP-41025] added role ONLINE_REGISTRATION_CLIENT addition

Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com>

[MOSIP-43640] changes for GA release

… branch Signed-off-by: bhumi46 <thisisbn46@gmail.com>

[DSD-9381]Updated helm charts, pustrigger,and dockerfile from develop…

* [MOSIP-43640] Update keycloak init Signed-off-by: Praful Rakhade <prafulrakhade02@gmail.com> * Update PostgreSQL image settings in install.sh Signed-off-by: Praful Rakhade <prafulrakhade02@gmail.com> * Update Keycloak chart version to 1.3.0-develop Signed-off-by: Praful Rakhade <prafulrakhade02@gmail.com> --------- Signed-off-by: Praful Rakhade <prafulrakhade02@gmail.com>

Signed-off-by: Mohanraj209 <mohan1715@gmail.com>

Signed-off-by: Mohan E <mohanraj1715@gmail.com>

[MOSIP-44060] Updated keycloak install and initialization scripts.

Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com>

[MOSIP-44106] updated README.md file

* Updated chart versions, image and tag for release changes Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * [DSD-9524] Platform 1.2.1.0 GA release Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com> --------- Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com> Co-authored-by: Prafulrakhade <99539100+Prafulrakhade@users.noreply.github.com> Co-authored-by: Prafulrakhade <prafulrakhade02@gmail.com>

+    uses: mosip/kattu/.github/workflows/chart-lint-publish.yml@master
+    with:
+      CHARTS_DIR: ./helm
+      CHARTS_URL: https://mosip.github.io/mosip-helm
+      REPOSITORY: mosip-helm
+      BRANCH: gh-pages
+      INCLUDE_ALL_CHARTS: "${{ inputs.INCLUDE_ALL_CHARTS || 'NO' }}"
+      IGNORE_CHARTS: "${{ inputs.IGNORE_CHARTS || '\"\"' }}"
+      CHART_PUBLISH: "${{ inputs.CHART_PUBLISH || 'YES' }}"
+      LINTING_CHART_SCHEMA_YAML_URL: "https://raw.githubusercontent.com/mosip/kattu/master/.github/helm-lint-configs/chart-schema.yaml"
+      LINTING_LINTCONF_YAML_URL: "https://raw.githubusercontent.com/mosip/kattu/master/.github/helm-lint-configs/lintconf.yaml"
+      LINTING_CHART_TESTING_CONFIG_YAML_URL: "https://raw.githubusercontent.com/mosip/kattu/master/.github/helm-lint-configs/chart-testing-config.yaml"
+      LINTING_HEALTH_CHECK_SCHEMA_YAML_URL: "https://raw.githubusercontent.com/mosip/kattu/master/.github/helm-lint-configs/health-check-schema.yaml"
+    secrets:
+      TOKEN: ${{ secrets.ACTION_PAT }}
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}


+    uses: mosip/kattu/.github/workflows/verify-keycloak-init.yml@master
+    with: 
+      kc_values_file_path: helm/keycloak-init/values.yaml


coderabbitai · 2026-06-04T07:43:06Z

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR adds comprehensive Keycloak deployment infrastructure for MOSIP Kubernetes clusters. It introduces a complete keycloak-init Helm chart with templated initialization jobs, multiple deployment scripts with interactive configuration, GitHub Actions workflows for automation, realm/client configuration files, and updates the base Docker image for keycloak-artemis.

Changes

Keycloak Deployment Infrastructure

Layer / File(s)	Summary
CI/CD Workflows and Automation `.github/workflows/chart-lint-publish.yml`, `.github/workflows/verify-keycloak-init.yml`, `.github/workflows/push-trigger.yml`	New `chart-lint-publish` workflow triggers on releases/PRs/pushes to validate and publish Helm charts to `gh-pages`. New `verify-keycloak-init` workflow validates keycloak-init chart changes. Platform configuration (`PLATFORMS: linux/amd64`) added to docker service matrix in push-trigger.
Documentation and Project Metadata `README.md`, `deploy/README.md`	README updated with documentation links and contribution/community sections. Comprehensive deployment documentation added covering installation options, prerequisites, Keycloak configuration, PostgreSQL persistence, realm/user export/import procedures, and reference to deployment scripts.
Keycloak Init Helm Chart Structure and Templates `helm/keycloak-init/Chart.yaml`, `helm/keycloak-init/README.md`, `helm/keycloak-init/templates/_helpers.tpl`, `helm/keycloak-init/templates/*.yaml`, `helm/keycloak-init/.gitignore`, `helm/keycloak-init/.helmignore`	Complete keycloak-init Helm chart with metadata, template helpers for naming/labels/service accounts, and Kubernetes resource templates: ServiceAccount, two ConfigMaps (keycloak-host and configuration), Client Secrets, Initialization Job with environment/volume injection, and test connection hook.
Deployment Configuration and Values Files `helm/keycloak-init/values.yaml`, `deploy/values.yaml`, `deploy/import-init-values.yaml`, `deploy/upgrade-init-values.yaml`, `deploy/istio-addons-values.yaml`	Helm chart values defining realms, clients, roles, client scopes with OIDC protocol and token mappers. Keycloak service values with ingress/security context/resource config. Import/upgrade values specifying realm configuration, client role assignments, and token claim mappers. Istio addon values for gateway/virtual service configuration.
Installation and Operational Management Scripts `deploy/install.sh`, `deploy/delete.sh`, `deploy/keycloak_init.sh`, `deploy/import-init.sh`, `deploy/upgrade-init.sh`, `deploy/export.sh`, `deploy/update_secret.sh`	`install.sh` performs full Keycloak and Istio addon deployment with namespace creation and interactive host validation. `keycloak_init.sh` collects SMTP/service configuration and runs keycloak-init Helm chart. `import-init.sh` and `upgrade-init.sh` initialize realm/client data. `export.sh` exports realm/user data from running Keycloak pod. `delete.sh` uninstalls Keycloak releases. `update_secret.sh` manages admin password credentials.
Base Docker Image Update `keycloak-artemis/Dockerfile`	Base image switched from `bitnami/keycloak:16.1.1` to `mosipid/keycloak:16.1.1`. Debian APT sources patching added to use archive/Debian mirrors.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Poem

🐰 A Keycloak realm takes shape with helm,
Charts and scripts join at the helm,
MOSIP's IAM now unified,
Kubernetes workflows certified,
Deploy, export, and realms align! 🔐

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 12.50% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the PR's primary objective: merging changes from the release-1.3.x branch into develop, addressing the referenced issue.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch release-1.3.x

⚔️ Resolve merge conflicts

Resolve merge conflict in branch release-1.3.x

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Prafulrakhade and others added 25 commits December 4, 2024 19:31

[MOSIP-35490] moved required helm and deploy scripts to modular repo

33f0e3a

Signed-off-by: techno-467 <prafulrakhade02@gmail.com>

Merge pull request #163 from Prafulrakhade/release-1.3.x

8ccb888

[MOSIP-35490] moved required helm and deploy scripts to modular repo

[DSD-7140] added view-users

7ee6b03

Signed-off-by: Rakshith B <79500257+Rakshithb1@users.noreply.github.com>

Merge pull request #166 from Rakshithb1/release-1.3.x

9f08cfc

[DSD-7140] added view-users

[DSD-7140] added verify-keycloak-init.yml

20ba8df

Signed-off-by: Rakshith B <79500257+Rakshithb1@users.noreply.github.com>

Merge pull request #168 from Rakshithb1/release-1.3.x

7105ed4

[DSD-7140] added verify-keycloak-init.yml

[DSD-7595]Updated chart-lint-publish.yml (#173)

4c5cdd5

Signed-off-by: Rakshitha650 <76676196+Rakshitha650@users.noreply.github.com>

[DSD-7595]Updated values.yaml (#170)

cc58707

Signed-off-by: Rakshitha650 <76676196+Rakshitha650@users.noreply.github.com>

[MOSIP-41025] added role ONLINE_REGISTRATION_CLIENT addition

8f8a57f

Signed-off-by: Chandra Keshav Mishra <chandrakeshavmishra@gmail.com>

Merge pull request #177 from ckm007/MOSIP-41025-release-1.3.x

a8e5503

[MOSIP-41025] added role ONLINE_REGISTRATION_CLIENT addition

[MOSIP-43640] changes for GA release

4645d21

Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com>

[DSD-9092] rapid deployment 0.1.0-beta release

ce0a0d1

Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com>

[DSD-9092] rapid deployment 0.1.0-beta release

ca12968

Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com>

Merge pull request #192 from Prafulrakhade/release-1.3.x-MOSIP-43640

81f49a3

[MOSIP-43640] changes for GA release

[DSD-9381]Updated helm charts, pustrigger,and dockerfile from develop…

8e73ae3

… branch Signed-off-by: bhumi46 <thisisbn46@gmail.com>

[DSD-9381]Updated helm charts, pustrigger,and dockerfile from develop…

6f59542

… branch Signed-off-by: bhumi46 <thisisbn46@gmail.com>

[DSD-9381]Updated helm charts, pustrigger,and dockerfile from develop…

f77fcf9

… branch Signed-off-by: bhumi46 <thisisbn46@gmail.com>

Merge pull request #193 from bhumi46/release-1.3.x

8db8684

[DSD-9381]Updated helm charts, pustrigger,and dockerfile from develop…

[MOSIP-44060] Updated keycloak install and initialization scripts.

902d26f

Signed-off-by: Mohanraj209 <mohan1715@gmail.com>

[MOSIP-44050] Updated install.sh

5f30cca

Signed-off-by: Mohan E <mohanraj1715@gmail.com>

Merge pull request #195 from Mohanraj209/release-1.3.x

5a4bd13

[MOSIP-44060] Updated keycloak install and initialization scripts.

[MOSIP-44106] updated README.md file

e0f023b

Signed-off-by: Prafulrakhade <prafulrakhade02@gmail.com>

Merge pull request #196 from Prafulrakhade/release-1.3.x-Readme.md

25eb9f4

[MOSIP-44106] updated README.md file

github-advanced-security AI found potential problems Jun 4, 2026

View reviewed changes

ckm007 closed this Jun 4, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

closes mosip/commons#1860 Merge changes from release-1.3.x to develop #213#206

closes mosip/commons#1860 Merge changes from release-1.3.x to develop #213#206
ckm007 wants to merge 25 commits into
developfrom
release-1.3.x

ckm007 commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

Review failed

❌ Failed checks (1 warning)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Conversation

ckm007 commented Jun 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

❌ Failed checks (1 warning)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ckm007 commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading