Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional deployment examples to the documentation #1751

Open
1 of 4 tasks
Tracked by #2214
martinpeck opened this issue Apr 28, 2022 · 10 comments
Open
1 of 4 tasks
Tracked by #2214

Add additional deployment examples to the documentation #1751

martinpeck opened this issue Apr 28, 2022 · 10 comments
Assignees
Labels
documentation Improvements or additions to documentation story Stories are the smallest unit of work to be done for a project.

Comments

@martinpeck
Copy link
Member

martinpeck commented Apr 28, 2022

The following topics should be added to the documentation:

  • Docs: How AzureTRE might be Deployed with Custom Templates
  • Docs: How AzureTRE might be Deployed across Multiple Environments - Initially UAT and Production, sharing management registry so bundles are only built once. On manual approval deploy to production.
  • Deployment Repo: Samples of the above

These should be added to a new section within the documentation, named Resources under which we can then add FAQs, whitepapers, examples, case studies, and other non-reference docs.

  • Docs: Create new Resources section for Documentation
@martinpeck martinpeck added documentation Improvements or additions to documentation story Stories are the smallest unit of work to be done for a project. labels Apr 28, 2022
@martinpeck martinpeck moved this to Triage in AzureTRE - Crew Rock Apr 28, 2022
@marrobi
Copy link
Member

marrobi commented Apr 28, 2022

Thanks for creating this.

Can we also have maybe how the make commands are used in a CI/CD pipeline? Might be we have ADO and/or GItHub actions examples, but feel this is something that needs better docs. Thoughts?

@martinpeck
Copy link
Member Author

martinpeck commented Apr 28, 2022

how the make commands are used in a CI/CD pipeline

What do you mean? I'm keen not to document the GitHub action workflows (the workflows document themselves).
It might be useful to have an illustrated example of building an AzDO pipeline, and using the make commands.

@marrobi
Copy link
Member

marrobi commented Apr 28, 2022

Agree, diagram of stages and make commands.

@martinpeck martinpeck moved this from Triage to Backlog in AzureTRE - Crew Rock Apr 28, 2022
@marrobi marrobi added this to the Release 0.4 milestone Jun 22, 2022
@martinpeck martinpeck moved this from Backlog to In Progress in AzureTRE - Crew Rock Jun 22, 2022
@martinpeck martinpeck self-assigned this Jun 22, 2022
@marrobi marrobi changed the title Add Examples and Illustrations to Documentation Add Deployment Examples and Illustrations to Documentation Jun 29, 2022
@martinpeck martinpeck changed the title Add Deployment Examples and Illustrations to Documentation Add Samples and Tech Guides Section to Documentation Jul 6, 2022
@martinpeck martinpeck modified the milestones: Release 0.4, Backlog Jul 6, 2022
@martinpeck martinpeck moved this from In Progress to Next in AzureTRE - Crew Rock Jul 11, 2022
@damoodamoo damoodamoo moved this to Backlog in AzureTRE - Crew Rock Aug 16, 2022
@marrobi marrobi moved this to Up Next in Azure TRE - Engineering Jan 19, 2023
@marrobi
Copy link
Member

marrobi commented Jan 19, 2023

Samples or Examples might be better than Resources?

@marrobi marrobi changed the title Add Samples and Tech Guides Section to Documentation Add additional deployment examples to the documentation Jan 20, 2023
@tamirkamara
Copy link
Collaborator

tamirkamara commented Jan 29, 2023

I think the docs already specify how to add custom templates and include them in the CICD:
https://microsoft.github.io/AzureTRE/using-tre/templates/
https://microsoft.github.io/AzureTRE/tre-admins/setup-instructions/cicd-deplyment/

Marking that item as done.

@marrobi
Copy link
Member

marrobi commented Jan 29, 2023

@tamirkamara people are struggling to get the party correct for custom templates when using the deployment repository. I don't think the examples in the CI/CD doc are quite right.

Will find an example Monday.

@marrobi
Copy link
Member

marrobi commented Jan 31, 2023

@damoodamoo to share work from in progress engagement so no need for new content to be created by anybody else.

@martinpeck
Copy link
Member Author

Where do you want this to be added @marrobi? i.e. which section of the docs?

@marrobi
Copy link
Member

marrobi commented Jan 31, 2023

Maybe a Deployment section in:

image

And the workflows in the AzureTRE-Deployment repository?

@marrobi marrobi moved this from Up Next to In Progress in Azure TRE - Engineering Jan 31, 2023
@tamirkamara
Copy link
Collaborator

What workflows? I thought this is more like a sample...
Need to remember that all workflows are automatically enabled when creating the repo (unless defined differently by the org). Plus GitHub Actions doesn't really support the notion of environment progression. Together this might present a real problem so we need to carefully consider this.

@tamirkamara tamirkamara moved this from In Progress to Up Next in Azure TRE - Engineering Feb 21, 2023
@tamirkamara tamirkamara moved this from Up Next to Done in Azure TRE - Engineering Feb 21, 2023
@marrobi marrobi removed this from the Backlog milestone Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation story Stories are the smallest unit of work to be done for a project.
Projects
Status: No status
Status: Backlog
Development

No branches or pull requests

4 participants