ahmido/TenantAtlas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

docs: validate quickstart workflow

Browse Source
This commit is contained in:
Ahmed Darrazi 2026-01-11 22:38:48 +01:00
parent e010b5e240
commit f935aeb2f3
2 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
specs/051-entra-group-directory-cache/quickstart.md
View File

@ -5,20 +5,38 @@ ## Goal
## Prerequisites ## Prerequisites
- Graph integration configured (client credentials / app-only) - Graph integration configured (client credentials / app-only)
- Queue worker running for jobs - Database migrated (feature migrations applied)
- Scheduler/cron running for periodic sync (if enabled) - Queue worker running for jobs (required for sync)
- Scheduler/cron running for periodic sync (optional, if enabled)
### Local (Sail) quick commands
- Bring containers up: `./vendor/bin/sail up -d`
- Run migrations: `./vendor/bin/sail artisan migrate`
- Run the queue worker (separate terminal): `./vendor/bin/sail artisan queue:work`
- Run the scheduler loop (separate terminal, optional): `./vendor/bin/sail artisan schedule:work`
## Operator workflow (manual) ## Operator workflow (manual)
1. Switch into a tenant workspace. 1. Switch into a tenant workspace.
2. Start “Sync Groups”. 2. Go to **Directory → Group Sync Runs**.
3. Check the run status until it completes. 3. Click **Sync Groups** (creates/reuses a run and dispatches a background job).
4. Browse “Directory → Groups” and confirm search + detail work. 4. Open the run and wait for status to complete.
5. Go to **Directory → Groups** and confirm list/search/detail are populated from the cache.
Notes
- Search is cached-only and typically requires at least 2 characters.
- If the cache is empty, the Groups list will be empty until a sync completes.
## Scheduled sync ## Scheduled sync
- Enable scheduled sync for tenants/environment. - Ensure the scheduler is running (cron or `schedule:work`).
- Verify runs appear without manual initiation. - Verify **Directory → Group Sync Runs** shows runs with empty Initiator (scheduled).
- The dispatcher command is `tenantpilot:directory-groups:dispatch` (configured to run every minute).
## Verification ## Verification
- UI pages that show group IDs render using cached data only. - UI pages that show group IDs render using cached data only.
- Unresolved IDs show a clear fallback. - Unresolved IDs show a clear fallback.
- Groups not seen for >90 days are eventually purged. - Groups not seen for >90 days are eventually purged.
Suggested validation checks
- `./vendor/bin/sail artisan migrate:status | grep entra_group`
- `./vendor/bin/sail artisan schedule:list | grep directory-groups`

2
specs/051-entra-group-directory-cache/tasks.md
View File

@ -132,7 +132,7 @@ ## Phase 6: Polish & Cross-Cutting Concerns
- [x] T033 [P] Run formatting on changed files with vendor/bin/pint --dirty - [x] T033 [P] Run formatting on changed files with vendor/bin/pint --dirty
- [x] T034 Run targeted Pest suite for this feature (e.g., php artisan test tests/Feature/DirectoryGroups and tests/Unit/DirectoryGroups) - [x] T034 Run targeted Pest suite for this feature (e.g., php artisan test tests/Feature/DirectoryGroups and tests/Unit/DirectoryGroups)
- [ ] T035 Validate operator workflow against specs/051-entra-group-directory-cache/quickstart.md - [x] T035 Validate operator workflow against specs/051-entra-group-directory-cache/quickstart.md
--- ---