ocean
ocean copied to clipboard
Integration[Harbor]: initial integration
User description
Description
What - Harbor integration
Why - To ingests container-registry data into Port’s catalog so platform and security teams can visualize images, projects, users, and relationships across their software supply chain.
How - ocean sail
Type of change
Please leave one option from the following and delete the rest:
- [ ] New Integration (non-breaking change which adds a new integration)
All tests should be run against the port production environment(using a testing org).
Core testing checklist
- [ ] Integration able to create all default resources from scratch
- [ ] Resync finishes successfully
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Scheduled resync able to abort existing resync and start a new one
- [ ] Tested with at least 2 integrations from scratch
- [ ] Tested with Kafka and Polling event listeners
- [ ] Tested deletion of entities that don't pass the selector
Integration testing checklist
- [ ] Integration able to create all default resources from scratch
- [ ] Completed a full resync from a freshly installed integration and it completed successfully
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Resync finishes successfully
- [ ] If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the
examplesfolder in the integration directory. - [ ] If resource kind is updated, run the integration with the example data and check if the expected result is achieved
- [ ] If new resource kind is added or updated, validate that live-events for that resource are working as expected
- [ ] Docs PR link here
Preflight checklist
- [ ] Handled rate limiting
- [ ] Handled pagination
- [ ] Implemented the code in async
- [ ] Support Multi account
Screenshots
Include screenshots from your environment showing how the resources of the integration will look.
API Documentation
Provide links to the API documentation used for this integration.
PR Type
Enhancement
Description
-
Initial Harbor container registry integration for Port Ocean
-
Supports syncing projects, users, repositories, and artifacts
-
Real-time webhook support for artifact lifecycle events
-
Comprehensive filtering, pagination, and rate limiting
Diagram Walkthrough
flowchart LR
HarborAPI["Harbor API v2.0"]
Client["HarborClient<br/>Async HTTP Client"]
Resync["Resync Handlers<br/>Projects/Users/Repos/Artifacts"]
Webhooks["Webhook Processor<br/>Artifact Events"]
Port["Port Ocean<br/>Catalog"]
HarborAPI -->|"Pagination<br/>Rate Limiting"| Client
Client -->|"Fetch Resources"| Resync
Client -->|"Fetch Details"| Webhooks
Resync -->|"Sync Data"| Port
Webhooks -->|"Real-time Updates"| Port
File Walkthrough
| Relevant files | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enhancement | 6 files
| ||||||||||||||||
| Configuration changes | 8 files
| ||||||||||||||||
| Miscellaneous | 1 files
| ||||||||||||||||
| Tests | 3 files
| ||||||||||||||||
| Documentation | 4 files
| ||||||||||||||||
| Dependencies | 1 files
| ||||||||||||||||
| Additional files |