Skip to content

Commit

Permalink
FLPATH-1555: added repo req for all mta docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jenniferubah committed Aug 8, 2024
1 parent ef0e673 commit b6c90f9
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
3 changes: 2 additions & 1 deletion mta-v6.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ the cloud-readiness compatibility of their code.

# Requirement for Repository
- Create a git repo with a simple Java class. It can either be public or private.
Currently, MTA supports mostly Java projects.
- If repository is private, refer to [configuring repository][4] on how to set up credentials on MTA.
- Note: When creating the source control credentials in MTA, ensure to input personal access token in the password field.
Refer to [personal access token] [5] on how to create personal access token (classic) on GitHub.
Expand All @@ -23,7 +24,7 @@ the cloud-readiness compatibility of their code.
# Output
1. On completion the workflow returns an [options structure][2] in the exit state of the workflow (also named variables in SonataFlow)
linking to the [move2kube][3] workflow that will generate k8s manifests for container deployment.
2. When the workflow completes there should be a report link on the exit state of the workflow (also named variables in SonataFlow)
1. When the workflow completes there should be a report link on the exit state of the workflow (also named variables in SonataFlow)
Currently this is working with MTA version 6.2.x and in the future 7.x version the report link will be removed or will be made
optional. Instead of an html report the workflow will use a machine friendly json file.

Expand Down
12 changes: 12 additions & 0 deletions mta-v7.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ the cloud-readiness compatibility of their code.
- `repositoryUrl` [mandatory] - the git repo url to examine
- `recipients` [mandatory] - A list of recipients for the notification in the format of `user:<namespace>/<username>` or `group:<namespace>/<groupname>`, i.e. `user:default/jsmith`.

# Requirement for Repository
- Create a git repo with a simple Java class. It can either be public or private.
Currently, MTA supports mostly Java projects.
- If repository is private, refer to [configuring repository][4] on how to set up credentials on MTA.
- Note: When creating the source control credentials in MTA, ensure to input personal access token in the password field.
Refer to [personal access token] [5] on how to create personal access token (classic) on GitHub.
- Also, git url address must use https. Refer to [about remote repositories][6] for more details.
- If the repo is public, no further configuration is needed.

# Output
1. On completion the workflow returns an [options structure][2] in the exit state of the workflow (also named variables in SonataFlow)
linking to the [move2kube][3] workflow that will generate k8s manifests for container deployment.
Expand Down Expand Up @@ -45,3 +54,6 @@ All the configuration items are on [./application.properties]
[1]: https://developers.redhat.com/products/mta/download
[2]: https://github.com/parodos-dev/serverless-workflows/blob/main/assessment/schema/workflow-options-output-schema.json
[3]: https://github.com/parodos-dev/serverless-workflows/tree/main/move2kube
[4]: https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/6.2/html-single/user_interface_guide/index#configuring-credentials
[5]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic
[6]: https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories
12 changes: 12 additions & 0 deletions mta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ the cloud-readiness compatibility of their code.
- `repositoryUrl` [mandatory] - the git repo url to examine
- `recipients` [mandatory] - A list of recipients for the notification in the format of `user:<namespace>/<username>` or `group:<namespace>/<groupname>`, i.e. `user:default/jsmith`.

# Requirement for Repository
- Create a git repo with a simple Java class. It can either be public or private.
Currently, MTA supports mostly Java projects.
- If repository is private, refer to [configuring repository][4] on how to set up credentials on MTA.
- Note: When creating the source control credentials in MTA, ensure to input personal access token in the password field.
Refer to [personal access token] [5] on how to create personal access token (classic) on GitHub.
- Also, git url address must use https. Refer to [about remote repositories][6] for more details.
- If the repo is public, no further configuration is needed.

# Output
1. On completion the workflow returns an [options structure][2] in the exit state of the workflow (also named variables in SonataFlow)
linking to the [move2kube][3] workflow that will generate k8s manifests for container deployment.
Expand Down Expand Up @@ -45,3 +54,6 @@ All the configuration items are on [./application.properties]
[1]: https://developers.redhat.com/products/mta/download
[2]: https://github.com/parodos-dev/serverless-workflows/blob/main/assessment/schema/workflow-options-output-schema.json
[3]: https://github.com/parodos-dev/serverless-workflows/tree/main/move2kube
[4]: https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/6.2/html-single/user_interface_guide/index#configuring-credentials
[5]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic
[6]: https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories

0 comments on commit b6c90f9

Please sign in to comment.