sigs.k8s.io/cluster-api@v1.7.1/util/retry.go (about)

     1  /*
     2  Copyright 2017 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package util
    18  
    19  import (
    20  	"time"
    21  
    22  	"k8s.io/apimachinery/pkg/util/wait"
    23  )
    24  
    25  const (
    26  	backoffSteps    = 10
    27  	backoffFactor   = 1.25
    28  	backoffDuration = 5
    29  	backoffJitter   = 1.0
    30  )
    31  
    32  // Retry retries a given function with exponential backoff.
    33  func Retry(fn wait.ConditionFunc, initialBackoffSec int) error {
    34  	if initialBackoffSec <= 0 {
    35  		initialBackoffSec = backoffDuration
    36  	}
    37  	backoffConfig := wait.Backoff{
    38  		Steps:    backoffSteps,
    39  		Factor:   backoffFactor,
    40  		Duration: time.Duration(initialBackoffSec) * time.Second,
    41  		Jitter:   backoffJitter,
    42  	}
    43  	retryErr := wait.ExponentialBackoff(backoffConfig, fn)
    44  	if retryErr != nil {
    45  		return retryErr
    46  	}
    47  	return nil
    48  }