Skip to content
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

Generate CALM architecture from a Git repo #302

Open
dc-ms opened this issue Jul 7, 2024 · 0 comments
Open

Generate CALM architecture from a Git repo #302

dc-ms opened this issue Jul 7, 2024 · 0 comments
Labels
enhancement New feature or request Roadmap: Now

Comments

@dc-ms
Copy link
Member

dc-ms commented Jul 7, 2024

Description
We need to develop a feature that can automatically generate a CALM manifest by reading the source code in repositories. The manifest should include essential information such as dependencies, configuration settings, and metadata about the application components. This tool will streamline the process of maintaining up-to-date documentation and ensure that the manifest accurately reflects the current state of the codebase. This also enables discovery and documentation of existing applications to be completed at scale.

Features
Manifest Generation: Create a manifest that captures all necessary details identified during the code analysis. The manifest should be easily readable and include sections for dependencies, configurations, versioning, and any other pertinent metadata.

Automation and Integration: Integrate the tool into our CI/CD pipeline to ensure that the manifest is generated and updated automatically with each code commit. This integration will guarantee that the manifest remains current without requiring manual intervention. This specific feature is driven by maintaining fidelity of code : manifest in large scale environments and would be a post build step in a common pipeline.

Benefits
This will reduce the manual effort required to document dependencies and configurations, minimizing the risk of outdated or inaccurate information. This tool will also improve transparency and collaboration within the team by providing a clear and consistent view of the application’s components and settings. Additionally, having an up-to-date manifest will facilitate better dependency management, security audits, and deployment processes, ultimately contributing to the stability and maintainability of the application.

@red Hat partners - we've spoke about this previously and think it maybe a good place for your folks to start.

@dc-ms dc-ms added enhancement New feature or request Roadmap: Now labels Jul 7, 2024
@jpgough-ms jpgough-ms changed the title Generate CALM manifest from a Git repo Generate CALM architecture from a Git repo Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Roadmap: Now
Projects
None yet
Development

No branches or pull requests

1 participant