closes #1161 setup documentation for 1.2.1.0#1162
Open
ckm007 wants to merge 2 commits into
Open
Conversation
Signed-off-by: ckm007 <chandrakeshavmishra@gmail.com>
WalkthroughAdds a complete MOSIP v3 (1.2.1.0) deployment documentation set: prerequisites, architecture overview, and three deployment guides (AWS, on‑prem with DNS, on‑prem without DNS) including observability, external dependencies, module deployment, and verification steps. ChangesMOSIP v3 Deployment Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 16
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/aws-deployment.md`:
- Line 430: The shell command shown uses a literal K8_ROOT instead of the
environment variable; update the command string 'cd K8_ROOT/logging/dashboard'
to use the env var by adding the dollar sign (i.e., 'cd
$K8_ROOT/logging/dashboard') and ensure any preceding instructions actually
export or define K8_ROOT so the substitution works at runtime.
- Around line 242-246: The docs reference two different filenames for the same
cluster config (copy cluster.config.sample to mosip.cluster.config, then
instruct editing rancher.cluster.config), so correct the inconsistency by
replacing the incorrect "rancher.cluster.config" reference with
"mosip.cluster.config" so all steps consistently instruct users to edit
mosip.cluster.config and then list the parameters (name, region, version).
- Line 112: Replace every incorrect occurrence of the command string "kubect get
nodes" with the correct "kubectl get nodes" in the documentation; search for the
exact typo "kubect get nodes" (e.g., the instances shown in the diff) and update
them to "kubectl get nodes" so the command copies/pastes correctly.
- Around line 102-104: The fenced code block containing the command "eksctl
create cluster -f rancher.cluster.config" lacks a language identifier; update
the block delimiter from ``` to ```sh (or another suitable shell marker) so it
reads ```sh followed by the command and closing ``` to satisfy linting and
improve readability.
- Line 15: Replace the generic link text "[here]" used in sentences like
"Install docker in the Wireguard machine as given [here](...)" with descriptive
link text (e.g., "Docker Engine install guide") so readers and screen readers
can understand the link target; update every occurrence of "[here](...)" in this
document (including the instances called out in the comment) to meaningful
labels such as "Docker Engine install guide", "AWS CLI configuration reference",
or similar context-specific phrases that match each URL.
In
`@docs/setup/deploymentnew/v3-installation/1.2.1.0/on-premises-deployment-without-dns.md`:
- Around line 1266-1268: Remove the embedded Slack webhook URL
"https://hooks.slack.com/services/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"
from the docs and replace it with a generic placeholder such as
"https://hooks.slack.com/services/TEAM/ID/KEY" or "<SLACK_WEBHOOK_URL>"; commit
the change and ensure the real webhook is rotated/revoked outside of this repo
to prevent unauthorized access.
- Line 473: Remove the stray editor artifact text "Add commentMore actions" from
the sentence that reads "Post installation access the keycloak using
`iam.mosip.net` and get the credentials as per the post installation steps
definedAdd commentMore actions " so the sentence reads
cleanly (e.g., end the sentence after "defined" or before the image), and remove
the same "Add commentMore actions" artifact wherever it appears later (notably
the occurrence referenced at line 920) to restore proper readability.
- Around line 572-700: The docs mix RKE1 and RKE2 steps causing contradictory
instructions; decide on a single RKE2 flow or clearly separate a deprecated RKE1
section. If choosing RKE2, replace all occurrences of the RKE1 CLI/artefacts
(references to "rke", "rke up", "cluster.rkestate", "kube_config_cluster.yml"
and instructions about generating "cluster.yml" with RKE1 prompts) with the RKE2
equivalents (RKE2 installation, rke2 server/agent config, kubeconfig paths and
service management) and remove/mark any RKE1-only steps as deprecated;
alternatively, create a new clearly labeled "RKE1 (deprecated)" subsection
containing the existing "rke", "rke up", and "cluster.rkestate" content and add
a top-level note directing users to the preferred RKE2 section.
- Line 689: Fix the two broken command snippets: close the missing quote on the
export command by completing export
KUBECONFIG="$HOME/.kube/<cluster_name>_config" and correct the SSH example by
using a single -i with the key file and a proper user@host (e.g., ssh -i
/path/to/key.pem ubuntu@<host_or_ip>) instead of the incomplete "ssh -i ... -i
ubuntu@" fragment; apply the same corrections to the other occurrence of these
snippets.
- Line 436: The referenced internal links are inconsistent: update the
anchor/link that points to
on-prem-without-dns.md#setting-up-nginx-server-for-observation-k8s-cluster to
match the actual target document and anchor name used in this docs directory,
and fix the dashboard link text that says "02-error-only-logs.ndjson" but
currently points to "03-service-logs.ndjson" so the link URL and link text match
the correct ndjson filename; also scan other similar references in this file
(including the ones flagged around the dashboard examples and related anchors)
and correct filenames/anchors/URLs to the actual files in the directory
structure so all Markdown links resolve.
In
`@docs/setup/deploymentnew/v3-installation/1.2.1.0/overview-and-architecture.md`:
- Around line 25-27: The guide mixes repository version tags—update all infra
repo links in this document to use a single validated release tag (e.g., replace
occurrences of "v1.2.0.1-B1" and "v1.2.0.2" with the chosen release tag
"v1.2.1.0" or the officially validated tag for this guide); specifically update
the two links labeled "MOSIP External Components" and "MOSIP Services" and any
other occurrences noted around lines 36-40 so every reference in the guide
points to the same validated version set.
In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md`:
- Around line 41-44: The fenced code blocks containing shell commands such as
the lines with "helm repo add bitnami https://charts.bitnami.com/bitnami" and
"helm repo add mosip https://mosip.github.io/mosip-helm" need explicit language
tags (use "bash") and the surrounding Markdown lists must have consistent
indentation; update each affected code fence to start with ```bash and normalize
list items to use the same indentation level (e.g., two spaces or a single tab
consistently) and apply the same fixes to the other occurrences referenced (the
blocks containing the commands at the noted ranges).
- Line 23: The table contains domain typos using "xyx.net" instead of "xyz.net";
update every domain example that uses the incorrect "xyx.net" (e.g.,
sandbox.xyx.net, api.sandbox.xyx.net, activemq.sandbox.xyx.net,
kibana.sandbox.xyx.net, object-store.sandbox.xyx.net and any other occurrences
of "xyx.net") to "xyz.net" so all hostnames consistently use "*.xyz.net" and
DNS/certificate mappings will match.
- Around line 49-71: Update the "Openssl Need openssl version 1.1.1 specifically
for regclient installation" section to stop hard-pinning OpenSSL 1.1.1f: replace
the forced remove-and-install instructions with guidance that states the minimum
and compatible OpenSSL versions for regclient (e.g., "OpenSSL >= 1.1.1" and
"OpenSSL 3.x is supported on Ubuntu 24.04") and provide alternative paths — (a)
use the system OpenSSL if it meets the minimum, with a verification command
`openssl version`, (b) for older OSes provide the manual install steps as an
optional legacy path, and (c) include a note linking to regclient compatibility
documentation; remove the blanket `sudo apt remove openssl` recommendation and
the forced backup/mv commands so modern distributions are not instructed to
downgrade system OpenSSL.
- Line 38: The prereq line "*
[kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)- version 2.12.4 or
higher" uses an invalid kubectl version; update that entry to a valid supported
client version (for example change the text to "kubectl - version 1.23.6 or
higher" or "kubectl - version > 1.23.6") so it matches the repo's other docs
(see the existing aws-deployment.md baseline); edit the same list item text to
replace "2.12.4" with the chosen valid version range.
In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/README.md`:
- Line 1: The top-level markdown heading in README.md currently reads "1.2.0.2"
but this file lives in the 1.2.1.0 release folder; update the Markdown header on
the first line (the "# 1.2.0.2" heading) to "# 1.2.1.0" so the document title
matches the release directory and PR for 1.2.1.0 (locate and edit the first-line
heading in README.md).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 54479f1b-11fe-44c0-ab08-b692de079c72
📒 Files selected for processing (6)
docs/setup/deploymentnew/v3-installation/1.2.1.0/README.mddocs/setup/deploymentnew/v3-installation/1.2.1.0/aws-deployment.mddocs/setup/deploymentnew/v3-installation/1.2.1.0/on-premises-deployment-without-dns.mddocs/setup/deploymentnew/v3-installation/1.2.1.0/on-premises-deployment.mddocs/setup/deploymentnew/v3-installation/1.2.1.0/overview-and-architecture.mddocs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md
Signed-off-by: ckm007 <chandrakeshavmishra@gmail.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md (1)
6-6:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix typo: "referting" should be "referring".
Line 6 contains a typographical error that should be corrected for documentation clarity.
📝 Suggested fix
-* Here, we are referting to __Ubuntu OS (22.0.4)__ throughout this installation guide. +* Here, we are referring to __Ubuntu OS (22.0.4)__ throughout this installation guide.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md` at line 6, Fix the typographical error in the markdown line that reads "* Here, we are referting to __Ubuntu OS (22.0.4)__ throughout this installation guide." by changing "referting" to "referring" so the sentence becomes "* Here, we are referring to __Ubuntu OS (22.0.4)__ throughout this installation guide." — update the text in the file docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md where the phrase "__Ubuntu OS (22.0.4)__" appears.
♻️ Duplicate comments (3)
docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md (3)
78-82:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd language tag to fenced code block.
The code block setting environment variables should specify
bashas its language for proper syntax highlighting and markdown compliance.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md` around lines 78 - 82, The fenced code block that exports MOSIP_ROOT, K8_ROOT, and INFRA_ROOT lacks a language tag; update the triple-backtick fence to specify "bash" (i.e., change ``` to ```bash) around the block containing the export MOSIP_ROOT, export K8_ROOT=$MOSIP_ROOT/k8s-infra, and export INFRA_ROOT=$MOSIP_ROOT/mosip-infra to enable proper syntax highlighting and markdown compliance.
23-23:⚠️ Potential issue | 🟠 Major | ⚡ Quick winDNS examples contain likely domain typos (
xyx.netvsxyz.net).Several hostnames in the DNS table use
*.xyx.netwhile adjacent entries use*.xyz.net. These appear to be copy errors that will cause DNS/certificate mapping failures if followed literally.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md` at line 23, The DNS table contains inconsistent typos using "xyx.net" in several entries (e.g., sandbox.xyx.net, api.sandbox.xyx.net, activemq.sandbox.xyx.net, kibana.sandbox.xyx.net, object-store.sandbox.xyx.net) while others use "xyz.net"; update those mislabeled hostnames to the correct "xyz.net" variant to match the rest of the domain names (for example change sandbox.xyx.net → sandbox.xyz.net, api.sandbox.xyx.net → api.sandbox.xyz.net, activemq.sandbox.xyx.net → activemq.sandbox.xyz.net, kibana.sandbox.xyx.net → kibana.sandbox.xyz.net, object-store.sandbox.xyx.net → object-store.sandbox.xyz.net) so DNS and certificate mappings remain consistent.
51-69:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix fenced-code language tags and reconsider OpenSSL 1.1.1f hard requirement.
The code blocks at lines 51, 55, 63, and 67 are missing
bashlanguage specifiers, and the OpenSSL installation instructions hard-require version 1.1.1f despite Ubuntu 24.04 (listed as supported on line 89) shipping with OpenSSL 3.x by default.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md` around lines 51 - 69, The fenced code blocks in the OpenSSL section are missing the bash language tag and the docs also hard-code OpenSSL 1.1.1f as a requirement; update the three fenced blocks shown in the diff (the `openssl version` check and the two other command blocks) to use ```bash so syntax highlighting is correct, and change the installation guidance that forces OpenSSL 1.1.1f to instead recommend verifying compatibility (e.g., accept OpenSSL 1.1.1 or 3.x where supported) and only instruct manual replacement when the detected `openssl version` is incompatible with the product; reference the OpenSSL version check block and the manual install guidance that mentions openssl-1.1.1f for where to apply these edits.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md`:
- Line 6: Fix the typographical error in the markdown line that reads "* Here,
we are referting to __Ubuntu OS (22.0.4)__ throughout this installation guide."
by changing "referting" to "referring" so the sentence becomes "* Here, we are
referring to __Ubuntu OS (22.0.4)__ throughout this installation guide." —
update the text in the file
docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md where the
phrase "__Ubuntu OS (22.0.4)__" appears.
---
Duplicate comments:
In `@docs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md`:
- Around line 78-82: The fenced code block that exports MOSIP_ROOT, K8_ROOT, and
INFRA_ROOT lacks a language tag; update the triple-backtick fence to specify
"bash" (i.e., change ``` to ```bash) around the block containing the export
MOSIP_ROOT, export K8_ROOT=$MOSIP_ROOT/k8s-infra, and export
INFRA_ROOT=$MOSIP_ROOT/mosip-infra to enable proper syntax highlighting and
markdown compliance.
- Line 23: The DNS table contains inconsistent typos using "xyx.net" in several
entries (e.g., sandbox.xyx.net, api.sandbox.xyx.net, activemq.sandbox.xyx.net,
kibana.sandbox.xyx.net, object-store.sandbox.xyx.net) while others use
"xyz.net"; update those mislabeled hostnames to the correct "xyz.net" variant to
match the rest of the domain names (for example change sandbox.xyx.net →
sandbox.xyz.net, api.sandbox.xyx.net → api.sandbox.xyz.net,
activemq.sandbox.xyx.net → activemq.sandbox.xyz.net, kibana.sandbox.xyx.net →
kibana.sandbox.xyz.net, object-store.sandbox.xyx.net →
object-store.sandbox.xyz.net) so DNS and certificate mappings remain consistent.
- Around line 51-69: The fenced code blocks in the OpenSSL section are missing
the bash language tag and the docs also hard-code OpenSSL 1.1.1f as a
requirement; update the three fenced blocks shown in the diff (the `openssl
version` check and the two other command blocks) to use ```bash so syntax
highlighting is correct, and change the installation guidance that forces
OpenSSL 1.1.1f to instead recommend verifying compatibility (e.g., accept
OpenSSL 1.1.1 or 3.x where supported) and only instruct manual replacement when
the detected `openssl version` is incompatible with the product; reference the
OpenSSL version check block and the manual install guidance that mentions
openssl-1.1.1f for where to apply these edits.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 06fcbcfb-e97e-404a-9630-1781e914bc8d
📒 Files selected for processing (2)
docs/setup/deploymentnew/v3-installation/1.2.1.0/aws-deployment.mddocs/setup/deploymentnew/v3-installation/1.2.1.0/pre-requisites.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/setup/deploymentnew/v3-installation/1.2.1.0/aws-deployment.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit