Gitea Workspace Service documentation

Describe the bug The documentation for setting up Gitea as a Workspace Service is not very detailed and is out of date.

I am trying to set up Gitea but there are steps within the docs that no longer apply. Such as:

“The Gitea workspace service container image needs building and pushing: make build-gitea-workspace-service-image push-gitea-workspace-service-image”

There is also not enough information or it is incorrect as following the steps gives a 403 error when trying to connect to the service.

Steps to reproduce

1. Run make bundle-build bundle-publish DIR=templates/workspace_services/gitea
2. Run make bundle-register DIR=templates/workspace_services/gitea/ BUNDLE_TYPE=workspace_service
3. Go to the TRE UI and Deploy Gitea
4. When Deploying fill in the required information: 2.1 Enter the OpenID Client ID is the Workspace App registration Application (client) ID. This can be found in the KeyVault for the Workspace and on the Overview page of the App registration 2.2 Enter the OpenID Client Secret. This can only be found in the KeyVault for the Workspace. 2.3 Enter the OpenID Authority: https://login.microsoftonline.com/{tenant_id}/v2.0
5. Within the App registration, go to the Authentication tab in the blade on the left-hand side and add the Gitea redirect URI. In the form https://<gitea_url>/user/oauth2/oidc/callback (gitea_url can be found by clicking on the details tab of the deployed service)
6. Deploy the Workspace Service This is where it fails
7. Press Connect on the Workspace Service.
8. I see a 403 error

In the documentation it says Navigate to the Gitea workspace service and from the menu click the Sign in button. Does this mean press Connect and it should ask you to sign in?

[marrobi]

Thanks @JaimieWi we will try and find time later this week to verify this.

cc @anastasiakuzn

[JaimieWi]

@marrobi

I did check and I cannot access github.com from within the VM. But to be safe, I have moved the rule over to the web_app_subnet and it works just as well.

The goal was so that researchers could have their private repositories in Gitea kept private and only accessible by logging in with their credentials. The shared service doesn’t allow this as any repository has to be kept public to all within the TRE.

It would also be beneficial as researchers in a particular workspace may have a repository they would be happy to share within their project (workspace). But not across workspaces/projects.

Just to clarify, what is the purpose of the Gitea Workspace Service vs the Gitea Shared Service?

There isn’t anything in the documentation that helps us understand the distinction.