ocean icon indicating copy to clipboard operation
ocean copied to clipboard

Integration[Harbor]: initial integration [WIP]

Open davidshare opened this issue 3 weeks ago • 2 comments

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 examples folder 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
client.py
Harbor API client with pagination support                               
+139/-0 
config.py
Configuration models for Harbor integration                           
+23/-0   
models.py
Pydantic models for Harbor entities                                           
+251/-0 
projects.py
Handler for retrieving and filtering projects                       
+79/-0   
repositories.py
Handler for retrieving and filtering repositories               
+59/-0   
artifacts.py
Handler for retrieving and filtering artifacts                     
+103/-0 
users.py
Handler for retrieving and filtering users                             
+47/-0   
__init__.py
Export handlers for integration                                                   
+6/-0     
integration.py
Harbor integration base class and kinds                                   
+24/-0   
main.py
Main integration entry point with resync handlers               
+68/-0   
debug.py
Debug script for local development                                             
+4/-0     
Configuration changes
7 files
blueprints.json
Port blueprint definitions for Harbor entities                     
+234/-0 
port-app-config.yml
Port app configuration with entity mappings                           
+84/-0   
spec.yaml
Integration specification and configuration schema             
+55/-0   
blueprints.tf
Terraform resources for Harbor blueprints                               
+134/-0 
main.tf
Terraform provider configuration                                                 
+14/-0   
variables.tf
Terraform variables for Port credentials                                 
+21/-0   
pyproject.toml
Python project dependencies and configuration                       
+114/-0 
Documentation
5 files
secrets.tfvars.example
Example Terraform secrets file                                                     
+2/-0     
.env.example
Example environment variables for integration                       
+6/-0     
README.md
Integration documentation and usage guide                               
+7/-0     
CONTRIBUTING.md
Contributing guidelines for Harbor integration                     
+7/-0     
CHANGELOG.md
Changelog for version tracking                                                     
+8/-0     
Tests
1 files
test_sample.py
Sample test file for integration                                                 
+2/-0     
Additional files
8 files
settings.json +3/-0     
Makefile +1/-0     
__init__.py [link]   
__init__.py [link]   
poetry.toml +3/-0     
sonar-project.properties +2/-0     
README.md +18/-0   
__init__.py [link]   

davidshare avatar Nov 07 '25 20:11 davidshare