lock

package

v0.0.0-...-1ef5c3e Latest Latest Go to latest Published: Aug 30, 2023 License: Apache-2.0 Imports: 12 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/newrelic/infrastructure-publish-action

Links

Open Source Insights

Documentation ¶

Overview ¶

Index ¶

Constants
Variables
type BucketLock
- func NewNoop() BucketLock
type InMemory
- func NewInMemory() *InMemory
- func (l *InMemory) Lock() error
- func (l *InMemory) Release() error
type Logf
type S3
- func NewS3(c S3Config, logfn Logf) (*S3, error)
- func (l *S3) Lock() error
- func (l *S3) Release() error
type S3Config
- func NewS3Config(bucketName, roleARN, awsRegion, tags, lockGroup, owner string, maxRetries uint, ...) S3Config

Constants ¶

View Source

const (
	DefaultTTL          = 1000 * time.Hour // disabled to manage leftover lockfiles manually for now
	DefaultRetryBackoff = time.Minute
)

Variables ¶

View Source

var (
	ErrLockBusy = errors.New("lock is busy")
)

Functions ¶

This section is empty.

Types ¶

type BucketLock ¶

type BucketLock interface {
	// Lock tries acquiring lock or fails rigth away.
	Lock() error
	// Release tries releasing an owned lock or fails.
	Release() error
}

func NewNoop ¶

func NewNoop() BucketLock

Noop returns a NO-OP lock, to be used when releasing stuff that won't need locking.

type InMemory ¶

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

InMemory lock for testing puposes.

func NewInMemory ¶

func NewInMemory() *InMemory

func (*InMemory) Lock ¶

func (l *InMemory) Lock() error

func (*InMemory) Release ¶

func (l *InMemory) Release() error

type Logf ¶

type Logf func(format string, args ...interface{})

Logf logger to provide feedback on retries.

type S3 ¶

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

S3 based lock.

func NewS3 ¶

func NewS3(c S3Config, logfn Logf) (*S3, error)

NewS3 creates a lock instance ready to be used validating required AWS credentials.

func (*S3) Lock ¶

func (l *S3) Lock() error

Lock S3 has no compare-and-swap so this is no bulletproof solution, but should be good enough.

func (*S3) Release ¶

func (l *S3) Release() error

Release frees owned lock.

type S3Config ¶

type S3Config struct {
	Bucket       string
	RoleARN      string
	Region       string
	Tags         string
	Filepath     string
	Owner        string
	MaxRetries   uint
	RetryBackoff time.Duration
	TTL          time.Duration
}

S3Config S3 lock config DTO.

func NewS3Config ¶

func NewS3Config(bucketName, roleARN, awsRegion, tags, lockGroup, owner string, maxRetries uint, retryBackoff, ttl time.Duration) S3Config

Source Files ¶

View all Source files

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