Merge branch 'master' into feat/mirror-group-member-relation

docs/integrations/gitlab/discovery.md

@@ -20,8 +20,7 @@ This provider can also be configured to ingest GitLab data based on [GitLab Webh
 As this provider is not one of the default providers, you will first need to install
 the gitlab catalog plugin:
 
-```bash
-# From your Backstage root directory
+```bash title="From your Backstage root directory"
 yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab
 ```
 
@@ -154,6 +153,7 @@ catalog:
         group: example-group # Optional. Group and subgroup (if needed) to look for repositories. If not present the whole instance will be scanned
         entityFilename: catalog-info.yaml # Optional. Defaults to `catalog-info.yaml`
         projectPattern: '[\s\S]*' # Optional. Filters found projects based on provided patter. Defaults to `[\s\S]*`, which means to not filter anything
+        excludeRepos: [] # Optional. A list of project paths that should be excluded from discovery, e.g. group/subgroup/repo. Should not start or end with a slash.
         schedule: # Same options as in TaskScheduleDefinition. Optional for the Legacy Backend System
           # supports cron, ISO duration, "human duration" as used in code
           frequency: { minutes: 30 }

docs/integrations/gitlab/org.md

@@ -25,8 +25,7 @@ This provider can also be configured to ingest GitLab data based on [GitLab Syst
 
 As this provider is not one of the default providers, you will first need to install the Gitlab provider plugin:
 
-```bash
-# From your Backstage root directory
+```bash title="From your Backstage root directory"
 yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab @backstage/plugin-catalog-backend-module-gitlab-org
 ```
 
@@ -225,11 +224,24 @@ Refer to the [GitLab Group Member Relation](https://docs.gitlab.com/ee/api/graph
 
 ### Users
 
-For self hosted, all `User` entities are ingested from the entire instance.
+For self hosted, all `User` entities are ingested from the entire instance by default.
 
 For gitlab.com `User` entities for users who have [direct or inherited membership](https://docs.gitlab.com/ee/user/project/members/index.html#membership-types)
 of the top-level group for the configured group path will be ingested.
 
+In both cases (SaaS & self hosted), you can limit the ingested users to users directly assigned to the group defined in your `app-config.yaml` by setting the configuration key `restrictUsersToGroup: true`. This is especially useful when you have a large user base that you don't want to import by default.
+
+```yaml
+catalog:
+  providers:
+    gitlab:
+      yourProviderId:
+        host: gitlab.com ## Could also be self hosted.
+        orgEnabled: true
+        group: org/teams # Required for gitlab.com when `orgEnabled: true`. Optional for self managed. Must not end with slash. Accepts only groups under the provided path (which will be stripped)
+        restrictUsersToGroup: true # Backstage will ingest only users directly assigned to org/teams.
+```
+
 ### Limiting `User` and `Group` entity ingestion in the provider
 
 Optionally, you can limit the entity types ingested by the provider when using