Readme for build_stream#4152
Open
priti-parate wants to merge 15 commits intodell:pub/build_streamfrom
Open
Conversation
… pub/build_stream
Signed-off-by: priti-parate <140157516+priti-parate@users.noreply.github.com>
Rajeshkumar-s2
approved these changes
Mar 11, 2026
Venu-p1
reviewed
Mar 11, 2026
Venu-p1
reviewed
Mar 11, 2026
Comment on lines
+54
to
+69
| **Development Setup:** | ||
| ```bash | ||
| # Install dependencies | ||
| pip install -r requirements.txt | ||
| pip install -r requirements-dev.txt | ||
|
|
||
| # Set environment variables | ||
| export HOST=<host ip> | ||
| export PORT=<port> | ||
|
|
||
| # Run development server | ||
| uvicorn main:app --reload | ||
|
|
||
| # Run tests | ||
| pytest | ||
| ``` |
Collaborator
There was a problem hiding this comment.
these only talks about the API server, we need to mention about other pre-req infra setup
Venu-p1
reviewed
Mar 11, 2026
| **Security:** | ||
| - JWT token-based authentication | ||
| - Vault integration for secret management | ||
| - Role-based access control |
Collaborator
There was a problem hiding this comment.
Not available today, can be removed.
Collaborator
Author
There was a problem hiding this comment.
to build image we can pass any roles, so I kept this
Collaborator
There was a problem hiding this comment.
this is not ansible roles. these are referring to logged in user roles like admin, etc
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/developer-guide.md
Outdated
Comment on lines
+17
to
+18
| - **Audit Trail**: Complete logging of all operations | ||
|
|
Collaborator
There was a problem hiding this comment.
not required at this point
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/developer-guide.md
Outdated
Comment on lines
+88
to
+89
| pip install -r requirements.txt | ||
| pip install -r requirements-dev.txt |
Collaborator
There was a problem hiding this comment.
need to comeup on how to setup infra related to playbook executions.
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/developer-guide.md
Outdated
|
|
||
| **Integration Tests:** | ||
| - Test workflow end-to-end | ||
| - Use test database and artifact store |
Collaborator
There was a problem hiding this comment.
can add (in memory db, etc)
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/developer-guide.md
Outdated
| - Business rules in domain layer | ||
| - Security scanning for malicious content | ||
|
|
||
| ## Performance Optimization |
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/build_image.md
Outdated
| @@ -0,0 +1,114 @@ | |||
| # Image Building | |||
|
|
|||
| The Image Building workflow orchestrates container image creation for the Omnia platform components. | |||
Collaborator
There was a problem hiding this comment.
need to be os image and at all other places.
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/catalog.md
Outdated
| - `orchestrator/catalog/use_cases/parse_catalog.py` - Catalog parsing logic | ||
| - `orchestrator/catalog/use_cases/generate_input_files.py` - Input file generation | ||
| - `core/catalog/entities.py` - Catalog domain entities | ||
| - `core/catalog/repositories.py` - Catalog data access |
Collaborator
There was a problem hiding this comment.
not available, remove this line
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/catalog.md
Outdated
| - `orchestrator/catalog/use_cases/generate_input_files.py` - Input file generation | ||
| - `core/catalog/entities.py` - Catalog domain entities | ||
| - `core/catalog/repositories.py` - Catalog data access | ||
| - `generate_catalog.py` - Standalone catalog generation script |
Collaborator
There was a problem hiding this comment.
this is script to generate catalog from existing input files. this not to document.
Venu-p1
reviewed
Mar 11, 2026
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/catalog.md
Outdated
Comment on lines
+73
to
+75
| - Package mapping files | ||
| - Role templates | ||
| - Platform-specific configurations |
Collaborator
There was a problem hiding this comment.
can we mention adapter policy to be consistent ?
Role templates? need more details
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/catalog.md
Outdated
| - Comprehensive schema validation for catalogs | ||
| - Detailed error reporting for invalid packages | ||
| - Graceful handling of missing dependencies | ||
| - Rollback capabilities for failed processing |
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/catalog.md
Outdated
Comment on lines
+85
to
+91
| ## Standalone Script | ||
|
|
||
| The `generate_catalog.py` script provides: | ||
| - Command-line catalog generation | ||
| - Batch processing capabilities | ||
| - Integration with external CI/CD pipelines | ||
| - Detailed logging and error reporting |
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/jobs.md
Outdated
| The Jobs workflow provides: | ||
| - Job creation with idempotency guarantees | ||
| - Stage-based execution with state management | ||
| - Real-time job monitoring and status tracking |
Collaborator
There was a problem hiding this comment.
Realtime, can be removed.
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/jobs.md
Outdated
Comment on lines
+56
to
+59
| - **catalog_roles** - Software catalog processing | ||
| - **local_repo** - Local repository creation | ||
| - **build_image** - Container image building | ||
| - **validate** - Input/output validation |
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/jobs.md
Outdated
| ## Error Handling | ||
|
|
||
| - Invalid state transitions are rejected | ||
| - Failed stages can be retried based on configuration |
Collaborator
There was a problem hiding this comment.
retry not supported today
Venu-p1
reviewed
Mar 11, 2026
build_stream/doc/jobs.md
Outdated
| ## Monitoring | ||
|
|
||
| - Job status available via `/api/v1/jobs/{job_id}` endpoint | ||
| - List all jobs with filtering options |
abhishek-sa1
approved these changes
Mar 16, 2026
Venu-p1
approved these changes
Mar 16, 2026
| **Security:** | ||
| - JWT token-based authentication | ||
| - Vault integration for secret management | ||
| - Role-based access control |
Collaborator
There was a problem hiding this comment.
this is not ansible roles. these are referring to logged in user roles like admin, etc
Comment on lines
+180
to
+184
| ### Performance Tests | ||
| Test system performance and scalability: | ||
| - Load testing for concurrent requests | ||
| - Stress testing for resource limits | ||
| - Benchmark tests for critical operations |
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
4 participants
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.
Updated build_Stream overall doc, test doc and module wise doc
@Venu-p1 @abhishek-sa1