[MOSIP-43143]Add eSignet integration to deployment documentation#1108
[MOSIP-43143]Add eSignet integration to deployment documentation#1108bhumi46 wants to merge 1 commit intomosip:1.2.0from
Conversation
This release introduces eSignet as a fully integrated deployment component within the RDI framework, enabling secure digital identity verification. The documentation has been updated to reflect eSignet integration and provide additional resources for deployment. Signed-off-by: bhumi46 <111699703+bhumi46@users.noreply.github.com>
WalkthroughThis pull request updates the MOSIP RDI v3 installation documentation to introduce eSignet as a new fourth deployment phase, integrating it into the deployment architecture with dedicated configuration resources and updated workflow diagrams. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip CodeRabbit can enforce grammar and style rules using `languagetool`.Configure the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/setup/deploymentnew/v3-installation/1.2.0.3.md (1)
37-37: Use internal docs links for eSignet references instead of only external repo READMEs.At Line 37 and Line 79, the links point to
github.com/mosip/infra/.../esignet_README.md. Since eSignet pages already exist in this docs tree and are registered in navigation, prefer linking those internal pages (optionally keep external as secondary). This keeps links stable for published docs and improves in-site discoverability.As per coding guidelines, "
**/*.md: Whenever asking for related topics in a Markdown file, always check the directory structure first to ensure the links are valid".Also applies to: 79-79
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/setup/deploymentnew/v3-installation/1.2.0.3.md` at line 37, Replace the external GitHub README link used in the "eSignet Deployment Guide" list item (the [eSignet README](https://github.com/mosip/infra/blob/master/docs/esignet_README.md) reference) with the internal docs page for eSignet that exists in this docs tree (use the internal markdown page path/slug registered in navigation); do this for both occurrences mentioned (the items at Line 37 and Line 79), optionally keeping the external GitHub URL as a parenthetical secondary link after the internal link for reference.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/setup/deploymentnew/v3-installation/1.2.0.3.md`:
- Line 43: The sentence currently says "3-step deployment model" and "dedicated
fourth deployment phase" which contradicts itself; update the phrasing around
the existing text "3-step deployment model" and "fourth deployment phase" to
clarify that the model was originally three steps and is now extended to four
phases (for example: "MOSIP RDI originally follows a 3-step deployment model,
and starting with this release the eSignet authentication stack is added as a
dedicated fourth deployment phase that runs after MOSIP core services are up").
Ensure both phrases are replaced so the sentence reads unambigously.
- Line 21: The eSignet component list in the "eSignet Integration" sentence (the
prose listing Redis, SoftHSM, Keycloak, Mock Identity System, OIDC UI, and
Partner Onboarder) and the diagram label further down are inconsistent; update
the diagram label to include the missing components or shorten the prose list to
match the diagram, or add a parenthetical like "(abbreviated)" to the diagram
label to explicitly indicate it is a subset—edit the sentence that begins
"eSignet Integration" and the diagram label text so both show the same set (or
mark the diagram as abbreviated) to ensure consistency.
---
Nitpick comments:
In `@docs/setup/deploymentnew/v3-installation/1.2.0.3.md`:
- Line 37: Replace the external GitHub README link used in the "eSignet
Deployment Guide" list item (the [eSignet
README](https://github.com/mosip/infra/blob/master/docs/esignet_README.md)
reference) with the internal docs page for eSignet that exists in this docs tree
(use the internal markdown page path/slug registered in navigation); do this for
both occurrences mentioned (the items at Line 37 and Line 79), optionally
keeping the external GitHub URL as a parenthetical secondary link after the
internal link for reference.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a2fc8082-7e8e-4901-b495-21a36f03bb54
📒 Files selected for processing (1)
docs/setup/deploymentnew/v3-installation/1.2.0.3.md
| 4. **Unified Repository and Collaboration**: All infrastructure, configuration, and deployment scripts are maintained in a single repository, promoting collaboration and reducing silos between Dev, Ops, and Security teams. | ||
| 5. **Security and Compliance**: Automated vulnerability scanning, compliance checks, and secure networking (e.g., **WireGuard VPN**, security groups) are built into the deployment process. | ||
| 6. **Scalability and Flexibility**: The cloud-native, modular architecture—built on **Kubernetes** and managed via **Helm/Helmsman**—enables seamless scaling and adaptation to changing requirements. | ||
| 7. **eSignet Integration**: The eSignet authentication stack (Redis, SoftHSM, Keycloak, Mock Identity System, OIDC UI, and Partner Onboarder) is now deployable via a dedicated `esignet-dsf.yaml` Helmsman Desired State File and a dedicated `helmsman_esignet.yml` GitHub Actions workflow, integrated with MOSIP core services deployment. |
There was a problem hiding this comment.
Align eSignet component list between prose and diagram.
At Line 21, the stack includes Redis, SoftHSM, Keycloak, Mock Identity System, OIDC UI, and Partner Onboarder; at Line 59, the diagram label lists a subset. Please make both lists consistent (or explicitly mark the diagram list as abbreviated).
Also applies to: 59-59
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/setup/deploymentnew/v3-installation/1.2.0.3.md` at line 21, The eSignet
component list in the "eSignet Integration" sentence (the prose listing Redis,
SoftHSM, Keycloak, Mock Identity System, OIDC UI, and Partner Onboarder) and the
diagram label further down are inconsistent; update the diagram label to include
the missing components or shorten the prose list to match the diagram, or add a
parenthetical like "(abbreviated)" to the diagram label to explicitly indicate
it is a subset—edit the sentence that begins "eSignet Integration" and the
diagram label text so both show the same set (or mark the diagram as
abbreviated) to ensure consistency.
| ### How it works (High-level Overview) | ||
|
|
||
| MOSIP RDI follows a **3-step deployment model** that separates infrastructure concerns from application deployment: | ||
| MOSIP RDI follows a **3-step deployment model** that separates infrastructure concerns from application deployment. Starting with this release, the eSignet authentication stack is a dedicated fourth deployment phase that runs after MOSIP core services are up. |
There was a problem hiding this comment.
Clarify the phase count wording to avoid contradiction.
At Line 43, “3-step deployment model” and “dedicated fourth deployment phase” in the same sentence is confusing. Suggest rewording to “originally 3-step, now extended to 4 phases” (or equivalent).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/setup/deploymentnew/v3-installation/1.2.0.3.md` at line 43, The sentence
currently says "3-step deployment model" and "dedicated fourth deployment phase"
which contradicts itself; update the phrasing around the existing text "3-step
deployment model" and "fourth deployment phase" to clarify that the model was
originally three steps and is now extended to four phases (for example: "MOSIP
RDI originally follows a 3-step deployment model, and starting with this release
the eSignet authentication stack is added as a dedicated fourth deployment phase
that runs after MOSIP core services are up"). Ensure both phrases are replaced
so the sentence reads unambigously.
1 participant
This release introduces eSignet as a fully integrated deployment component within the RDI framework, enabling secure digital identity verification. The documentation has been updated to reflect eSignet integration and provide additional resources for deployment.
Summary by CodeRabbit
Documentation