This project is intended to assist the deployment of the Azure TRE project in real world environments. This includes deploying using GitHub Actions, and publishing custom templates. See Azure TRE docs to learn how to get started with Azure TRE, how to deploy it in your environment using this repo and more.
In this project you will find:
- Github Actions implementing AzureTRE automation, including running deployments to Azure
- Configuration specific to deployment
- Workspace template definitions
- User resource template definitions
- Devcontainer setup
This project is setup to work locally with devcontainers read more about it (here). It contains all the required tooling to develop your custom templates and deploy the Azure TRE. In addition it defines the AzureTRE version that will be downloaded and used in the container.
The files for the dev container are located in /.devcontainer/ folder.
To work with devcontainers you will need:
As part of the devcontainer definition a specific version of AzureTRE is downloaded. The AzureTRE is then available to reference in the devconatiner but any changes to it are gitignored.
To upgrade AzureTRE version go to devcontainer.json and update the OSS_VERSION param to the desired version.
The configuration files are required for the AzureTRE local deployment. Before setting up the configuration files make sure to follow the AzureTRE pre-deployment steps to setup and understand the required configuration.
In this repository there are 3 configuration files:
- auth.env - Created during bash
make authand contains the required authentication setup. - /devops/.env - contains deployment related configuration such as management infrastructure and azure credentials.
- /templates/core/.env - contains TRE setup config.
Copy the sample env files, renaming them without the sample suffix (For example: .env.sample -> .env).Then fill in the required environment configurations.
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.
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.