Introduction
To enable soup dependency reporting for the product/repo, the dependencies used by the repo/s should be identified and captured in databases
In order to achieve this a yml template is created in the common template repo here. You can include this template which has to be invoked as part of the ci/cd pipeline. This will place the dependency and component info files into a storage account. This storage account is monitored by a blob triggered azure function which will parse the files, extract usable data and update the cosmos database. This information is used to create soup dependency reports
How to use the yml template in your repo's pipeline
- Goto the pipeline yml file for you repo
- include resource reference to yml template as follows
- repository : is the unique name for the resource.
-
name : is the name of the template in the format {project}/{repository}. Value is always 'shared/devops-common-templates'
-
Add a last stage in the pipeline as follows
- minimum parameters required are
-
kubeEnv : is used for folder path creation in azure storage account. By convention, this has been named after the destination environment (e.g. AKS-Dev4, AKS-CI, EKS..)
-
Other parameters available are as follows
-
azSvcConn : service connection in azure devops with permission to list storage account keys. This is used to transfer files into storage account
- pompath: Usually just "pom.xml", but we use this to determine if we are doing Java or Not
- copynuget: Copy a built nuget - this is the path to the nupkg
- chartpath: Will upload the contents of the folder for help charts (bit of a WIP)
- buildArtifactName: Will expand this to "drop" and look for files within it.
- localExpandDir: You may need to change this if your pipeline already had a root drop dir.
Things to remember
- There are few other parameters in the yml template which refers to the storage account to be used. Do not change the value (for soup report purpose), as only the default storage account is being monitored by azure function