fix: address Andre's review comments
- Update copyright year from 2024 to 2026 across all new source files - Clear alpha entry point (no alpha exports needed for a net-new package) and regenerate report-alpha.api.md accordingly - Delete CHANGELOG.md (auto-generated by the release process) - Change changeset bump from patch to minor so the first release is 0.1.0, and remove the redundant "New package:" title line - Reset package version to 0.0.0 (release process sets the real version) - Add incremental ingestion section to docs/integrations/azure/org.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: pillaris <pillaris@adobe.com>
This commit is contained in:
@@ -50,6 +50,37 @@ backend.add(import('@backstage/plugin-catalog-backend-module-msgraph'));
|
||||
/* highlight-add-end */
|
||||
```
|
||||
|
||||
## Incremental Ingestion for Large Tenants
|
||||
|
||||
For very large Azure AD tenants where loading the full dataset into memory at once is not feasible, the `@backstage/plugin-catalog-backend-module-msgraph-incremental` package provides a memory-efficient alternative. It processes users and groups one page at a time and persists the `@odata.nextLink` cursor so ingestion resumes from the last completed page after a pod restart.
|
||||
|
||||
```bash title="From your Backstage root directory"
|
||||
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-incremental-ingestion
|
||||
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph-incremental
|
||||
```
|
||||
|
||||
```ts title="packages/backend/src/index.ts"
|
||||
backend.add(import('@backstage/plugin-catalog-backend'));
|
||||
/* highlight-add-start */
|
||||
backend.add(
|
||||
import('@backstage/plugin-catalog-backend-module-incremental-ingestion'),
|
||||
);
|
||||
backend.add(
|
||||
import('@backstage/plugin-catalog-backend-module-msgraph-incremental'),
|
||||
);
|
||||
/* highlight-add-end */
|
||||
```
|
||||
|
||||
It uses the same `catalog.providers.microsoftGraphOrg` configuration as the standard module. The following options are **not** supported by the incremental provider: `userGroupMember*` and `groupIncludeSubGroups`. Use `MicrosoftGraphOrgEntityProvider` if you require those.
|
||||
|
||||
| | `MicrosoftGraphOrgEntityProvider` | Incremental provider |
|
||||
| -------------------------- | --------------------------------- | -------------------- |
|
||||
| Memory usage | Full dataset in RAM | One page at a time |
|
||||
| Resume on restart | Starts from scratch | Resumes from cursor |
|
||||
| `userGroupMember*` options | Supported | Not supported |
|
||||
| `groupIncludeSubGroups` | Supported | Not supported |
|
||||
| Suitable for large tenants | No | Yes |
|
||||
|
||||
## Authenticating with Microsoft Graph
|
||||
|
||||
### Local Development
|
||||
|
||||
Reference in New Issue
Block a user