Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configurable git client timeout #2605

Merged
merged 2 commits into from
Aug 5, 2024
Merged

Configurable git client timeout #2605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a779c72
Configurable git client timeout
p-se Jul 5, 2024
f05c311
Fix name of test suite
p-se Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion charts/fleet/templates/configmap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,6 @@ data:
"agentNamespace": "{{.Values.bootstrap.agentNamespace}}"
},
"webhookReceiverURL": "{{.Values.webhookReceiverURL}}",
"githubURLPrefix": "{{.Values.githubURLPrefix}}"
"githubURLPrefix": "{{.Values.githubURLPrefix}}",
"gitClientTimeout": "{{.Values.gitClientTimeout}}"
}
4 changes: 4 additions & 0 deletions charts/fleet/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ ignoreClusterRegistrationLabels: false
# comma separated list of domains or ip addresses that will not use the proxy
noProxy: 127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,.svc,.cluster.local

# The amount of time to wait for a response from the server before canceling the
# request. Used to retrieve the latest commit of configured git repositories.
gitClientTimeout: 30s

bootstrap:
enabled: true
# The namespace that will be autocreated and the local cluster will be registered in
Expand Down
16 changes: 7 additions & 9 deletions integrationtests/gitjob/controller/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ import (

. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"sigs.k8s.io/controller-runtime/pkg/client"

"github.com/rancher/fleet/integrationtests/utils"
v1alpha1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/wrangler/v3/pkg/genericcondition"
"github.com/rancher/wrangler/v3/pkg/name"

batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/retry"
"sigs.k8s.io/controller-runtime/pkg/client"

"github.com/rancher/wrangler/v3/pkg/genericcondition"
"github.com/rancher/wrangler/v3/pkg/name"

"github.com/rancher/fleet/integrationtests/utils"
v1alpha1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
)

const (
Expand Down Expand Up @@ -51,7 +51,6 @@ func checkCondition(gitrepo *v1alpha1.GitRepo, condType string, status corev1.Co
}

var _ = Describe("GitJob controller", func() {

When("a new GitRepo is created", func() {
var (
gitRepo v1alpha1.GitRepo
Expand Down Expand Up @@ -614,7 +613,6 @@ var _ = Describe("GitRepo", func() {
})

var _ = Describe("GitRepo Status Fields", func() {

var (
gitrepo *v1alpha1.GitRepo
bd *v1alpha1.BundleDeployment
Expand Down
19 changes: 10 additions & 9 deletions integrationtests/gitjob/controller/suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,21 @@ import (
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/reugn/go-quartz/quartz"

"go.uber.org/mock/gomock"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/envtest"
"sigs.k8s.io/controller-runtime/pkg/log/zap"

"github.com/rancher/fleet/internal/cmd/controller/gitops/reconciler"
ctrlreconciler "github.com/rancher/fleet/internal/cmd/controller/reconciler"
"github.com/rancher/fleet/internal/cmd/controller/target"
"github.com/rancher/fleet/internal/config"
"github.com/rancher/fleet/internal/manifest"
v1alpha1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/fleet/pkg/git/mocks"

"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/envtest"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
)

const (
Expand All @@ -45,7 +44,7 @@ var (

func TestGitJobController(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Fleet CLI Cleanup Suite")
RunSpecs(t, "Fleet GitJob Controller Suite")
}

var _ = BeforeSuite(func() {
Expand Down Expand Up @@ -90,6 +89,8 @@ var _ = BeforeSuite(func() {
sched := quartz.NewStdScheduler()
Expect(sched).ToNot(BeNil())

config.Set(&config.Config{})

err = (&reconciler.GitJobReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Expand Down
20 changes: 10 additions & 10 deletions integrationtests/gitjob/git/git_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,27 @@ import (
dockercontainer "github.com/docker/docker/api/types/container"
dockermount "github.com/docker/docker/api/types/mount"
gogit "github.com/go-git/go-git/v5"
"github.com/go-git/go-git/v5/config"
gitconfig "github.com/go-git/go-git/v5/config"
"github.com/go-git/go-git/v5/plumbing/object"
"github.com/go-git/go-git/v5/plumbing/transport"
httpgit "github.com/go-git/go-git/v5/plumbing/transport/http"

"github.com/gogits/go-gogs-client"
cp "github.com/otiai10/copy"
"github.com/stretchr/testify/require"
"github.com/testcontainers/testcontainers-go"
"github.com/testcontainers/testcontainers-go/wait"
"go.uber.org/mock/gomock"
"golang.org/x/crypto/ssh"

"github.com/rancher/fleet/internal/mocks"
v1alpha1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/fleet/pkg/git"

v1 "k8s.io/api/core/v1"
kerrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"sigs.k8s.io/controller-runtime/pkg/client/fake"

"github.com/rancher/fleet/internal/config"
"github.com/rancher/fleet/internal/mocks"
v1alpha1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/fleet/pkg/git"
)

/*
Expand Down Expand Up @@ -111,6 +110,7 @@ func TestLatestCommit_NoAuth(t *testing.T) {
},
}

config.Set(&config.Config{})
for name, test := range tests {
t.Run(name, func(t *testing.T) {
f := git.Fetch{}
Expand Down Expand Up @@ -466,7 +466,7 @@ func initRepo(url string, name string, private bool) (string, error) {
if err != nil {
return "", err
}
cfg.Remotes["upstream"] = &config.RemoteConfig{
cfg.Remotes["upstream"] = &gitconfig.RemoteConfig{
Name: "upstream",
URLs: []string{repoURL},
}
Expand Down Expand Up @@ -529,7 +529,7 @@ func addRepoCommitAndTag(url string, name string, tag string, tagMessage string)
if err != nil {
return "", err
}
cfg.Remotes["upstream"] = &config.RemoteConfig{
cfg.Remotes["upstream"] = &gitconfig.RemoteConfig{
Name: "upstream",
URLs: []string{url},
}
Expand Down Expand Up @@ -574,7 +574,7 @@ func addRepoCommitAndTag(url string, name string, tag string, tagMessage string)
Username: gogsUser,
Password: gogsPass,
},
RefSpecs: []config.RefSpec{config.RefSpec("refs/tags/*:refs/tags/*")},
RefSpecs: []gitconfig.RefSpec{gitconfig.RefSpec("refs/tags/*:refs/tags/*")},
})
if err != nil {
return "", nil
Expand Down
40 changes: 28 additions & 12 deletions internal/cmd/controller/gitops/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,8 @@ import (
"strconv"
"time"

command "github.com/rancher/fleet/internal/cmd"
"github.com/rancher/fleet/internal/cmd/controller/gitops/reconciler"
"github.com/rancher/fleet/internal/metrics"
fleet "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/fleet/pkg/git"
"github.com/rancher/fleet/pkg/version"
"github.com/rancher/fleet/pkg/webhook"
"github.com/reugn/go-quartz/quartz"
"github.com/spf13/cobra"

"k8s.io/apimachinery/pkg/runtime"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
Expand All @@ -27,8 +19,16 @@ import (
clog "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"

"golang.org/x/sync/errgroup"

command "github.com/rancher/fleet/internal/cmd"
"github.com/rancher/fleet/internal/cmd/controller/gitops/reconciler"
fcreconciler "github.com/rancher/fleet/internal/cmd/controller/reconciler"
"github.com/rancher/fleet/internal/metrics"
fleet "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/fleet/pkg/git"
"github.com/rancher/fleet/pkg/version"
"github.com/rancher/fleet/pkg/webhook"
)

var (
Expand Down Expand Up @@ -121,7 +121,7 @@ func (g *GitOperator) Run(cmd *cobra.Command, args []string) error {
workers = w
}

reconciler := &reconciler.GitJobReconciler{
gitJobReconciler := &reconciler.GitJobReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Image: g.Image,
Expand All @@ -132,14 +132,30 @@ func (g *GitOperator) Run(cmd *cobra.Command, args []string) error {
Clock: reconciler.RealClock{},
}

configReconciler := &fcreconciler.ConfigReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
SystemNamespace: namespace,
ShardID: g.ShardID,
}

if err := fcreconciler.Load(ctx, mgr.GetAPIReader(), namespace); err != nil {
setupLog.Error(err, "failed to load config")
return err
}

group, ctx := errgroup.WithContext(ctx)
group.Go(func() error {
return startWebhook(ctx, namespace, g.Listen, mgr.GetClient(), mgr.GetCache())
})
group.Go(func() error {
setupLog.Info("starting manager")
setupLog.Info("starting config manager")
if err = configReconciler.SetupWithManager(mgr); err != nil {
return err
}

if err = reconciler.SetupWithManager(mgr); err != nil {
setupLog.Info("starting gitops manager")
if err = gitJobReconciler.SetupWithManager(mgr); err != nil {
return err
}

Expand Down
1 change: 1 addition & 0 deletions internal/cmd/controller/reconciler/config_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ func (r *ConfigReconciler) SetupWithManager(mgr ctrl.Manager) error {
object.GetName() == config.ManagerConfigName
}),
predicate.Or(
predicate.ResourceVersionChangedPredicate{},
predicate.GenerationChangedPredicate{},
predicate.AnnotationChangedPredicate{},
predicate.LabelChangedPredicate{},
Expand Down
5 changes: 5 additions & 0 deletions internal/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ type Config struct {
// to trust CA bundles from the operating system's store. If set to `strict`, then the agent shall only connect
// to a server which uses the exact CA configured when creating/updating the agent.
AgentTLSMode string `json:"agentTLSMode,omitempty"`

// The amount of time to wait for a response from the server before
// canceling the request. Used to retrieve the latest commit of configured
// git repositories.
GitClientTimeout metav1.Duration `json:"gitClientTimeout,omitempty"`
}

type Bootstrap struct {
Expand Down
2 changes: 2 additions & 0 deletions pkg/git/fetch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package git
import (
"context"

"github.com/rancher/fleet/internal/config"
v1alpha1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"

corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -46,6 +47,7 @@ func (f *Fetch) LatestCommit(ctx context.Context, gitrepo *v1alpha1.GitRepo, cli
CABundle: gitrepo.Spec.CABundle,
Credential: &secret,
InsecureTLSVerify: gitrepo.Spec.InsecureSkipTLSverify,
Timeout: config.Get().GitClientTimeout.Duration,
log: log.FromContext(ctx),
})
if err != nil {
Expand Down
4 changes: 4 additions & 0 deletions pkg/git/fetch_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/rancher/fleet/internal/config"
fleetv1 "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
"github.com/rancher/fleet/pkg/git"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -76,6 +77,9 @@ var _ = Describe("git fetch's LatestCommit tests", func() {
})

It("returns the commit for the expected revision", func() {
config.Set(&config.Config{
GitClientTimeout: metav1.Duration{Duration: 0},
})
secret := &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "test-secret",
Expand Down
6 changes: 2 additions & 4 deletions pkg/git/netutils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ import (
corev1 "k8s.io/api/core/v1"
)

var clientTimeout = time.Duration(30)

// GetAuthFromSecret returns the AuthMethod calculated from the given secret
// The credentials secret is expected to be either basic-auth or ssh-auth (with extra known_hosts data option)
func GetAuthFromSecret(url string, creds *corev1.Secret) (transport.AuthMethod, error) {
Expand Down Expand Up @@ -59,7 +57,7 @@ func GetAuthFromSecret(url string, creds *corev1.Secret) (transport.AuthMethod,

// GetHTTPClientFromSecret returns a HTTP client filled from the information in the given secret
// and optional CABundle and insecureTLSVerify
func GetHTTPClientFromSecret(creds *corev1.Secret, CABundle []byte, insecureTLSVerify bool) (*http.Client, error) {
func GetHTTPClientFromSecret(creds *corev1.Secret, CABundle []byte, insecureTLSVerify bool, timeout time.Duration) (*http.Client, error) {
var (
username string
password string
Expand Down Expand Up @@ -99,7 +97,7 @@ func GetHTTPClientFromSecret(creds *corev1.Secret, CABundle []byte, insecureTLSV

client := &http.Client{
Transport: transport,
Timeout: clientTimeout * time.Second,
Timeout: timeout,
}
if username != "" || password != "" {
client.Transport = &basicRoundTripper{
Expand Down
Loading
Loading