ITEP-87867 Information about docker compose profile#1098
ITEP-87867 Information about docker compose profile#1098
Conversation
There was a problem hiding this comment.
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 |
📝 Description
This pull request updates the documentation to consistently use Docker Compose profiles, specifically the
controllerprofile, when starting and stopping Intel® SceneScape services.Docker Compose command updates:
Updated all
docker compose upanddocker compose downcommands in documentation files to include--profile controller, ensuring only the controller containers are affected.In sections describing stopping services, also added the
--profile experimentalflag where appropriate to match the startup commands and included a note explaining the need for profile consistency.Documentation improvements:
--profile controllerflag is necessary, especially when usingmake demo, and provided troubleshooting tips for handling leftover containers.✨ Type of Change
Select the type of change your PR introduces:
🧪 Testing Scenarios
Describe how the changes were tested and how reviewers can test them too:
✅ Checklist
Before submitting the PR, ensure the following: