ocean
ocean copied to clipboard
Integration[Harbor]: initial integration [WIP]
User description
What -
- add harbor integration
Why -
- we need to sync data from harbor to port
How -
- write the integration that queries data from harbor and sends it to port.
Type of change
Please leave one option from the following and delete the rest:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] New Integration (non-breaking change which adds a new integration)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Non-breaking change (fix of existing functionality that will not change current behavior)
- [ ] Documentation (added/updated documentation)
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
Description
-
add terraform code for creating blueprints on port
-
update .port files
-
add handlers for getting data
-
add integrations
-
[ ] 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
-
Add Harbor container registry integration with support for projects, users, repositories, and artifacts
-
Implement Harbor API client with pagination and authentication handling
-
Create data handlers for filtering and mapping Harbor entities to Port format
-
Define Port blueprints and resource mappings via JSON and YAML configuration
-
Include Terraform code for automated blueprint creation in Port
Diagram Walkthrough
flowchart LR
HarborAPI["Harbor API"] -->|"Paginated Requests"| Client["HarborClient"]
Client -->|"Projects/Users/Repos/Artifacts"| Handlers["Data Handlers"]
Handlers -->|"Filter & Map"| Entities["Port Entities"]
Entities -->|"JSON/YAML Config"| Blueprints["Port Blueprints"]
Terraform["Terraform Code"] -->|"Create Resources"| Blueprints
File Walkthrough
| Relevant files | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enhancement | 11 files
| ||||||||||||||||||||||
| Configuration changes | 7 files
| ||||||||||||||||||||||
| Documentation | 5 files
| ||||||||||||||||||||||
| Tests | 1 files
| ||||||||||||||||||||||
| Additional files |