diff --git a/azure_devops/2-audit.md b/azure_devops/2-audit.md index d59e0d9..4ad5f81 100644 --- a/azure_devops/2-audit.md +++ b/azure_devops/2-audit.md @@ -173,6 +173,36 @@ Each pipeline will have a variety of files written that include: - The converted workflow. - Stack traces that can used to troubleshoot a failed pipeline conversion +## Inspect the workflow usage csv file + +1. Open the `tmp/audit/workflow_usage.csv` file in the file explorer. +2. This file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline: + + ```csv + Pipeline,Action,File path + lab-test/pipelines/valet-pipeline2,actions/checkout@v2,/data/tmp/adoa/lab-test/pipelines/valet-pipeline2.yml + lab-test/pipelines/valet-pipeline1,actions/checkout@v2,/data/tmp/adoa/lab-test/pipelines/valet-pipeline1.yml + lab-test/pipelines/valet-custom-transformer-example,actions/checkout@v2,/data/tmp/adoa/lab-test/pipelines/valet-custom-transformer-example.yml + lab-test/pipelines/valet-custom-transformer-example,actions/setup-node@v2,/data/tmp/adoa/lab-test/pipelines/valet-custom-transformer-example.yml + + Pipeline,Secret,File path + + + Pipeline,Runner,File path + lab-test/pipelines/valet-pipeline2,mechamachine,/data/tmp/adoa/lab-test/pipelines/valet-pipeline2.yml + lab-test/pipelines/valet-custom-transformer-example,mechamachine,/data/tmp/adoa/lab-test/pipelines/valet-custom-transformer-example.yml + ``` + +### Review workflow usage csv file + +#### Actions section + +The actions section contains a list of all actions that are used by each converted pipeline. This will enable you to perform strict security reviews to know exactly which repo will need access to a third-party action. + +#### Secrets and Runners sections + +The secrets and runners sections contain a list of all secrets and runners that are used by each converted pipeline. This will enable you to have a holistic view of what secrets and runners are used across all of your pipelines. + ### Next lab [Forecast potential build runner usage](3-forecast.md) diff --git a/circle_ci/2-audit.md b/circle_ci/2-audit.md index 30e842b..367c84b 100644 --- a/circle_ci/2-audit.md +++ b/circle_ci/2-audit.md @@ -191,6 +191,43 @@ Each pipeline will have a variety of files written that include: - The converted workflow. - Stack traces that can used to troubleshoot a failed pipeline conversion +## Inspect the workflow usage csv file + +1. Open the `tmp/audit/workflow_usage.csv` file in the file explorer. +2. This file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline: + + ```csv + Pipeline,Action,File path + valet-labs/circleci-hello-world,actions/checkout@v2,/data/tmp/audit/valet-labs/circleci-hello-world/say-hello-workflow.yml + valet-labs/circleci-command-example,./.github/actions/greeting,/data/tmp/audit/valet-labs/circleci-command-example/my-workflow.yml + valet-labs/circleci-node-example,actions/checkout@v2,/data/tmp/audit/valet-labs/circleci-node-example/sample.yml + valet-labs/circleci-node-example,actions/cache@v2,/data/tmp/audit/valet-labs/circleci-node-example/sample.yml + valet-labs/circleci-python-example,actions/checkout@v2,/data/tmp/audit/valet-labs/circleci-python-example/sample.yml + valet-labs/circleci-python-example,actions/cache@v2,/data/tmp/audit/valet-labs/circleci-python-example/sample.yml + valet-labs/circleci-demo-java-spring,actions/checkout@v2,/data/tmp/audit/valet-labs/circleci-demo-java-spring/workflow.yml + valet-labs/circleci-demo-java-spring,actions/cache@v2,/data/tmp/audit/valet-labs/circleci-demo-java-spring/workflow.yml + valet-labs/circleci-demo-java-spring,actions/upload-artifact@v2,/data/tmp/audit/valet-labs/circleci-demo-java-spring/workflow.yml + valet-labs/circleci-demo-java-spring,actions/download-artifact@v2,/data/tmp/audit/valet-labs/circleci-demo-java-spring/workflow.yml + valet-labs/circleci-demo-ruby-rails,ruby/setup-ruby@v1,/data/tmp/audit/valet-labs/circleci-demo-ruby-rails/build_and_test.yml + valet-labs/circleci-demo-ruby-rails,actions/checkout@v2,/data/tmp/audit/valet-labs/circleci-demo-ruby-rails/build_and_test.yml + valet-labs/circleci-demo-ruby-rails,actions/cache@v2,/data/tmp/audit/valet-labs/circleci-demo-ruby-rails/build_and_test.yml + + Pipeline,Secret,File path + + + Pipeline,Runner,File path + ``` + +### Review workflow usage csv file + +#### Actions section + +The actions section contains a list of all actions that are used by each converted pipeline. This will enable you to perform strict security reviews to know exactly which repo will need access to a third-party action. + +#### Secrets and Runners sections + +The secrets and runners sections contain a list of all secrets and runners that are used by each converted pipeline. This will enable you to have a holistic view of what secrets and runners are used across all of your pipelines. + ### Next lab [Forecast potential build runner usage](3-forecast.md) diff --git a/gitlab/1-configure.md b/gitlab/1-configure.md index b573429..091ac34 100644 --- a/gitlab/1-configure.md +++ b/gitlab/1-configure.md @@ -56,7 +56,7 @@ You will need to complete all of the setup instructions [here](./readme.md#confi ✔ Personal access token for GitHub: *************** ✔ Base url of the GitHub instance: https://github.com ✔ Private token for GitLab: *************** - ✔ Base url of the GitLab instance: https://gitlab.com + ✔ Base url of the GitLab instance: http://localhost Environment variables successfully updated. ``` diff --git a/gitlab/2-audit.md b/gitlab/2-audit.md index 3527bf9..09db3b8 100644 --- a/gitlab/2-audit.md +++ b/gitlab/2-audit.md @@ -181,6 +181,51 @@ Each pipeline will have a variety of files written that include: - The converted workflow. - Stack traces that can be used to troubleshoot a failed pipeline conversion +## Inspect the workflow usage csv file + +1. Open the `tmp/audit/workflow_usage.csv` file in the file explorer. +2. This file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline: + + ```csv + Pipeline,Action,File path + valet/included-files-example,actions/checkout@v2,/data/tmp/audit/valet/included-files-example.yml + valet/terraform-example,actions/checkout@v2,/data/tmp/audit/valet/terraform-example.yml + valet/child-parent-example,actions/checkout@v2,/data/tmp/audit/valet/child-parent-example.yml + valet/child-parent-example,./.github/workflows/a-.gitlab-ci.yml,/data/tmp/audit/valet/child-parent-example.yml + valet/child-parent-example,./.github/workflows/b-.gitlab-ci.yml,/data/tmp/audit/valet/child-parent-example.yml + valet/include-file-example,actions/checkout@v2,/data/tmp/audit/valet/include-file-example.yml + valet/basic-pipeline-example,actions/checkout@v2,/data/tmp/audit/valet/basic-pipeline-example.yml + valet/gatsby-example,actions/checkout@v2,/data/tmp/audit/valet/gatsby-example.yml + valet/gatsby-example,actions/cache@v2,/data/tmp/audit/valet/gatsby-example.yml + valet/gatsby-example,actions/upload-artifact@v2,/data/tmp/audit/valet/gatsby-example.yml + valet/gatsby-example,actions/download-artifact@v2,/data/tmp/audit/valet/gatsby-example.yml + valet/gatsby-example,JamesIves/github-pages-deploy-action@4.1.5,/data/tmp/audit/valet/gatsby-example.yml + valet/android-example,actions/checkout@v2,/data/tmp/audit/valet/android-example.yml + valet/android-example,actions/upload-artifact@v2,/data/tmp/audit/valet/android-example.yml + valet/android-example,actions/download-artifact@v2,/data/tmp/audit/valet/android-example.yml + valet/dotnet-example,actions/checkout@v2,/data/tmp/audit/valet/dotnet-example.yml + valet/dotnet-example,actions/upload-artifact@v2,/data/tmp/audit/valet/dotnet-example.yml + valet/dotnet-example,actions/download-artifact@v2,/data/tmp/audit/valet/dotnet-example.yml + valet/node-example,actions/checkout@v2,/data/tmp/audit/valet/node-example.yml + valet/node-example,actions/cache@v2,/data/tmp/audit/valet/node-example.yml + valet/rails-example,actions/checkout@v2,/data/tmp/audit/valet/rails-example.yml + + Pipeline,Secret,File path + valet/rails-example,${{ secrets.PASSWORD }},/data/tmp/audit/valet/rails-example.yml + + Pipeline,Runner,File path + ``` + +### Review workflow usage csv file + +#### Actions section + +The actions section contains a list of all actions that are used by each converted pipeline. This will enable you to perform strict security reviews to know exactly which repo will need access to a third-party action. + +#### Secrets and Runners sections + +The secrets and runners sections contain a list of all secrets and runners that are used by each converted pipeline. This will enable you to have a holistic view of what secrets and runners are used across all of your pipelines. + ### Next lab [Forecast potential build runner usage](3-forecast.md) diff --git a/jenkins/2-audit.md b/jenkins/2-audit.md index 8436d9b..050833a 100644 --- a/jenkins/2-audit.md +++ b/jenkins/2-audit.md @@ -238,6 +238,42 @@ Each pipeline will have a variety of files written that include: - The converted workflow. - Stack traces that can used to troubleshoot a failed pipeline conversion +## Inspect the workflow usage csv file + +1. Open the `tmp/audit/workflow_usage.csv` file in the file explorer. +2. This file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline: + + ```csv + Pipeline,Action,File path + demo_pipeline,actions/checkout@v2,/data/tmp/audit/demo_pipeline.yml + demo_pipeline,actions/upload-artifact@v2,/data/tmp/audit/demo_pipeline.yml + demo_pipeline,EnricoMi/publish-unit-test-result-action@v1.7,/data/tmp/audit/demo_pipeline.yml + monas_dev_work/monas_freestyle,actions/checkout@v2,/data/tmp/audit/monas_dev_work/monas_freestyle.yml + monas_dev_work/monas_pipeline,actions/checkout@v2,/data/tmp/audit/monas_dev_work/monas_pipeline.yml + test_freestyle_project,actions/checkout@v2,/data/tmp/audit/test_freestyle_project.yml + test_pipeline,actions/checkout@v2,/data/tmp/audit/test_pipeline.yml + test_pipeline,EnricoMi/publish-unit-test-result-action@v1.7,/data/tmp/audit/test_pipeline.yml + + Pipeline,Secret,File path + monas_dev_work/monas_freestyle,${{ secrets.SECRET_TEST_EXPRESSION_VAR }},/data/tmp/audit/monas_dev_work/monas_freestyle.yml + test_freestyle_project,${{ secrets.EXPRESSION_FIRST_VAR }},/data/tmp/audit/test_freestyle_project.yml + + Pipeline,Runner,File path + demo_pipeline,TeamARunner,/data/tmp/audit/demo_pipeline.yml + test_freestyle_project,DemoRunner,/data/tmp/audit/test_freestyle_project.yml + test_pipeline,TeamARunner,/data/tmp/audit/test_pipeline.yml + ``` + +### Review workflow usage csv file + +#### Actions section + +The actions section contains a list of all actions that are used by each converted pipeline. This will enable you to perform strict security reviews to know exactly which repo will need access to a third-party action. + +#### Secrets and Runners sections + +The secrets and runners sections contain a list of all secrets and runners that are used by each converted pipeline. This will enable you to have a holistic view of what secrets and runners are used across all of your successfully converted pipelines. + ## Next lab [Forecast potential build runner usage](3-forecast.md)