Add Skip if running checkbox in replication & update swagger

* Adds Checkbox in replication policy UI * Updates swagger & sql schema Signed-off-by: bupd <bupdprasanth@gmail.com>
goharbor · Dec 22, 2024 · 12afc5c · 12afc5c
1 parent a533043
commit 12afc5c
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 2 deletions.
diff --git a/api/v2.0/swagger.yaml b/api/v2.0/swagger.yaml
@@ -7488,6 +7488,10 @@ definitions:
         type: boolean
         description: Whether to enable copy by chunk.
         x-isnullable: true
+      skip_if_running:
+        type: boolean
+        description: Whether to enable skip, if replication already running.
+        x-isnullable: true # make this field optional to keep backward compatibility
   ReplicationTrigger:
     type: object
     properties:

diff --git a/make/migrations/postgresql/0160_2.13.0_schema.up.sql b/make/migrations/postgresql/0160_2.13.0_schema.up.sql
@@ -1,2 +1,3 @@
 ALTER TABLE p2p_preheat_policy DROP COLUMN IF EXISTS scope;
 ALTER TABLE p2p_preheat_policy ADD COLUMN IF NOT EXISTS extra_attrs text;
+ALTER TABLE replication_policy ADD COLUMN IF NOT EXISTS skip_if_running boolean;
diff --git a/...se/left-side-nav/replication/replication/create-edit-rule/create-edit-rule.component.html b/...se/left-side-nav/replication/replication/create-edit-rule/create-edit-rule.component.html
@@ -825,6 +825,31 @@ <h3 class="modal-title">{{ headerTitle | translate }}</h3>
                             'REPLICATION.ENABLED_RULE' | translate
                         }}</label>
                     </div>
+                    <div class="clr-checkbox-wrapper">
+                        <input
+                            type="checkbox"
+                            class="clr-checkbox"
+                            [checked]="true"
+                            id="skipIfRunning"
+                            formControlName="skip_if_running" />
+                        <label for="skipIfRunning" class="clr-control-label"
+                            >{{ 'REPLICATION.SKIP_IF_RUNNING' | translate }}
+                            <clr-tooltip class="override-tooltip">
+                                <clr-icon
+                                    clrTooltipTrigger
+                                    shape="info-circle"
+                                    size="24"></clr-icon>
+                                <clr-tooltip-content
+                                    clrPosition="top-left"
+                                    clrSize="md"
+                                    *clrIfOpen>
+                                    <span>{{
+                                        'TOOLTIP.SKIP_IF_RUNNING' | translate
+                                    }}</span>
+                                </clr-tooltip-content>
+                            </clr-tooltip>
+                        </label>
+                    </div>
                 </div>
             </div>
         </form>

diff --git a/...base/left-side-nav/replication/replication/create-edit-rule/create-edit-rule.component.ts b/...base/left-side-nav/replication/replication/create-edit-rule/create-edit-rule.component.ts
@@ -334,6 +334,7 @@ export class CreateEditRuleComponent implements OnInit, OnDestroy {
             override: true,
             speed: -1,
             copy_by_chunk: false,
+            skip_if_running: false,
         });
     }
 
@@ -367,6 +368,7 @@ export class CreateEditRuleComponent implements OnInit, OnDestroy {
             dest_namespace_replace_count: Flatten_Level.FLATTEN_LEVEl_1,
             speed: -1,
             copy_by_chunk: false,
+            skip_if_running: false,
         });
         this.isPushMode = true;
         this.selectedUnit = BandwidthUnit.KB;
@@ -410,6 +412,7 @@ export class CreateEditRuleComponent implements OnInit, OnDestroy {
                 override: rule.override,
                 speed: speed,
                 copy_by_chunk: rule.copy_by_chunk,
+                skip_if_running: rule.skip_if_running,
             });
             let filtersArray = this.getFilterArray(rule);
             this.noSelectedEndpoint = false;

diff --git a/src/portal/src/i18n/lang/de-de-lang.json b/src/portal/src/i18n/lang/de-de-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "Lade die Ressourcen von der entfernten Registry auf den lokalen Harbor runter.",
         "DESTINATION_NAMESPACE": "Spezifizieren des Ziel-Namespace. Wenn das Feld leer ist, werden die Ressourcen unter dem gleichen Namespace abgelegt wie in der Quelle.",
         "OVERRIDE": "Spezifizieren, ob die Ressourcen am Ziel überschrieben werden sollen, falls eine Ressource mit gleichem Namen existiert.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "E-Mail sollte eine gültige E-Mail-Adresse wie name@example.com sein.",
         "USER_NAME": "Darf keine Sonderzeichen enthalten und sollte kürzer als 255 Zeichen sein.",
         "FULL_NAME": "Maximale Länge soll 20 Zeichen sein.",
@@ -560,6 +561,7 @@
         "ALLOWED_CHARACTERS": "Erlaubte Sonderzeichen",
         "TOTAL": "Gesamt",
         "OVERRIDE": "Überschreiben",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "Aktiviere Regel",
         "OVERRIDE_INFO": "Überschreiben",
         "OPERATION": "Operation",

diff --git a/src/portal/src/i18n/lang/en-us-lang.json b/src/portal/src/i18n/lang/en-us-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "Pull the resources from the remote registry to the local Harbor.",
         "DESTINATION_NAMESPACE": "Specify the destination namespace. If empty, the resources will be put under the same namespace as the source.",
         "OVERRIDE": "Specify whether to override the resources at the destination if a resource with the same name exists.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "Email should be a valid email address like name@example.com.",
         "USER_NAME": "Cannot contain special characters and maximum length should be 255 characters.",
         "FULL_NAME": "Maximum length should be 20 characters.",
@@ -560,6 +561,7 @@
         "ALLOWED_CHARACTERS": "Allowed special characters",
         "TOTAL": "Total",
         "OVERRIDE": "Override",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "Enable rule",
         "OVERRIDE_INFO": "Override",
         "OPERATION": "Operation",

diff --git a/src/portal/src/i18n/lang/es-es-lang.json b/src/portal/src/i18n/lang/es-es-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "Pull the resources from the remote registry to the local Harbor.",
         "DESTINATION_NAMESPACE": "Specify the destination namespace. If empty, the resources will be put under the same namespace as the source.",
         "OVERRIDE": "Specify whether to override the resources at the destination if a resource with the same name exists.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "El email debe ser una dirección válida como nombre@ejemplo.com.",
         "USER_NAME": "Debe tener una longitud máxima de 255 caracteres y no puede contener caracteres especiales.",
         "FULL_NAME": "La longitud máxima debería ser de 20 caracteres.",
@@ -560,6 +561,7 @@
         "ALLOWED_CHARACTERS": "Allowed special characters",
         "TOTAL": "Total",
         "OVERRIDE": "Override",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "Enable rule",
         "OVERRIDE_INFO": "Override",
         "CURRENT": "current",

diff --git a/src/portal/src/i18n/lang/fr-fr-lang.json b/src/portal/src/i18n/lang/fr-fr-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "Pull les ressources du registre distant vers le Harbor local.",
         "DESTINATION_NAMESPACE": "Spécifier l'espace de nom de destination. Si vide, les ressources seront placées sous le même espace de nom que la source.",
         "OVERRIDE": "Spécifier s'il faut remplacer les ressources dans la destination si une ressource avec le même nom existe.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "L'e-mail doit être une adresse e-mail valide comme name@example.com.",
         "USER_NAME": "Ne peut pas contenir de caractères spéciaux et la longueur maximale est de 255 caractères.",
         "FULL_NAME": "La longueur maximale est de 20 caractères.",
@@ -560,6 +561,7 @@
         "ALLOWED_CHARACTERS": "Caractères spéciaux autorisés",
         "TOTAL": "Total",
         "OVERRIDE": "Surcharger",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "Activer la règle",
         "OVERRIDE_INFO": "Surcharger",
         "OPERATION": "Opération",

diff --git a/src/portal/src/i18n/lang/ko-kr-lang.json b/src/portal/src/i18n/lang/ko-kr-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "원격 레지스트리의 리소스를 로컬 'Harbor'로 가져옵니다.",
         "DESTINATION_NAMESPACE": "대상 네임스페이스를 지정합니다. 비어 있으면 리소스는 소스와 동일한 네임스페이스에 배치됩니다.",
         "OVERRIDE": "동일한 이름의 리소스가 있는 경우 대상의 리소스를 재정의할지 여부를 지정합니다.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "이메일은 name@example.com과 같은 유효한 이메일 주소여야 합니다.",
         "USER_NAME": "특수 문자를 포함할 수 없으며 최대 길이는 255자입니다.",
         "FULL_NAME": "최대 길이는 20자입니다.",
@@ -557,6 +558,7 @@
         "ALLOWED_CHARACTERS": "허용되는 특수 문자",
         "TOTAL": "총",
         "OVERRIDE": "Override",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "규칙 활성화",
         "OVERRIDE_INFO": "Override",
         "OPERATION": "작업",

diff --git a/src/portal/src/i18n/lang/pt-br-lang.json b/src/portal/src/i18n/lang/pt-br-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "Trazer recursos do repositório remoto para o Harbor local.",
         "DESTINATION_NAMESPACE": "Especificar o namespace de destino. Se vazio, os recursos serão colocados no mesmo namespace que a fonte.",
         "OVERRIDE": "Sobrescrever recursos no destino se já existir com o mesmo nome.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "Deve ser um endereço de e-mail válido como nome@exemplo.com.",
         "USER_NAME": "Não pode conter caracteres especiais. Tamanho máximo de 255 caracteres.",
         "FULL_NAME": "Tamanho máximo de 20 caracteres.",
@@ -558,6 +559,7 @@
         "ALLOWED_CHARACTERS": "Símbolos permitidos",
         "TOTAL": "Total",
         "OVERRIDE": "Sobrescrever",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "Habiltar regra",
         "OVERRIDE_INFO": "Sobrescrever",
         "CURRENT": "atual",

diff --git a/src/portal/src/i18n/lang/tr-tr-lang.json b/src/portal/src/i18n/lang/tr-tr-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "Kaynakları uzak kayıt defterinden yerel Harbora çekin.",
         "DESTINATION_NAMESPACE": "Hedef ad alanını belirtin. Boşsa, kaynaklar, kaynak ile aynı ad alanına yerleştirilir.",
         "OVERRIDE": "Aynı adı taşıyan bir kaynak varsa, hedefteki kaynakları geçersiz kılmayacağınızı belirtin.",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "E-posta, ad@example.com gibi geçerli bir e-posta adresi olmalıdır.",
         "USER_NAME": "Özel karakterler içeremez ve maksimum uzunluk 255 karakter olmalıdır.",
         "FULL_NAME": "Maksimum uzunluk 20 karakter olmalıdır.",
@@ -560,6 +561,7 @@
         "ALLOWED_CHARACTERS": "İzin verilen özel karakterler",
         "TOTAL": "Toplam",
         "OVERRIDE": "Geçersiz Kıl",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "Kuralı etkinleştir",
         "OVERRIDE_INFO": "Geçersiz Kıl",
         "OPERATION": "Operasyon",

diff --git a/src/portal/src/i18n/lang/zh-cn-lang.json b/src/portal/src/i18n/lang/zh-cn-lang.json
@@ -76,6 +76,7 @@
         "PULL_BASED": "把资源由远端仓库拉取到本地Harbor。",
         "DESTINATION_NAMESPACE": "指定目标名称空间。如果不填，资源会被放到和源相同的名称空间下。",
         "OVERRIDE": "如果存在具有相同名称的资源，请指定是否覆盖目标上的资源。",
+        "SKIP_IF_RUNNING": "Specify whether to skip the execution when replication already running.",
         "EMAIL": "请使用正确的邮箱地址，比如name@example.com。",
         "USER_NAME": "不能包含特殊字符且长度不能超过255。",
         "FULL_NAME": "长度不能超过20。",
@@ -558,6 +559,7 @@
         "ALLOWED_CHARACTERS": "允许的特殊字符",
         "TOTAL": "总数",
         "OVERRIDE": "覆盖",
+        "SKIP_IF_RUNNING": "Skip if running",
         "ENABLED_RULE": "启用规则",
         "OVERRIDE_INFO": "覆盖",
         "CURRENT": "当前仓库",

diff --git a/tests/apitests/python/test_system_permission.py b/tests/apitests/python/test_system_permission.py
@@ -148,7 +148,8 @@ def call(self):
     "deletion": False,
     "override": True,
     "speed": -1,
-    "copy_by_chunk": False
+    "copy_by_chunk": False,
+    "skip_if_running": False
 }
 create_replication_policy = Permission("{}/replication/policies".format(harbor_base_url), "POST", 201, replication_policy_payload, "id", id_from_header=True)
 list_replication_policy = Permission("{}/replication/policies".format(harbor_base_url), "GET", 200, replication_policy_payload)
@@ -201,7 +202,8 @@ def call(self):
         "deletion": False,
         "override": True,
         "speed": -1,
-        "copy_by_chunk": False
+        "copy_by_chunk": False,
+        "skip_if_running": False
     }
     response = requests.post("{}/replication/policies".format(harbor_base_url), data=json.dumps(replication_policy_payload), verify=False, auth=(admin_user_name, admin_password), headers={"Content-Type": "application/json"})
     replication_policy_id = int(response.headers["Location"].split("/")[-1])