Docs Missing from Navigation and Airlock Docs (#3758)

Docs Missing from Navigation
Fixes #3422
This commit is contained in:
Marcus Robinson 2023-10-18 13:01:53 +01:00 коммит произвёл GitHub
Родитель 90b6faed6e
Коммит e6ca1a9d9d
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
10 изменённых файлов: 32 добавлений и 96 удалений

Двоичные данные
docs/assets/airlock_functions.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 63 KiB

Двоичные данные
docs/assets/airlock_functions_error.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 90 KiB

Просмотреть файл

@ -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)

Просмотреть файл

@ -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.

Просмотреть файл

@ -1,20 +0,0 @@
# FAQ
!!! info
Coming soon
We're working to improve our documentation, and fill in some gaps. Unfortunately, this particular page is one of the gaps we're looking to fill and isn't yet available.
## How to Contribute to our Documentation
If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.
You can find our existing documentation issues on GitHub by clicking on the link below:
[Existing Documentation Issues](https://github.com/microsoft/AzureTRE/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
Or, you can raise a new issue by clicking on this link:
[Report an Issue or Make a Suggestion](https://github.com/microsoft/AzureTRE/issues/new/choose)
**Thank you for your patience and support!**

Просмотреть файл

@ -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!**

Просмотреть файл

@ -1,20 +0,0 @@
# Workspaces
!!! info
Coming soon
We're working to improve our documentation, and fill in some gaps. Unfortunately, this particular page is one of the gaps we're looking to fill and isn't yet available.
## How to Contribute to our Documentation
If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.
You can find our existing documentation issues on GitHub by clicking on the link below:
[Existing Documentation Issues](https://github.com/microsoft/AzureTRE/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
Or, you can raise a new issue by clicking on this link:
[Report an Issue or Make a Suggestion](https://github.com/microsoft/AzureTRE/issues/new/choose)
**Thank you for your patience and support!**

Просмотреть файл

@ -1,20 +0,0 @@
# Using Workspaces
!!! info
Coming soon
We're working to improve our documentation, and fill in some gaps. Unfortunately, this particular page is one of the gaps we're looking to fill and isn't yet available.
## How to Contribute to our Documentation
If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.
You can find our existing documentation issues on GitHub by clicking on the link below:
[Existing Documentation Issues](https://github.com/microsoft/AzureTRE/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
Or, you can raise a new issue by clicking on this link:
[Report an Issue or Make a Suggestion](https://github.com/microsoft/AzureTRE/issues/new/choose)
**Thank you for your patience and support!**

Просмотреть файл

@ -1,20 +0,0 @@
# Workspace Owners
!!! info
Coming soon
We're working to improve our documentation, and fill in some gaps. Unfortunately, this particular page is one of the gaps we're looking to fill and isn't yet available.
## How to Contribute to our Documentation
If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.
You can find our existing documentation issues on GitHub by clicking on the link below:
[Existing Documentation Issues](https://github.com/microsoft/AzureTRE/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
Or, you can raise a new issue by clicking on this link:
[Report an Issue or Make a Suggestion](https://github.com/microsoft/AzureTRE/issues/new/choose)
**Thank you for your patience and support!**

Просмотреть файл

@ -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:
@ -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