Microservice for notifying services that requested upload of files created externally to HMRC estate, namely from members of the public. This is not intended to be used for transfer of files from one HMRC service to another, for this you need to intergrate directly with the file transfer service.
In order to run the service against one of HMRC accounts (labs, live) it's needed to have an AWS accounts with proper role. See UpScan Accounts/roles for proper details.
Prerequisites:
- AWS accounts with proper roles setup, i.e,
RoleUpscanEngineer,[platops_engineer, platform_member, upscan_engineer] - Proper AWS credential configuration set up according to this document aws-credential-configuration, with the credentials below:
[upscan-service-prototypes-engineer]
source_profile = webops-users
aws_access_key_id = YOUR_ACCESS_KEY_HERE
aws_secret_access_key = YOUR_SECRET_KEY_HERE
output = json
region = eu-west-2
mfa_serial = arn:aws:iam::638924580364:mfa/your.username
role_arn = arn:aws:iam::063874132475:role/RoleUpscanEngineer
[webops-users]
aws_access_key_id = YOUR_ACCESS_KEY_HERE
aws_secret_access_key = YOUR_SECRET_KEY_HERE
mfa_serial = arn:aws:iam::638924580364:mfa/your.username
region = eu-west-2
role_arn = arn:aws:iam::063874132475:role/RoleUpscanEngineer
- Working AWS MFA authentication
- Install botocore and awscli python modules locally:
sudo pip install botocore
sudo pip install awscli
In order to run the app against lab environment it's neeeded to run the following commands:
export AWS_DEFAULT_PROFILE=name_of_proper_profile_in_dot_aws_credentials_file
./aws-profile sbt
These commands will give you an access to SBT shell where you can run the service using 'run' or 'start' commands.
Upscan service has end-to-end acceptance tests which can be found in https://github.com/hmrc/upscan-acceptance-tests repository
This code is open source software licensed under the Apache 2.0 License