[4.5.0] Add documentation on ICP secondary user stores

[tharindu-nw]

Purpose

$subject

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

• Unit tests

  Code coverage information

• Integration tests

  Details about the test cases and coverage

Security checks

• Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
• Ran FindSecurityBugs plugin and verified report? yes/no
• Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

[coderabbitai]

📝 Walkthrough

Summary

This pull request adds documentation for configuring secondary user stores in WSO2 Integration Control Plane (ICP).

Changes

New documentation file: en/docs/install-and-setup/setup/user-stores/configuring-secondary-user-stores-in-icp.md

• Introduces login options for secondary user stores (using username or DOMAIN/username format)
• Clarifies permission model: secondary store users have non-admin read-only access
• Explains how to configure secondary user stores by adding [[secondary_user_store]] blocks to the deployment configuration file
• Includes guidance on selecting and configuring the domain_name parameter
• Provides concrete configuration examples for multiple store types: Read-Only LDAP, Read-Write LDAP, MySQL, and MSSQL
• Documents support for multiple secondary store configurations

Navigation update: en/mkdocs.yml

• Adds new navigation entry linking "Secondary User Store" documentation under Install and Setup → Setup → User Stores in ICP section

Lines changed: +86/-0

Walkthrough

This pull request adds comprehensive documentation for configuring secondary user stores in WSO2 Integration Control Plane (ICP). The new documentation file covers login authentication using either username or DOMAIN/username format, clarifies that secondary store users have read-only (non-admin) permissions, provides step-by-step instructions for editing deployment.toml, and includes concrete configuration examples for LDAP (both read-only and read-write modes), MySQL, and MSSQL database backends. A corresponding navigation entry is added to the mkdocs.yml configuration to integrate the new documentation into the site structure under the User Stores in ICP section.

Suggested reviewers

• chanikag
• anupama-pathirage

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is largely incomplete with only the Purpose section containing placeholder text ($subject) and all other required sections left unfilled or containing only template prompts.	Complete the description by filling in Goals, Approach, User Stories, Release Note, Documentation, and other relevant sections with specific details about the secondary user store documentation changes.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding documentation for ICP secondary user stores, and includes the version tag [4.5.0].
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[tharindu-nw]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

en/docs/install-and-setup/setup/user-stores/configuring-secondary-user-stores-in-icp.md (1)

18-83: ⚡ Quick win

Add an explicit “example credentials only” note before config samples.

These snippets include concrete usernames/passwords. Add a short note to replace all sample credentials with environment-specific secure values before use.

🤖 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
`@en/docs/install-and-setup/setup/user-stores/configuring-secondary-user-stores-in-icp.md`
around lines 18 - 83, Add a short explicit note above the config examples
warning that the shown usernames/passwords are sample credentials and must be
replaced with environment-specific secure values before use; place this note
before the first TOML block (above the first [[secondary_user_store]] example)
and ensure it references that it applies to all examples including the
ReadOnlyLDAPUserStoreManager, ReadWriteLDAPUserStoreManager, and
JDBCUserStoreManager/driver-specific samples so readers know to update
connection_name/connection_password, username/password, url, and other secrets.

🤖 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
`@en/docs/install-and-setup/setup/user-stores/configuring-secondary-user-stores-in-icp.md`:
- Line 15: Update the sentence that currently states users "must log in as
`domain_name/username`" to clarify that `DOMAIN/username` is the recommended
format but plain `username` is also supported as a fallback; modify the text
referencing the `domain_name` label so it says something like "Users from that
store should preferably log in as `DOMAIN/username` (e.g., `LDAP_STORE/john`),
though plain `username` is supported as a fallthrough" to align with actual
behavior.

---

Nitpick comments:
In
`@en/docs/install-and-setup/setup/user-stores/configuring-secondary-user-stores-in-icp.md`:
- Around line 18-83: Add a short explicit note above the config examples warning
that the shown usernames/passwords are sample credentials and must be replaced
with environment-specific secure values before use; place this note before the
first TOML block (above the first [[secondary_user_store]] example) and ensure
it references that it applies to all examples including the
ReadOnlyLDAPUserStoreManager, ReadWriteLDAPUserStoreManager, and
JDBCUserStoreManager/driver-specific samples so readers know to update
connection_name/connection_password, username/password, url, and other secrets.

🪄 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: c28ff530-919c-46f7-a386-b852fabc9b7f

📥 Commits

Reviewing files that changed from the base of the PR and between caa6f76 and 2757c45.

📒 Files selected for processing (2)

• en/docs/install-and-setup/setup/user-stores/configuring-secondary-user-stores-in-icp.md
• en/mkdocs.yml