deferrer

package

v0.1.0 Latest Latest Go to latest Published: Jun 30, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/giantswarm/shutdown-deferrer

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func IsInvalidConfig(err error) bool
type Config
type Service
- func New(config Config) (*Service, error)
- func (s *Service) ShouldDefer(ctx context.Context) (bool, error)

Constants ¶

View Source

const (
	EnvKeyMyPodName      = "MY_POD_NAME"
	EnvKeyMyPodNamespace = "MY_POD_NAMESPACE"
)

Variables ¶

This section is empty.

Functions ¶

func IsInvalidConfig ¶

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types ¶

type Config ¶

type Config struct {
	G8sClient versioned.Interface
	Logger    micrologger.Logger
}

type Service ¶

type Service struct {
	// contains filtered or unexported fields
}

func New ¶

func New(config Config) (*Service, error)

func (*Service) ShouldDefer ¶

func (s *Service) ShouldDefer(ctx context.Context) (bool, error)

ShouldDefer finds corresponding DrainerConfig for the POD it's running in and checks if node in current POD is drained yet. If DrainerConfig doesn't exist or doesn't have Drained or Timeout condition, node termination should be deferred.

Current POD name and namespace are picked from environment variables with corresponding keys defined in constants EnvKeyMyPodName & EnvKeyMyPodNamespace. Defining these env variables is most conveniently achieved by utilizing Kubernetes Downward API: https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL