add customizations for source.toolkit.fluxcd.io/v1/GitRepository #3481

yike21 · 2023-04-28T07:43:02Z

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
Add third-party resources source.toolkit.fluxcd.io/v1/GitRepository into Resource Interpreter framework.

Which issue(s) this PR fixes:
Part of #3331

Special notes for your reviewer:
@Poor12

Does this PR introduce a user-facing change?:
NONE

`Resource Interpreter`: Support `source.toolkit.fluxcd.io/v1/GitRepository`

yike21 · 2023-04-29T05:15:03Z

...rdparty/resourcecustomizations/source.toolkit.fluxcd.io/v1/GitRepository/customizations.yaml

+        end
+    dependencyInterpretation:
+      luaScript: >
+        function GetDependencies(desiredObj)


.status.verify specifies the configuration ( which includes secretRef that specifies the secret containing the public keys of trusted Git authors ) to verify the Git commit signature(s), it need to be propagated as dependencies.

yike21 · 2023-04-30T07:50:56Z

...rdparty/resourcecustomizations/source.toolkit.fluxcd.io/v1/GitRepository/customizations.yaml

+            if statusItems[i].status ~= nil and statusItems[i].status.artifact ~= nil then
+              artifact = statusItems[i].status.artifact
+            end
+            if statusItems[i].status ~= nil and statusItems[i].status.lastHandledReconcileAt ~= nil then


This line should be if statusItems[i].status ~= nil and statusItems[i].status.lastHandledReconcileAt ~= nil and statusItems[i].status.lastHandledReconcileAt ~= '' then

yike21 · 2023-05-01T08:06:12Z

...rdparty/resourcecustomizations/source.toolkit.fluxcd.io/v1/GitRepository/customizations.yaml

+            if statusItems[i].status ~= nil and statusItems[i].status.conditions ~= nil then
+              for conditionIndex = 1, #statusItems[i].status.conditions do
+                statusItems[i].status.conditions[conditionIndex].message = statusItems[i].clusterName..': '..statusItems[i].status.conditions[conditionIndex].message
+                conditions[conditionsIndex] = statusItems[i].status.conditions[conditionIndex]
+                conditionsIndex = conditionsIndex + 1
+              end
+            end


Suggested change

if statusItems[i].status ~= nil and statusItems[i].status.conditions ~= nil then

for conditionIndex = 1, #statusItems[i].status.conditions do

statusItems[i].status.conditions[conditionIndex].message = statusItems[i].clusterName..': '..statusItems[i].status.conditions[conditionIndex].message

conditions[conditionsIndex] = statusItems[i].status.conditions[conditionIndex]

conditionsIndex = conditionsIndex + 1

end

end

if statusItems[i].status ~= nil and statusItems[i].status.conditions ~= nil then

for conditionIndex = 1, #statusItems[i].status.conditions do

statusItems[i].status.conditions[conditionIndex].message = statusItems[i].clusterName..'='..statusItems[i].status.conditions[conditionIndex].message

hasCondition = false

for index = 1, #conditions do

if conditions[index].type == statusItems[i].status.conditions[conditionIndex].type and conditions[index].status == statusItems[i].status.conditions[conditionIndex].status and conditions[index].reason == statusItems[i].status.conditions[conditionIndex].reason then

conditions[index].message = conditions[index].message..', '..statusItems[i].status.conditions[conditionIndex].message

hasCondition = true

break

end

end

if not hasCondition then

conditions[conditionsIndex] = statusItems[i].status.conditions[conditionIndex]

conditionsIndex = conditionsIndex + 1

end

end

end

Signed-off-by: yike21 <yike21@qq.com>

yike21 · 2023-05-01T10:27:08Z

The test report base on karmadactl interpret is below:

### Check the customizations in file
$ karmadactl interpret -f customizations.yaml --check
I0501 18:22:02.893531 1118647 deploy.go:75] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:22:02.893685 1118647 enable_option.go:63] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:22:02.903587 1118647 cmdinit.go:149] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:22:02.903708 1118647 register.go:160] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
-----------------------------------
SOURCE: declarative-configuration-gitrepository
TARGET: source.toolkit.fluxcd.io/v1 GitRepository   
RULERS:
    Retain:                                         PASS
    InterpretReplica:                               UNSET
    ReviseReplica:                                  UNSET
    InterpretStatus:                                PASS
    AggregateStatus:                                PASS
    InterpretHealth:                                PASS
    InterpretDependency:                            PASS

### Execute the retention rule
$ karmadactl interpret -f customizations.yaml --operation retain --desired-file testdata/desired-gitrepository.yaml --observed-file testdata/observed-gitrepository.yaml 
I0501 18:23:02.596727 1119447 deploy.go:75] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:02.596851 1119447 enable_option.go:63] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:02.605085 1119447 cmdinit.go:149] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:02.605226 1119447 register.go:160] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
---
# [1/1] retained:
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
    name: sample
    namespace: test-gitrepository
spec:
    interval: 30s
    ref:
        branch: master
    suspend: true
    url: https://github.com/stefanprodan/podinfo

### Execute the statusReflection rule
$ karmadactl interpret -f customizations.yaml --operation interpretStatus --observed-file testdata/observed-gitrepository.yaml 
I0501 18:23:21.964873 1119700 deploy.go:75] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:21.965068 1119700 enable_option.go:63] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:21.976390 1119700 cmdinit.go:149] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:21.976500 1119700 register.go:160] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
---
# [1/1] status:
artifact:
    digest: sha256:a375b2ca68275734e3850d3c80e0bc20c1d7a4daa1a9717056d5c0c563ea0719
    lastUpdateTime: "2023-05-01T10:17:09Z"
    path: gitrepository/test-gitrepository/sample/0647aea75b85755411b007a290b9321668370be5.tar.gz
    revision: master@sha1:0647aea75b85755411b007a290b9321668370be5
    size: 83516
    url: http://source-controller.flux-system.svc.cluster.local./gitrepository/test-gitrepository/sample/0647aea75b85755411b007a290b9321668370be5.tar.gz
conditions:
    - lastTransitionTime: "2023-05-01T10:17:09Z"
      message: stored artifact for revision 'master@sha1:0647aea75b85755411b007a290b9321668370be5'
      observedGeneration: 1
      reason: Succeeded
      status: "True"
      type: Ready
    - lastTransitionTime: "2023-05-01T10:17:09Z"
      message: stored artifact for revision 'master@sha1:0647aea75b85755411b007a290b9321668370be5'
      observedGeneration: 1
      reason: Succeeded
      status: "True"
      type: ArtifactInStorage

### Execute the healthInterpretation rule
$ karmadactl interpret -f customizations.yaml --operation interpretHealth --observed-file testdata/observed-gitrepository.yaml 
I0501 18:23:50.093029 1120087 deploy.go:75] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:50.093175 1120087 enable_option.go:63] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:50.102565 1120087 cmdinit.go:149] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:23:50.102664 1120087 register.go:160] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
---
# [1/1] healthy:
true

### Execute the dependencyInterpretation rule
$ karmadactl interpret -f customizations.yaml --operation interpretDependency --observed-file testdata/observed-gitrepository.yaml 
I0501 18:24:15.300776 1120426 deploy.go:75] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:24:15.300921 1120426 enable_option.go:63] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:24:15.311511 1120426 cmdinit.go:149] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:24:15.311610 1120426 register.go:160] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
---
# [1/1] dependencies:
- apiVersion: v1
  kind: Secret
  name: fake-secret
  namespace: test-gitrepository

### Execute the statusAggregation rule
$ karmadactl interpret -f customizations.yaml --operation aggregateStatus --observed-file testdata/observed-gitrepository.yaml --status-file testdata/status-file.yaml 
I0501 18:24:35.041465 1120688 deploy.go:75] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:24:35.041669 1120688 enable_option.go:63] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:24:35.053728 1120688 cmdinit.go:149] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
I0501 18:24:35.053855 1120688 register.go:160] No default release version found. build version: version.Info{GitVersion:"", GitCommit:"c8720e81c7f4badb2a2e07ed7218391b3ea7d912", GitTreeState:"dirty", BuildDate:"2023-04-12T09:43:27Z", GoVersion:"go1.19.7", Compiler:"gc", Platform:"linux/amd64"}
---
# [1/1] aggregatedStatus:
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
    name: sample
    namespace: test-gitrepository
spec:
    interval: 30s
    ref:
        branch: master
    secretRef:
        name: fake-secret
    suspend: true
    timeout: 60s
    url: https://github.com/stefanprodan/podinfo
status:
    artifact:
        digest: sha256:a375b2ca68275734e3850d3c80e0bc20c1d7a4daa1a9717056d5c0c563ea0719
        lastUpdateTime: "2023-05-01T10:17:08Z"
        path: gitrepository/test-gitrepository/sample/0647aea75b85755411b007a290b9321668370be5.tar.gz
        revision: master@sha1:0647aea75b85755411b007a290b9321668370be5
        size: 83516
        url: http://source-controller.flux-system.svc.cluster.local./gitrepository/test-gitrepository/sample/0647aea75b85755411b007a290b9321668370be5.tar.gz
    conditions:
        - lastTransitionTime: "2023-05-01T10:17:09Z"
          message: member1=stored artifact for revision 'master@sha1:0647aea75b85755411b007a290b9321668370be5', member3=stored artifact for revision 'master@sha1:0647aea75b85755411b007a290b9321668370be5'
          observedGeneration: 1
          reason: Succeeded
          status: "True"
          type: Ready
        - lastTransitionTime: "2023-05-01T10:17:09Z"
          message: member1=stored artifact for revision 'master@sha1:0647aea75b85755411b007a290b9321668370be5', member3=stored artifact for revision 'master@sha1:0647aea75b85755411b007a290b9321668370be5'
          observedGeneration: 1
          reason: Succeeded
          status: "True"
          type: ArtifactInStorage

Poor12 · 2023-05-05T07:49:08Z

/lgtm
/approve

karmada-bot · 2023-05-05T07:49:14Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Poor12

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~pkg/resourceinterpreter/default/thirdparty/OWNERS~~ [Poor12]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

karmada-bot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Apr 28, 2023

karmada-bot requested review from chaunceyjiang and Poor12 April 28, 2023 07:43

karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 28, 2023

yike21 mentioned this pull request Apr 28, 2023

Add third-party resources into the Resource Interpreter framework #3331

Closed

17 tasks

yike21 commented Apr 29, 2023

View reviewed changes

yike21 force-pushed the bundle-fluxcd-gitrepository branch from 3afa3dd to 11d2714 Compare April 29, 2023 06:32

yike21 commented Apr 30, 2023

View reviewed changes

yike21 commented May 1, 2023

View reviewed changes

add customizations for source.toolkit.fluxcd.io/v1/GitRepository

a8f4aef

Signed-off-by: yike21 <yike21@qq.com>

yike21 force-pushed the bundle-fluxcd-gitrepository branch from 11d2714 to a8f4aef Compare May 1, 2023 10:26

karmada-bot assigned Poor12 May 5, 2023

karmada-bot added the lgtm Indicates that a PR is ready to be merged. label May 5, 2023

karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 5, 2023

karmada-bot merged commit 0d5c213 into karmada-io:master May 5, 2023

yike21 deleted the bundle-fluxcd-gitrepository branch May 6, 2023 02:06

yike21 mentioned this pull request Jun 4, 2023

REQUEST: New membership for yike21 karmada-io/community#33

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add customizations for source.toolkit.fluxcd.io/v1/GitRepository #3481

add customizations for source.toolkit.fluxcd.io/v1/GitRepository #3481

yike21 commented Apr 28, 2023 •

edited

Loading

yike21 Apr 29, 2023

yike21 Apr 30, 2023

yike21 May 1, 2023

yike21 commented May 1, 2023

Poor12 commented May 5, 2023

karmada-bot commented May 5, 2023

add customizations for source.toolkit.fluxcd.io/v1/GitRepository #3481

add customizations for source.toolkit.fluxcd.io/v1/GitRepository #3481

Conversation

yike21 commented Apr 28, 2023 • edited Loading

yike21 Apr 29, 2023

Choose a reason for hiding this comment

yike21 Apr 30, 2023

Choose a reason for hiding this comment

yike21 May 1, 2023

Choose a reason for hiding this comment

yike21 commented May 1, 2023

Poor12 commented May 5, 2023

karmada-bot commented May 5, 2023

yike21 commented Apr 28, 2023 •

edited

Loading