Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Latest commit

 

History

History
55 lines (43 loc) · 3.27 KB

INITIAL-SETUP.md

File metadata and controls

55 lines (43 loc) · 3.27 KB

Templating this repository

Select "Use This Template" and create a repository within the organisation required.
Decide if you are using the microsoft TRE or if your using a local fork.
We recommend a fork so create a fork in your organisation of https://github.com/microsoft/AzureTRE (AzureTRE)

Prerequisites

Create at least one environment in the new repository. By default we recommend dev/test/prod
You will need VSCODE and DOCKER installed locally.
You will need a Personal Access Token created for GIT. You can do this via the UI. (PAT)
Create a new resource group in the subscription your deploying to.
Create an empty image galary inside that resource group and make note of the resource id. (GAL_ID)
Edit .devcontainer/devcontainer.json and ensure your putting the correct TAG version e.g. "OSS_VERSION": "v0.14.1"
Edit .devcontainer/scripts/install-azure-tre-oss.sh and ensure the org is correct http://github.com/(AzureTRE)/AzureTRE/archive/${oss_version}.tar.gz

Running The Code

Clode down the AzureTRE-Deployment repository to your laptop.
Open in VSCODE an then reopen in dev container.
Copy "config.sample.yaml" to "config.yaml".
Edit "config.yaml" and change all the entries referencing "CHANGE_ME" on lines where they are not commented out.

make auth

Config.yaml has now been updated. next we need to setup git using the environment and PAT token.

./setup_git_environment.sh <env> (PAT)

After this script has run, you will find it has echo'ed out part of the azure_credentials. get the client id for the secret and the secret itself and update AZURE_CREDENTIALS in the git secrets of the environment.
While your there, update the RP_BUNDLES variable with the value of the (GAL_ID)
Review the custom tag values. these need to be the Key's required on the organisation and a list of enums for the values.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.