Skip to content

chore(docker-compose): Add profiles in docker-compose.yml and documen… #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

anasalatasiuni
Copy link
Contributor

@anasalatasiuni anasalatasiuni commented May 26, 2025

User description

Close #1323

Added two Docker profiles:

  • local-db to include memory-store service
  • self-hosted-temporal to include scheduler service

Using these profiles you can exclude these services instead of editing the docker compose file.

Also updated the Local Setup section in the documentation to use the new profiles.


PR Type

enhancement, documentation


Description

  • Added Docker Compose profiles for memory-store and scheduler services.

  • Updated documentation to explain new profile usage.

  • Enabled configurable inclusion of services via profiles.


Changes walkthrough 📝

Relevant files
Enhancement
docker-compose.yml
Add profiles for memory-store and scheduler services         

docker-compose.yml

  • Added profiles keys to memory-store and scheduler service includes.
  • Enabled toggling these services via local-db and self-hosted-temporal
    profiles.
  • +6/-3     
    Documentation
    localsetup.mdx
    Document usage of new Docker Compose profiles                       

    documentation/advanced/localsetup.mdx

  • Updated multi-tenant mode example to use new profiles.
  • Clarified how to include/exclude services using profiles.
  • +2/-1     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.

  • Important

    Add Docker Compose profiles for memory-store and scheduler services and update documentation for profile usage.

    • Enhancement:
      • Added Docker Compose profiles local-db and self-hosted-temporal in docker-compose.yml for memory-store and scheduler services.
      • Enabled service toggling via profiles.
    • Documentation:
      • Updated localsetup.mdx to document new profile usage in setup instructions.
      • Clarified service inclusion/exclusion using profiles in both single-tenant and multi-tenant modes.

    This description was created by Ellipsis for edef69d. You can customize this summary. It will automatically update as commits are pushed.

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis ✅

    1323 - Fully compliant

    Compliant requirements:

    • Make memory-store and scheduler services configurable
    • Replace the current approach of commenting out services in docker-compose.yml
    • Implement a solution that allows toggling these services on/off

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Missing Example

    The documentation update includes the multi-tenant mode command with all profiles enabled, but doesn't provide examples of how to exclude the memory-store or scheduler services. Adding examples would better demonstrate the new configurability.

    docker compose --env-file .env --profile temporal-ui --profile multi-tenant --profile self-hosted-db --profile blob-store --profile temporal-ui-public --profile self-hosted-temporal --profile local-db up --build --force-recreate --watch
    

    Copy link
    Contributor

    qodo-merge-pro-for-open-source bot commented May 26, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link
    Contributor

    @ellipsis-dev ellipsis-dev bot left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Important

    Looks good to me! 👍

    Reviewed everything up to d5ef28a in 1 minute and 8 seconds. Click for details.
    • Reviewed 39 lines of code in 2 files
    • Skipped 0 files when reviewing.
    • Skipped posting 4 draft comments. View those below.
    • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
    1. docker-compose.yml:7
    • Draft comment:
      Verify that the 'include' syntax with 'path' and 'profiles' is supported in your Docker Compose version.
    • Reason this comment was not posted:
      Confidence changes required: 33% <= threshold 50% None
    2. docker-compose.yml:12
    • Draft comment:
      Ensure the scheduler service is intended to run only under the 'self-hosted-temporal' profile.
    • Reason this comment was not posted:
      Confidence changes required: 33% <= threshold 50% None
    3. documentation/advanced/localsetup.mdx:65
    • Draft comment:
      Updated multi-tenant command now includes the new profiles; confirm its consistency with docker-compose.yml.
    • Reason this comment was not posted:
      Confidence changes required: 33% <= threshold 50% None
    4. documentation/advanced/localsetup.mdx:69
    • Draft comment:
      Typo: The sentence "that act as an API KEY" should probably use a verb agreement correction: "that acts as an API key".
    • Reason this comment was not posted:
      Comment was on unchanged code.

    Workflow ID: wflow_GEfheQNJ9JNnMHGS

    You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

    Copy link
    Contributor

    @ellipsis-dev ellipsis-dev bot left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Important

    Looks good to me! 👍

    Reviewed edef69d in 37 seconds. Click for details.
    • Reviewed 13 lines of code in 1 files
    • Skipped 0 files when reviewing.
    • Skipped posting 1 draft comments. View those below.
    • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
    1. documentation/advanced/localsetup.mdx:56
    • Draft comment:
      The updated command now includes '--profile self-hosted-temporal' and '--profile local-db' to enable the new services. Ensure this aligns with the docker-compose.yml profiles.
    • Reason this comment was not posted:
      Confidence changes required: 0% <= threshold 50% None

    Workflow ID: wflow_oO7N6a1odhocD9Kv

    You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    [Refactor]: Make memory-store and scheduler services configurable
    2 participants