goharbor/harbor

Replication filter - exclude by name/label

Open

#20,875 opened on Aug 23, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Go (28,490 stars) (5,235 forks)batch import
help wantedkind/requirement

Description

Is your feature request related to a problem? Please describe.

I want to exclude images in a specific repo from being replicated, while all other images can be replicated as usual. However:

  1. Name doesn't support excluding.
  2. We cannot change Tag as we use its format for other purpose.
  3. Excluding Label doesn't work as expected: it seems I have to push the image first and then add a label to the image. But before I add a label, the image push event already triggers a replication task and starts the replication.

I'm using push-based, event-based replication.

Describe the solution you'd like

  1. Support excluding Name in replication source filter. (ideally)
  2. Or make excluding Label work in push-based, event-based replication. (as suggested in https://github.com/goharbor/harbor/issues/20253#issuecomment-2054062267, which doesn't quite work in my experiment).

Describe the main design/architecture of your solution A clear and concise description of what does your solution look like. Rich text and diagrams are preferred.

Describe the development plan you've considered A clear and concise description of the plan to make the solution ready. It can include a development timeline, resource estimation, and other related things.

Additional context Add any other context or screenshots about the feature request here.

Contributor guide

Tech stack
godocker
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
GoHarbor replication architectureDocker registry concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Research the existing replication filter implementation in Harbor, specifically the Name and Label filters in the replication source filter logic. Investigate how push based replication triggers and examine the code path to understand why excluding labels does not work in that context. Review the linked issue #20253 for additional context and any proposed solutions. Focus on the files under 'src/pkg/reg/filter/' or similar to identify where changes are needed.