CU-86c095u7n - Default setup to use Keycloak

[sushantpatil1214]

Summary by CodeRabbit

• New Features

  • Enabled Single Sign-On (SSO) functionality in the application.
  • Updated API port for improved service interaction.
  • Added conditional startup for a Keycloak test server based on SSO configuration.

• Bug Fixes

  • Simplified password management in Keycloak configuration for better clarity.

• Documentation

  • Updated password format in Keycloak server documentation for consistency.

[rcrichton]

Task linked: CU-86c095u7n Default setup to use Keycloak

[coderabbitai]

Walkthrough

The changes involve updates to environment variable exports in a shell script, modifications to a Keycloak JSON configuration, enhancements to a deployment script, and documentation adjustments. Environment variables related to API port and Single Sign-On (SSO) functionality were activated with new values. The Keycloak realm configuration was simplified by changing the password handling mechanism and adding a temporary field. Additionally, a deployment script was modified to conditionally start a Keycloak test server based on the SSO setting, while the documentation reflected the updated password format.

Changes

File Path	Change Summary
devops/linux/docker/conf/env/create-env-linux-low-1.sh	Activated environment variables REACT_APP_JEMPI_BASE_API_PORT and REACT_APP_ENABLE_SSO with new values; removed commented-out lines.
devops/linux/docker/conf/keycloak/import-jempi-dev-realm.json	Removed secretData and credentialData fields; added value field for password representation and a temporary field set to false.
devops/linux/docker/deployment/deploy-local.sh	Added command to source SDKMAN initialization script after installing sbt.
devops/linux/docker/deployment/scripts/d-stack-up-app-containers.sh	Introduced conditional block to source Keycloak test server script based on REACT_APP_ENABLE_SSO.
documentation/keycloak/README.md	Updated password description from "dev-password" to "dev_password_only".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeployScript
    participant Keycloak

    User->>DeployScript: Run deployment
    DeployScript->>DeployScript: Check REACT_APP_ENABLE_SSO
    alt SSO Enabled
        DeployScript->>Keycloak: Start Keycloak test server
    end

Loading

🐰 "In the land of code where bunnies play,
New paths are forged, come what may.
With SSO enabled, we hop with glee,
A simpler realm for all to see.
Let’s celebrate the changes bright,
In our code garden, all feels right!" 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 08d9a20 and 547ec53.

Files selected for processing (1)

• devops/linux/docker/conf/keycloak/import-jempi-dev-realm.json (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• devops/linux/docker/conf/keycloak/import-jempi-dev-realm.json

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7811e56 and 08d9a20.

Files selected for processing (5)

• devops/linux/docker/conf/env/create-env-linux-low-1.sh (1 hunks)
• devops/linux/docker/conf/keycloak/import-jempi-dev-realm.json (1 hunks)
• devops/linux/docker/deployment/deploy-local.sh (1 hunks)
• devops/linux/docker/deployment/scripts/d-stack-up-app-containers.sh (1 hunks)
• documentation/keycloak/README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• documentation/keycloak/README.md

Additional comments not posted (3)

devops/linux/docker/deployment/scripts/d-stack-up-app-containers.sh (1)

29-34: LGTM!

The changes to conditionally start the Keycloak test server based on the REACT_APP_ENABLE_SSO environment variable look good. The script is correctly sourced within a pushd and popd block to ensure the correct directory context.

devops/linux/docker/conf/env/create-env-linux-low-1.sh (1)

65-66: LGTM!

The changes to update the values of REACT_APP_JEMPI_BASE_API_PORT and REACT_APP_ENABLE_SSO environment variables look good. The previous commented-out lines defining these variables have been correctly removed.

Also applies to: 68-69

devops/linux/docker/deployment/deploy-local.sh (1)

77-77: LGTM!

The change to source the SDKMAN initialization script after installing sbt in the install_sdkman_and_java_sbt_maven function looks good. This ensures that the SDKMAN environment is properly set up for subsequent commands.