Skip to main content

Import your GitLab groups

Your GitLab groups can come into the catalog, with their members.

A component can then name a real GitLab group as its owner.

👥 Turn on the import​

  1. Open Administration › Catalog, then Configure on the GitLab card.

  2. Tick Import GitLab groups and their members.

  3. Click Install, or Update Configuration if the provider was already installed.

  4. In the Catalog collection table, on the GitLab (groups and users) row, click the play button (Run the GitLab groups and users collection now).

  5. Reload the page. State says Done. Detail says what came in, for example 3 groups and 1 user imported.

Your groups are in Catalog, on the Groups tab.

Which groups come in​

It depends on the Group field.

GroupGroups imported
A group, for example acmeacme and all its subgroups, at every level
EmptyEvery group of your GitLab, all top-level groups included. Self-managed GitLab only.

Other fields of the same form narrow or widen the import:

FieldWhat it does
Group RegexOnly the groups whose full path matches, for example ^acme/team-.*. Empty: all of them.
User RegexOnly the users whose username matches. Empty: all of them.
Restrict Users to GroupOnly the users of this group path, for example acme/staff.
Allow Inherited MembershipsAlso counts a person as a member of a subgroup when they belong to a parent group.
Include Users Without a SeatAlso imports users who take no paid seat.
Import RelationsLinks each group to its parent and to its members in the catalog.
Several top-level groups?

Your teams are spread over several top-level groups, with no common parent? Leave Group empty: they all come in.

On gitlab.com, Group is required

Without a group, it would be every public group of gitlab.com. Astrolabe refuses, under the field:

On gitlab.com, importing GitLab groups needs a Group: without one it would be every public group of gitlab.com. Enter your top-level group (for example acme); its subgroups come with it.

Two rules from Backstage​

A group with no direct member is not imported

A group whose people are only members of its subgroups, or of its parent, does not appear.

A name is 63 characters at most

A longer group path is refused. The group is missing from the catalog.

✅ That's it!

Now give each component its owner.