libgit2: decommission unmanaged transport #819

aryan9600 · 2022-07-07T06:50:30Z

Decommission libgit2 unmanaged transport and remove the related feature
gate, making managed transport the only available option.

Update initRepoWithRemote() so that it overwrites the remote url with
the provided url if the remote already exists, instead of erroring out.

Attach context to http requests to enforce timeouts.

Relates to: #782
Fixes: #697 (since the flaky test was a part of the unmanaged transport)

Signed-off-by: Sanskar Jaiswal jaiswalsanskar078@gmail.com

api/v1beta2/condition_types.go

controllers/suite_test.go

pjbgf · 2022-07-07T09:04:57Z

internal/features/features.go

-
-	// GitManagedTransport implements a managed transport for GitRepository
-	// objects that use the libgit2 implementation.
-	//
-	// When enabled, improves the reliability of libgit2 reconciliations,
-	// by enforcing timeouts and ensuring libgit2 cannot hijack the process
-	// and hang it indefinitely.
-	GitManagedTransport = "GitManagedTransport"


In terms of phasing out feature gates we probably have two options:

Completely remove the option (as per the current change).

Warn an option is no longer supported and remove it a few minors down the line.

The former is the easiest, but it will cause folks upgrading with said option to fail indefinitely until they change their setup. The latter is more work, and would be needed for post GA.

Given how short-lived this feature gate was, and that we are pre-GA. I would favour the former approach, with the caveat that we should add a note on the release.

main.go

pjbgf · 2022-07-07T09:31:29Z

As part of this, we probably want to rename the tests with ManagedTransport_ as that is now the only option. And also ensure that no tests calls to InitManagedTransport(), but instead that takes place at test setup (or we just have that in init() instead).

pkg/git/libgit2/checkout.go

pkg/git/libgit2/checkout_ssh_test.go

pkg/git/libgit2/checkout_test.go

pkg/git/libgit2/managed/http.go

controllers/gitrepository_controller.go

aryan9600 · 2022-07-08T07:00:32Z

This is what a GitRepository object's conditions looks like if the transports aren't enabled (manually tested by removing the call to managed.InitManagedTransport() in main.go):

Status:
  Conditions:
    Last Transition Time:  2022-07-08T05:32:43Z
    Message:               libgit2 managed transport not initialized
    Observed Generation:   1
    Reason:                Libgit2TransportNotEnabled
    Status:                True
    Type:                  Stalled
    Last Transition Time:  2022-07-08T05:32:43Z
    Message:               libgit2 managed transport not initialized
    Observed Generation:   1
    Reason:                Libgit2TransportNotEnabled
    Status:                False
    Type:                  Ready
  Observed Generation:     1
Events:
  Type     Reason                      Age   From               Message
  ----     ------                      ----  ----               -------
  Warning  Libgit2TransportNotEnabled  56m   source-controller  libgit2 managed transport not initialized

hiddeco

LGTM. Thanks @aryan9600 🙇

pjbgf

LGTM

Thanks @aryan9600 🙇

darkowlzz · 2022-07-08T09:27:30Z

We need to update the spec docs where we mention about the managed transport feature flag - Managed transport for libgit2 Git implementation .

darkowlzz · 2022-07-08T10:01:29Z

pkg/git/libgit2/checkout.go

+	// and transport level code.
+	// Performing all fetch operations with the TransportOptionsURL as the URL, lets the managed
+	// transport action use it to fetch the registered transport options which contains the
+	// _actual_ target URL and the correct credentials to use.


This description seems to be for what's happening in registerManagedTransportOptions(). It may be better to move it there.

pkg/git/libgit2/checkout.go

darkowlzz · 2022-07-08T12:48:19Z

I too did some manual testing.
I was interested in the case where SC restarts with existing GitRepos, and the transport initialization fails and what happens after another restart when it starts working again.

With an existing working GitRepo, when I restart with failing transport, the status shows:

  conditions:
  - lastTransitionTime: "2022-07-08T12:29:43Z"
    message: libgit2 managed transport not initialized
    observedGeneration: 2
    reason: Libgit2TransportNotEnabled
    status: "True"
    type: Stalled
  - lastTransitionTime: "2022-07-08T12:29:43Z"
    message: libgit2 managed transport not initialized
    observedGeneration: 2
    reason: Libgit2TransportNotEnabled
    status: "False"
    type: Ready
  - lastTransitionTime: "2022-07-08T12:16:43Z"
    message: stored artifact for revision 'master/b76b1a38c9c03c763dc56e996daf216606f4c088'
    observedGeneration: 2
    reason: Succeeded
    status: "True"
    type: ArtifactInStorage
  contentConfigChecksum: sha256:fcbcf165908dd18a9e49f7ff27810176db8e9f63b4352213741664245224f8aa
  observedGeneration: 2
  url: http://source-controller.flux-system.svc.cluster.local./gitrepository/flux-system/podinfo/latest.tar.gz

After restarting with working transport, the status shows:

  conditions:
  - lastTransitionTime: "2022-07-08T12:31:15Z"
    message: stored artifact for revision 'master/b76b1a38c9c03c763dc56e996daf216606f4c088'
    observedGeneration: 2
    reason: Succeeded
    status: "True"
    type: Ready
  - lastTransitionTime: "2022-07-08T12:16:43Z"
    message: stored artifact for revision 'master/b76b1a38c9c03c763dc56e996daf216606f4c088'
    observedGeneration: 2
    reason: Succeeded
    status: "True"
    type: ArtifactInStorage
  contentConfigChecksum: sha256:fcbcf165908dd18a9e49f7ff27810176db8e9f63b4352213741664245224f8aa
  observedGeneration: 2
  url: http://source-controller.flux-system.svc.cluster.local./gitrepository/flux-system/podinfo/latest.tar.gz

So, the conditions are handled well. But the artifact URL is advertised even when there's nothing in the storage in stalled state. This results in a kustomization that uses this GitRepo to fail with 404 status:

{"level":"error","ts":"2022-07-08T12:34:31.572Z","logger":"controller.kustomization","msg":"Reconciliation failed after 7.484495ms, next try in 5m0s","reconciler group":"kustomize.toolkit.fluxcd.io","reconciler kind":"Kustomization","name":"podinfo","namespace":"flux-system","revision":"master/b76b1a38c9c03c763dc56e996daf216606f4c088","error":"failed to download artifact from http://source-controller.flux-system.svc.cluster.local./gitrepository/flux-system/podinfo/b76b1a38c9c03c763dc56e996daf216606f4c088.tar.gz, status: 404 Not Found"}

Looks like we'll have to run reconcileStorage() before marking the object as stalled. So, maybe we should move the managed transport enabled check in reconcileSource(), that would ensure we don't advertise a non-existing artifact.

aryan9600 · 2022-07-09T13:50:41Z

Moving the managed transport enabled check to reconcileSource() addresses the issue posted above by @darkowlzz

GitRepo conditions when managed transport enabled check passes:

Status:
  Conditions:
    Last Transition Time:   2022-07-09T07:28:55Z
    Message:                stored artifact for revision 'master/6555980e9667cd46cad2b99b22d854d4fa0b087a'
    Observed Generation:    1
    Reason:                 Succeeded
    Status:                 True
    Type:                   Ready
    Last Transition Time:   2022-07-09T07:28:55Z
    Message:                stored artifact for revision 'master/6555980e9667cd46cad2b99b22d854d4fa0b087a'
    Observed Generation:    1
    Reason:                 Succeeded
    Status:                 True
    Type:                   ArtifactInStorage
  Content Config Checksum:  sha256:fcbcf165908dd18a9e49f7ff27810176db8e9f63b4352213741664245224f8aa
  Observed Generation:      1
  URL:                      http://source-controller.flux-system.svc.cluster.local./gitrepository/flux-system/bb/latest.tar.gz

GitRepo conditions after the controller restarts and the check isn't satisfied:

Status:
  Conditions:
    Last Transition Time:   2022-07-09T07:30:10Z
    Message:                libgit2 managed transport not initialized
    Observed Generation:    1
    Reason:                 Libgit2TransportNotEnabled
    Status:                 True
    Type:                   Stalled
    Last Transition Time:   2022-07-09T07:30:10Z
    Message:                libgit2 managed transport not initialized
    Observed Generation:    1
    Reason:                 Libgit2TransportNotEnabled
    Status:                 False
    Type:                   Ready

controllers/gitrepository_controller.go

pjbgf · 2022-07-14T09:43:46Z

As part of the decommissioning, we should move into using the base imagegolang-with-libgit2-only and remove the references to libssh2 and openssl from Dockerfile and Makefile.

aryan9600 · 2022-07-14T10:10:45Z

As part of the decommissioning, we should move into using the base imagegolang-with-libgit2-only and remove the references to libssh2 and openssl from Dockerfile and Makefile.

This change will be made in a follow up PR, as this PR is already targeting quite a few things now.

stefanprodan · 2022-07-14T10:48:48Z

Please hold merging until we release 0.25.10, this PR should be included in SC 0.26.0

controllers/gitrepository_controller.go

controllers/gitrepository_controller_test.go

controllers/suite_test.go

controllers/gitrepository_controller_test.go

darkowlzz

LGTM!
Thanks a lot.

darkowlzz · 2022-07-20T13:25:55Z

@aryan9600 can you rebase please?
Hopefully that'll fix the CI failures and then we can merge this.

Decommission libgit2 unmanaged transport and remove the related feature gate, making managed transport the default. Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

Update initRepoWithRemote() so that it overwrites the remote url with the provided url if the remote already exists, instead of erroring out. Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

Attach context to HTTP requests at the transport level to honour timeouts. Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

…on knowledge Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

hiddeco reviewed Jul 7, 2022

View reviewed changes

api/v1beta2/condition_types.go Outdated Show resolved Hide resolved

pjbgf reviewed Jul 7, 2022

View reviewed changes

controllers/suite_test.go Show resolved Hide resolved

pjbgf reviewed Jul 7, 2022

View reviewed changes

main.go Outdated Show resolved Hide resolved

aryan9600 force-pushed the remove-unmanaged-transport branch from 6adf2b3 to 6976b15 Compare July 7, 2022 10:00

darkowlzz reviewed Jul 7, 2022

View reviewed changes

darkowlzz added the area/git Git related issues and pull requests label Jul 7, 2022

darkowlzz reviewed Jul 7, 2022

View reviewed changes

controllers/gitrepository_controller.go Outdated Show resolved Hide resolved

aryan9600 force-pushed the remove-unmanaged-transport branch from 6976b15 to b7133d7 Compare July 8, 2022 06:54

aryan9600 requested review from darkowlzz, hiddeco and pjbgf July 8, 2022 07:05

hiddeco approved these changes Jul 8, 2022

View reviewed changes

pjbgf approved these changes Jul 8, 2022

View reviewed changes

aryan9600 force-pushed the remove-unmanaged-transport branch 2 times, most recently from 782b0d1 to b6b0886 Compare July 8, 2022 09:35

darkowlzz reviewed Jul 8, 2022

View reviewed changes

pkg/git/libgit2/checkout.go Show resolved Hide resolved

aryan9600 force-pushed the remove-unmanaged-transport branch from b6b0886 to 4fe4e74 Compare July 9, 2022 13:38

darkowlzz reviewed Jul 11, 2022

View reviewed changes

controllers/gitrepository_controller.go Show resolved Hide resolved

darkowlzz reviewed Jul 11, 2022

View reviewed changes

controllers/gitrepository_controller.go Outdated Show resolved Hide resolved

aryan9600 force-pushed the remove-unmanaged-transport branch from 1133bd7 to 4c261d2 Compare July 14, 2022 11:11

darkowlzz reviewed Jul 14, 2022

View reviewed changes

controllers/gitrepository_controller.go Outdated Show resolved Hide resolved

darkowlzz reviewed Jul 14, 2022

View reviewed changes

controllers/gitrepository_controller_test.go Outdated Show resolved Hide resolved

darkowlzz reviewed Jul 14, 2022

View reviewed changes

controllers/gitrepository_controller_test.go Outdated Show resolved Hide resolved

darkowlzz reviewed Jul 14, 2022

View reviewed changes

controllers/suite_test.go Outdated Show resolved Hide resolved

darkowlzz added the hold Issues and pull requests put on hold label Jul 14, 2022

pjbgf added this to the GA milestone Jul 14, 2022

pjbgf mentioned this pull request Jul 15, 2022

Can't cross-build linux/amd64 image on Mac M1 #762

Closed

aryan9600 force-pushed the remove-unmanaged-transport branch from 4c261d2 to 8411e54 Compare July 15, 2022 08:38

darkowlzz reviewed Jul 19, 2022

View reviewed changes

controllers/gitrepository_controller_test.go Show resolved Hide resolved

controllers/gitrepository_controller_test.go Outdated Show resolved Hide resolved

controllers/gitrepository_controller_test.go Outdated Show resolved Hide resolved

aryan9600 force-pushed the remove-unmanaged-transport branch from 8411e54 to 4c4429c Compare July 19, 2022 14:34

darkowlzz removed the hold Issues and pull requests put on hold label Jul 20, 2022

darkowlzz approved these changes Jul 20, 2022

View reviewed changes

aryan9600 added 5 commits July 20, 2022 18:56

libgit2: decommission unmanaged transport

f5ada74

Decommission libgit2 unmanaged transport and remove the related feature gate, making managed transport the default. Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

libgit2: overwrite remote url if it exists

a252532

Update initRepoWithRemote() so that it overwrites the remote url with the provided url if the remote already exists, instead of erroring out. Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

libgit2: enforce timeouts for http transports

cd03c26

Attach context to HTTP requests at the transport level to honour timeouts. Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

docs: remove managed transport section

39fd597

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

gitrepo: update reconciler to be injected with transport initializati…

0978a7a

…on knowledge Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>

aryan9600 force-pushed the remove-unmanaged-transport branch from 4c4429c to 0978a7a Compare July 20, 2022 13:27

darkowlzz merged commit a6072c3 into fluxcd:main Jul 20, 2022

pjbgf mentioned this pull request Aug 16, 2022

Decomission Unmanaged Transport #782

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

libgit2: decommission unmanaged transport #819

libgit2: decommission unmanaged transport #819

aryan9600 commented Jul 7, 2022 •

edited

Loading

pjbgf Jul 7, 2022 •

edited

Loading

pjbgf commented Jul 7, 2022

aryan9600 commented Jul 8, 2022 •

edited

Loading

hiddeco left a comment

pjbgf left a comment

darkowlzz commented Jul 8, 2022

darkowlzz Jul 8, 2022

darkowlzz commented Jul 8, 2022

aryan9600 commented Jul 9, 2022 •

edited

Loading

pjbgf commented Jul 14, 2022

aryan9600 commented Jul 14, 2022 •

edited

Loading

stefanprodan commented Jul 14, 2022

darkowlzz left a comment

darkowlzz commented Jul 20, 2022

libgit2: decommission unmanaged transport #819

libgit2: decommission unmanaged transport #819

Conversation

aryan9600 commented Jul 7, 2022 • edited Loading

pjbgf Jul 7, 2022 • edited Loading

Choose a reason for hiding this comment

pjbgf commented Jul 7, 2022

aryan9600 commented Jul 8, 2022 • edited Loading

hiddeco left a comment

Choose a reason for hiding this comment

pjbgf left a comment

Choose a reason for hiding this comment

darkowlzz commented Jul 8, 2022

darkowlzz Jul 8, 2022

Choose a reason for hiding this comment

darkowlzz commented Jul 8, 2022

aryan9600 commented Jul 9, 2022 • edited Loading

pjbgf commented Jul 14, 2022

aryan9600 commented Jul 14, 2022 • edited Loading

stefanprodan commented Jul 14, 2022

darkowlzz left a comment

Choose a reason for hiding this comment

darkowlzz commented Jul 20, 2022

aryan9600 commented Jul 7, 2022 •

edited

Loading

pjbgf Jul 7, 2022 •

edited

Loading

aryan9600 commented Jul 8, 2022 •

edited

Loading

aryan9600 commented Jul 9, 2022 •

edited

Loading

aryan9600 commented Jul 14, 2022 •

edited

Loading