Skip to content

ITEP-87867 Information about docker compose profile#1098

Open
ltalarcz wants to merge 3 commits intomainfrom
fix/ITEP-87867-controller-not-stopped-by-docker-compose-down
Open

ITEP-87867 Information about docker compose profile#1098
ltalarcz wants to merge 3 commits intomainfrom
fix/ITEP-87867-controller-not-stopped-by-docker-compose-down

Conversation

@ltalarcz
Copy link
Contributor

@ltalarcz ltalarcz commented Feb 26, 2026

📝 Description

This pull request updates the documentation to consistently use Docker Compose profiles, specifically the controller profile, when starting and stopping Intel® SceneScape services.

Docker Compose command updates:

  • Updated all docker compose up and docker compose down commands in documentation files to include --profile controller, ensuring only the controller containers are affected.

  • In sections describing stopping services, also added the --profile experimental flag where appropriate to match the startup commands and included a note explaining the need for profile consistency.

Documentation improvements:

  • Added explanatory notes to clarify why the --profile controller flag is necessary, especially when using make demo, and provided troubleshooting tips for handling leftover containers.

✨ Type of Change

Select the type of change your PR introduces:

  • 🐞 Bug fix – Non-breaking change which fixes an issue
  • 🚀 New feature – Non-breaking change which adds functionality
  • 🔨 Refactor – Non-breaking change which refactors the code base
  • 💥 Breaking change – Changes that break existing functionality
  • 📚 Documentation update
  • 🔒 Security update
  • 🧪 Tests
  • 🚂 CI

🧪 Testing Scenarios

Describe how the changes were tested and how reviewers can test them too:

  • ✅ Tested manually
  • 🤖 Ran automated end-to-end tests

✅ Checklist

Before submitting the PR, ensure the following:

  • 🔍 PR title is clear and descriptive
  • 📝 For internal contributors: If applicable, include the JIRA ticket number (e.g., ITEP-123456) in the PR title. Do not include full URLs
  • 💬 I have commented my code, especially in hard-to-understand areas
  • 📄 I have made corresponding changes to the documentation
  • ✅ I have added tests that prove my fix is effective or my feature works

Copy link
Contributor

@tdorauintc tdorauintc left a comment

Choose a reason for hiding this comment

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

I am not very happy with the current state, because compose profiles in general are deployment customizations that are up to the user, so explicitly specifying profile in user guides assumes a-priori knowledge of user's intentions, which is not always true (e.g., user sometimes may want to run experimental tracker or mapping instead of default deployment).

Profiles have proliferated recently and deserve a separate section in the get-started guide, because the only place where are documented completely is demo docker compose configuration file.

My suggestions:

  • Add a separate section (in getting started guide) documenting available profiles and usage (mention controller as the default one).
  • Mention that profiles can be set either in CLI or via environment variable
  • In each user guide document mentioning usage of profiles (e.g. --profile controller) refer to the section documenting profiles, so that user is aware how to customize the command to their needs.

@tdorauintc
Copy link
Contributor

I am not very happy with the current state, because compose profiles in general are deployment customizations that are up to the user, so explicitly specifying profile in user guides assumes a-priori knowledge of user's intentions, which is not always true (e.g., user sometimes may want to run experimental tracker or mapping instead of default deployment).

Profiles have proliferated recently and deserve a separate section in the get-started guide, because the only place where are documented completely is demo docker compose configuration file.

My suggestions:

  • Add a separate section (in getting started guide) documenting available profiles and usage (mention controller as the default one).
  • Mention that profiles can be set either in CLI or via environment variable
  • In each user guide document mentioning usage of profiles (e.g. --profile controller) refer to the section documenting profiles, so that user is aware how to customize the command to their needs.

Please also update docs/user-guide/other-topics/how-to-enable-reidentification.md with vdms profile usage,

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants