Fix: Add deployment.toml configuration for internal keystore for all affected versions (Product IS issue #27537)#6057
Open
wso2-engineering-bot wants to merge 1 commit intomasterfrom
Conversation
…affected versions (product-is#27537) Added missing documentation for configuring the internal keystore in deployment.toml after creation. Includes configuration examples for both PKCS12 and JKS keystore types with explanations. This fix applies to IS versions 7.0.0, 7.1.0, 7.2.0, and next (latest). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughAdded documentation content to the internal keystore creation guide, instructing users to update deployment.toml with keystore configurations for both PKCS12 and JKS types, including file names, aliases, passwords using Changes
Suggested labels
🚥 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 Warning |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
en/includes/deploy/security/keystores/create-new-keystores.md (1)
203-204: Consider more direct phrasing.The note uses "You should encrypt," which is slightly passive. Per coding guidelines, prefer direct verbs and active voice.
✏️ Suggested more direct phrasing
!!! note - The password values use the `$secret{}` syntax, which references encrypted passwords. You should encrypt the actual keystore password using the [Cipher Tool]({{base_path}}/deploy/security/encrypt-passwords-with-cipher-tool) and use the encrypted value. + The password values use the `$secret{}` syntax, which references encrypted passwords. Encrypt the actual keystore password using the [Cipher Tool]({{base_path}}/deploy/security/encrypt-passwords-with-cipher-tool) and use the encrypted value.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/deploy/security/keystores/create-new-keystores.md` around lines 203 - 204, In the note about the $secret{} syntax in create-new-keystores.md, replace the passive sentence "You should encrypt the actual keystore password using the [Cipher Tool]... and use the encrypted value." with an active instruction such as "Encrypt the keystore password using the Cipher Tool and provide the encrypted value in the $secret{} syntax." Ensure the [Cipher Tool] link remains and that the note clearly instructs to use the encrypted value.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/includes/deploy/security/keystores/create-new-keystores.md`:
- Around line 198-201: Rewrite the placeholder instructions so they clearly
state that `<internal-keystore-name>` is the keystore's base name (no file
extension) while the `file_name` parameter must include the actual filename with
the .jks extension, and clarify that `<internal-key-alias>` is the alias used
when creating the keystore; mirror the clearer phrasing used in the PKCS12
section to avoid contradictory wording.
- Around line 182-186: The placeholder guidance is confusing; update the text
that explains replacing `<internal-keystore-name>` and `<internal-key-alias>` to
remove the contradictory parenthetical and clearly state that users should
replace only the placeholder portion — e.g., keep the example `file_name =
"<internal-keystore-name>.p12"` as-is and instruct "replace
`<internal-keystore-name>` with your keystore name (do not include or remove the
`.p12` suffix in the example as it is already present), and replace
`<internal-key-alias>` with the alias you specified" so readers understand to
substitute just the placeholder parts; adjust the lines referencing
`<internal-keystore-name>` and `file_name = "<internal-keystore-name>.p12"`
accordingly.
---
Nitpick comments:
In `@en/includes/deploy/security/keystores/create-new-keystores.md`:
- Around line 203-204: In the note about the $secret{} syntax in
create-new-keystores.md, replace the passive sentence "You should encrypt the
actual keystore password using the [Cipher Tool]... and use the encrypted
value." with an active instruction such as "Encrypt the keystore password using
the Cipher Tool and provide the encrypted value in the $secret{} syntax." Ensure
the [Cipher Tool] link remains and that the note clearly instructs to use the
encrypted value.
🪄 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: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: aef1eb6d-9e19-4d49-a0c3-39fd89917050
📒 Files selected for processing (1)
en/includes/deploy/security/keystores/create-new-keystores.md
Comment on lines
+182
to
+186
| Replace the placeholders with the values you used when creating the keystore: | ||
|
|
||
| - `<internal-keystore-name>`: The name of your internal keystore file (without the `.p12` extension in the file name, but include it in the `file_name` parameter) | ||
| - `<internal-key-alias>`: The alias you specified when creating the keystore | ||
|
|
Contributor
There was a problem hiding this comment.
Clarify the placeholder replacement instructions.
The current explanation "(without the .p12 extension in the file name, but include it in the file_name parameter)" is confusing and appears contradictory. Since the template already shows file_name = "<internal-keystore-name>.p12", users should understand they only need to replace the placeholder part.
📝 Suggested clearer wording
Replace the placeholders with the values you used when creating the keystore:
- - `<internal-keystore-name>`: The name of your internal keystore file (without the `.p12` extension in the file name, but include it in the `file_name` parameter)
+ - `<internal-keystore-name>`: The name of your keystore (for example, if your keystore file is `internal.p12`, replace `<internal-keystore-name>` with `internal`)
- `<internal-key-alias>`: The alias you specified when creating the keystore📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Replace the placeholders with the values you used when creating the keystore: | |
| - `<internal-keystore-name>`: The name of your internal keystore file (without the `.p12` extension in the file name, but include it in the `file_name` parameter) | |
| - `<internal-key-alias>`: The alias you specified when creating the keystore | |
| Replace the placeholders with the values you used when creating the keystore: | |
| - `<internal-keystore-name>`: The name of your keystore (for example, if your keystore file is `internal.p12`, replace `<internal-keystore-name>` with `internal`) | |
| - `<internal-key-alias>`: The alias you specified when creating the keystore | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/deploy/security/keystores/create-new-keystores.md` around lines
182 - 186, The placeholder guidance is confusing; update the text that explains
replacing `<internal-keystore-name>` and `<internal-key-alias>` to remove the
contradictory parenthetical and clearly state that users should replace only the
placeholder portion — e.g., keep the example `file_name =
"<internal-keystore-name>.p12"` as-is and instruct "replace
`<internal-keystore-name>` with your keystore name (do not include or remove the
`.p12` suffix in the example as it is already present), and replace
`<internal-key-alias>` with the alias you specified" so readers understand to
substitute just the placeholder parts; adjust the lines referencing
`<internal-keystore-name>` and `file_name = "<internal-keystore-name>.p12"`
accordingly.
Comment on lines
+198
to
+201
| Replace the placeholders with the values you used when creating the keystore: | ||
|
|
||
| - `<internal-keystore-name>`: The name of your internal keystore file (without the `.jks` extension in the file name, but include it in the `file_name` parameter) | ||
| - `<internal-key-alias>`: The alias you specified when creating the keystore |
Contributor
There was a problem hiding this comment.
Clarify the placeholder replacement instructions.
Same clarity issue as the PKCS12 section above. The explanation about the extension is confusing.
📝 Suggested clearer wording
Replace the placeholders with the values you used when creating the keystore:
- - `<internal-keystore-name>`: The name of your internal keystore file (without the `.jks` extension in the file name, but include it in the `file_name` parameter)
+ - `<internal-keystore-name>`: The name of your keystore (for example, if your keystore file is `internal.jks`, replace `<internal-keystore-name>` with `internal`)
- `<internal-key-alias>`: The alias you specified when creating the keystore🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/deploy/security/keystores/create-new-keystores.md` around lines
198 - 201, Rewrite the placeholder instructions so they clearly state that
`<internal-keystore-name>` is the keystore's base name (no file extension) while
the `file_name` parameter must include the actual filename with the .jks
extension, and clarify that `<internal-key-alias>` is the alias used when
creating the keystore; mirror the clearer phrasing used in the PKCS12 section to
avoid contradictory wording.
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.
This PR was automatically generated by Claude AI.
The fix is applied to the shared include file (
en/includes/deploy/security/keystores/create-new-keystores.md), which automatically applies the changes to all affected versions that use this include.