Skip to content

Commit

Permalink
Docs Missing from Navigation and Airlock Docs (#3758)
Browse files Browse the repository at this point in the history
Docs Missing from Navigation
Fixes #3422
  • Loading branch information
marrobi authored Oct 18, 2023
1 parent 90b6fae commit e6ca1a9
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 96 deletions.
Binary file added docs/assets/airlock_functions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/airlock_functions_error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 1 addition & 9 deletions docs/tre-admins/configure-airlock-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,4 @@ Once you're done, click Submit.

Verify that the configuration is working by creating Review VMs for existing import export and export requests (configuration is not verified on update).


## Troubleshooting

### Users cannot create Review VMs

If a user sees an error when creating Review VMs, this most likely means that the configuration isn't correct.
Double-check that all GUIDs don't have any symbols missing, and the names of templates are correct.

[![Review VM Error](../assets/using-review-vm-errors.png)](../assets/using-review-vm-errors.png)
For troubleshooting guidance please review [the airlock troubleshooting FAQ](../troubleshooting-faq/airlock-troubleshooting.md)
30 changes: 30 additions & 0 deletions docs/troubleshooting-faq/airlock-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Airlock Troubleshooting

## Users cannot create Review VMs

If a user sees an error when creating Review VMs, this most likely means that the configuration isn't correct.
Double-check that all GUIDs don't have any symbols missing, and the names of templates are correct.

[![Review VM Error](../assets/using-review-vm-errors.png)](../assets/using-review-vm-errors.png)


## Files do not appear in Review Data folder on the VM

If the Review Data folder is empty, it's likely because the review VM can't connect to the storage account. Import requests must be reviewed using a VM inside the workspace, and export requests must be reviewed using a VM outside the workspace.

For imports ensure that the `airlock-import-review` workspace template is being used and configured in the airlock configuration for the workspace.


## Airlock request does not move through the workflow as expected

If the Airlock request does not move through the workflow as expected, it's likely an issue with the Azure Function that processes airlock requests. This function is deployed as part of the TRE, and can be found in the Azure Portal under the name `func-airlock-processor-<tre_id>`.

To troubleshoot, view the function invocations starting with the StatusChangedQueue Trigger, then the other functions as shown in the image below:

[![Function details](../assets/airlock_functions.png)](../assets/airlock_functions.png)

Look for errors in the function invocations in the same time frame that the airlock request was created. Even if the function executed successfully, there may still be errors within the function invocation details. Invocations that take longer can also be a sign of an issue. For example:

[![Functions error](../assets/airlock_functions_error.png)](../assets/airlock_functions_error.png)

If this error should have been handled please create an issue on the GitHub repository for the Azure TRE.
20 changes: 0 additions & 20 deletions docs/using-tre/faq.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/using-tre/terms-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,3 @@ To use a template, and deploy a resource, the template needs to be registered in
Once a template is registered it can be used multiple times to deploy multiple workspaces, workspace services etc.

If you want to author your own workspace, workspace service, or user resource template, consult the [template authoring guide](../tre-workspace-authors/authoring-workspace-templates.md)

**Thank you for your patience and support!**
20 changes: 0 additions & 20 deletions docs/using-tre/wks/index.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/using-tre/wks/using-wks.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/using-tre/wks/wks-owner.md

This file was deleted.

6 changes: 1 addition & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,6 @@ nav:
- Set up of a Virtual Machine: using-tre/tre-for-research/using-vms.md
- Importing/exporting data with Airlock: using-tre/tre-for-research/importing-exporting-data-airlock.md
- Reviewing Airlock Requests: using-tre/tre-for-research/review-airlock-request.md
# - Workspaces:
# - using-tre/wks/index.md # Documentation describing what a workspace is
# - Using Workspaces: using-tre/wks/using-wks.md # Interacting with workspaces (via the UI)
# - The Workspace Owner: using-tre/wks/wks-owner.md # Workspace Owners. The concept, and tasks
# - FAQ: using-tre/faq.md # FAQ section (to allow easy contribution)

- Templates and Services: # Docs to highlight and illustrate workspaces, workspace services etc
- Workspaces:
Expand Down Expand Up @@ -166,6 +161,7 @@ nav:
- Checking the Service Bus: troubleshooting-faq/troubleshooting-sb.md
- Checking Logs in Application Insights: troubleshooting-faq/app-insights-logs.md
- Troubleshooting the Resource Processor: troubleshooting-faq/troubleshooting-rp.md
- Troubleshooting the Airlock: troubleshooting-faq/airlock-troubleshooting.md
- Manually edit resources in Cosmos DB: troubleshooting-faq/manually-editing-resources.md
- Troubleshooting cloud-init: troubleshooting-faq/cloud-init.md

Expand Down

0 comments on commit e6ca1a9

Please sign in to comment.