Epic Goal

Since its first release, the insights that Konveyor could gather from a given application were either coming from the source code from the application itself (analysis), or from information provided by the different stakeholders involved in the management of the application lifecycle (assessment). This enhancement proposes a third way of surfacing insights about an application by gathering both runtime and deployment configuration from the very platform in which the application is running (discovery), and storing that configuration in a canonical model that can be leveraged by different Konveyor modules or addons.

Aside from that, the support that Konveyor provided for the migration process stopped when the application source code was modified for the target platform, leaving the application itself ready to be deployed but without the required assets to get it actually deployed in the target platform. For example, for an application to be deployed in Kubernetes, it is not only necessary to adapt the application source code to run in containers, but it is also necessary to have deployment manifests that define how that application can be deployed in a cluster, a Containerfile to build the image and potentially some runtime configuration files. This enhancement proposes a way to automate the generation of those assets by leveraging the configuration and insights gathered by Konveyor.

This Epic is fleshed out in the following Konveyor Enhancement: https://github.com/konveyor/enhancements/pull/210

What is the main user goal aka job to be done?

1. As a Migration Architect, I want to generate accurate application asset inventories so that I can assess migration readiness and plan effective migration strategies.

1. As a DevOps Engineer, I want to evaluate platform compatibility for my applications so that I can ensure a smooth transition to the target environment without disruptions.

1. As a Project Manager, I want to visualize the dependencies and relationships between applications and their assets so that I can manage risks and allocate resources effectively during the migration process.

1. As a System Administrator, I want to automate the asset generation process so that I can save time and reduce manual errors, allowing me to focus on more strategic tasks.

Stages of content journey

1. Discover

Objective: Introduce users to the concepts of Assets generation and Platform Awareness within the MTA.

• Introduction to MTA: 
  • A comprehensive overview of the Migration Toolkit for Applications, its purpose, and its relevance to Assets generation and Platform Awareness.
• Key Concepts Document: 
  • Define key terms and concepts related to Assets generation and Platform Awareness.
• High-Level Architecture Diagrams: 
  • Visual representations of how MTA integrates with existing systems and processes.
• Key Documentation Elements:

• • Overview of the importance of assets in migration.
  • Explanation of platform awareness and its role in successful migrations.

2. Learn

Objective: Provide in-depth knowledge about the features and functionalities of the toolkit.

• Content Types:

• • User Guides: Detailed documentation on how to use the MTA for Assets generation and Platform Awareness.
  • Feature Descriptions: In-depth explanations of specific features, including how they contribute to Assets generation and Platform Awareness.
  • Best Practices: Recommendations for effectively using the toolkit to maximize benefits.
• Key Documentation Elements:

• • Step-by-step guides on generating assets.
  • Detailed explanations of platform assessment tools within MTA.
  • Common pitfalls and how to avoid them.

3. Try

Objective: Encourage users to experiment with the toolkit through practical applications.

• Content Types:

• • Hands-On Tutorials: Step-by-step tutorials that guide users through specific tasks related to Assets generation and Platform Awareness.
  • Sample Projects: Pre-configured examples that users can download and explore to understand the toolkit's capabilities.
  • Interactive Demos: Links to online demos or simulations where users can practice using the toolkit.
• Key Documentation Elements:

• • Instructions for setting up a test environment.
  • Sample data sets for users to work with during their trials.
  • Feedback mechanisms for users to report their experiences.

4. Adopt

Objective: Support users in integrating the toolkit into their workflows and processes.

• Content Types:

• • Implementation Guides: Comprehensive documentation on how to integrate MTA into existing workflows, including configuration and setup.
  • Case Studies: Real-world examples of organizations that have successfully adopted the toolkit, highlighting challenges and solutions.
  • FAQs and Troubleshooting Guides: Address common issues and questions that arise during adoption.
• Key Documentation Elements:

• • Step-by-step instructions for integrating MTA with other tools and platforms.
  • Success stories that illustrate the benefits of using MTA for Assets generation and Platform Awareness.
  • Troubleshooting tips for common integration issues.

5. Expand

Objective: Encourage users to explore advanced features and additional resources.

• Content Types:

• • Advanced User Guides: Documentation on more complex functionalities and features of the MTA.
  • Webinars and Workshops: Information on upcoming training sessions and workshops focused on advanced topics.
  • Resource Libraries: Curated lists of additional documentation, tools, and community resources.
• Key Documentation Elements:

• • Detailed guides on advanced asset generation techniques.
  • Information on community contributions and how to get involved.
  • Links to external resources for further learning and exploration.

Content Journey

https://spaces.redhat.com/display/MMSDOCS/Assets+generation+and+Platform+Awareness+enhancement+content+journey