FAQ | This is a LIVE service | Changelog

Changes

Page history
Update FAQs authored by Dmitrii Unterov's avatar Dmitrii Unterov
Show whitespace changes
Inline Side-by-side
FAQs.md
View page @ 96c17b21
......@@ -4,8 +4,7 @@
## How can I create groups?
Users cannot directly create top-level groups. In general a top-level group should represent some autonomous unit within the University. Examples of top-level groups include: colleges, departments and divisions within a larger department.
To request a group, [open an issue in this project](https://gitlab.developers.cam.ac.uk/uis/devops/devhub/docs/issues/new). We need to have a human-friendly name for the group, a suggested "short name" for the group and at least two initial admins for the group.
Users cannot directly create top-level groups. In general a top-level group should represent some autonomous unit within the University. Examples of top-level groups include: colleges, departments and divisions within a larger department. To request a group, [open an issue in this project](https://gitlab.developers.cam.ac.uk/uis/devops/devhub/docs/issues/new). We need to have a human-friendly name for the group, a suggested "short name" for the group and at least two initial admins for the group.
> **Note:** all group admins must have already signed in to the Developer Hub and accepted the terms and conditions.
......@@ -23,7 +22,7 @@ The Developer Hub supports [deploy keys](https://gitlab.developers.cam.ac.uk/hel
There are some conventions associated with robot account users:
* They are named ``{group}-{tag}-bot``. For example: ``uis-support-bot``.
* They are named `{group}-{tag}-bot`. For example: `uis-support-bot`.
* They are configured as an [external user](https://docs.gitlab.com/ee/user/permissions.html#external-users-permissions).
* They must have a valid role email address associated with them. An initial password reset token is emailed to this address when created.
* We recommend that the robot user is configured with [2FA enabled](https://docs.gitlab.com/ee/user/profile/account/two_factor_authentication.html). This helps guard against some of the dangers of having an account with shared access credentials.
......@@ -35,8 +34,8 @@ Administrators of institution-wide groups may wish not to use their day-to-day a
There are some conventions associated with administrator accounts:
* They are tied to a single named user.
* They are named ``{group}-admin-{crsid}``. For example: ``uis-admin-spqr2``.
* They must have a valid email address associated with them which is not of the form ``{crsid}@cam.ac.uk``. We would recommend either a institutional address or the use of sub-addressing. For example: ``{crsid}+gitlab-{group}-admin@cam.ac.uk``. This is because two GitLab users cannot share an email address.
* They are named `{group}-admin-{crsid}`. For example: `uis-admin-spqr2`.
* They must have a valid email address associated with them which is not of the form `{crsid}@cam.ac.uk`. We would recommend either a institutional address or the use of sub-addressing. For example: `{crsid}+gitlab-{group}-admin@cam.ac.uk`. This is because two GitLab users cannot share an email address.
* As an account intended for group-wide administration, we recommend that the user is configured with [2FA enabled](https://docs.gitlab.com/ee/user/profile/account/two_factor_authentication.html).
* GitLab admins may opt to disable the account if the named user associated with the account ceases to administer the related group.
......@@ -46,9 +45,9 @@ If you administer one or more groups, [open an issue in this project](https://gi
An "external collaborator" is someone who you wish to give access to a Developer Hub project but who does not have an active University Account account. We grant external collaborator accounts on a case-by-case basis. [Open an issue in this project](https://gitlab.developers.cam.ac.uk/uis/devops/devhub/docs/issues/new) if you want an external collaborator account created. We will need a human-friendly name for the collaborator and an email address.
External collaborator users have usernames of the form ``external-{...}``. If you have any strong opinions on what the username should be, tell us. Otherwise we'll generate it from the local part of the external user's email address.
External collaborator users have usernames of the form `external-{...}`. If you have any strong opinions on what the username should be, tell us. Otherwise we'll generate it from the local part of the external user's email address.
> The process to be followed by admins is documented on [another page](/process/External Collaborators).
> The process to be followed by admins is documented on [another page](/process/External%20Collaborators).
## Is there any support for migrating from the git.uis.cam.ac.uk service?
......@@ -56,7 +55,7 @@ Due to the way the git.uis.cam.ac.uk service is administered, local admin users
For importing individual repositories, GitLab supports mirroring repositories between git.uis. You can set up GitLab to either sync changes from git.uis to the GitLab repo or sync changes to the GitLab repo to git.uis. See the [mirroring documentation](https://gitlab.developers.cam.ac.uk/help//workflow/repository_mirroring.md#ssh-authentication) for more details.
A one-off mirror can be performed by changing the remote of a local clone of the repository and using ``git push --mirror``:
A one-off mirror can be performed by changing the remote of a local clone of the repository and using `git push --mirror`:
```bash
$ cd path/to/repo
......@@ -78,6 +77,18 @@ Firstly, check the upstream [FAQ](https://docs.gitlab.com/runner/faq/) to see if
Within Cambridge we've also seen an issue running gitlab-runner on Windows within a folder whose name contains a space. Related upstream issue: https://gitlab.com/gitlab-org/gitlab-runner/issues/3422.
## gitlab-runner can't register with a runner registration token
The ability to pass a runner registration token, and support for certain configuration arguments was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/380872) in GitLab 15.6 and will be removed in GitLab 18.0. Runner authentication tokens should be used instead. For more information, see [Migrating to the new runner registration workflow](https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html).
For the new runner registration workflow, you:
1. [Create a runner](https://docs.gitlab.com/ee/ci/runners/runners_scope.html) directly in the GitLab UI or [programmatically](https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html#creating-runners-programmatically).
2. Receive a runner authentication token.
3. Use the runner authentication token instead of the registration token when you register a runner with this configuration. Runner managers registered in multiple hosts appear under the same runner in the GitLab UI, but with an identifying system ID.
If you use [GitLab Runner Helm Chart](https://docs.gitlab.com/runner/install/kubernetes.html), please check the [default values.yaml file](https://gitlab.com/gitlab-org/charts/gitlab-runner/blob/main/values.yaml), as a some options were deprecated.
## Is the GitLab Pages feature available?
Yes, including custom domain support and HTTPS. By default pages will appear under the `uniofcam.dev` domain (i.e. outside of `.cam.ac.uk`) in order to mitigate the risk of malicious content being posted under `.cam.ac.uk`. Custom domains may be used to host sites in `.cam.ac.uk` as per the [GitLab documentation](https://docs.gitlab.com/ee/user/project/pages/custom_domains_ssl_tls_certification/).
......@@ -108,7 +119,7 @@ We have added the service to the UIS status line at https://status.uis.cam.ac.uk
## How can I sign in with GitHub and/or import projects from GitHub?
Log into GitLab via University Account, click your avatar in the top-right and navigate to "Settings > Account > Social Sign-In". Click "connect" next to the GitHub icon. You will then be redirected to GitHub which will confirm your permission for the GitLab to access some details from your GitHub account.
Log into GitLab via University Account, click your avatar in the top-right and navigate to "Settings \> Account \> Social Sign-In". Click "connect" next to the GitHub icon. You will then be redirected to GitHub which will confirm your permission for the GitLab to access some details from your GitHub account.
After connecting your account to GitHub you can also sign in with your GitHub account from the front page. To import projects from GitHub, follow the [GitLab documentation](https://docs.gitlab.com/ee/user/project/import/github.html) for importing projects.
......
......