locket

README

Locket

Locket is a distributed locking service and client libraries to integrate with the service.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/locket.

Docs

• Understanding Locks and Presences
• Locket Client
• How Locket is using a database
• Using cfdot with Locket
• Common failure scenarios
• Low-level Architecture

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Diego area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• Constants
• func LockSchemaPath(lockName ...string) string
• func NewClient(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)
• func NewClientSkipCertVerify(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)
• type ClientLocketConfig

Constants

const DefaultSessionTTL = 15 * time.Second

const DefaultSessionTTLInSeconds int64 = 15

const ExpirationMetricsInterval = 60 * time.Second

const LockSchemaRoot = "v1/locks"

const MonitorRetryTime = 2 * time.Second

const RetryInterval = 5 * time.Second

const SQLRetryInterval = time.Second

Functions

func LockSchemaPath

func LockSchemaPath(lockName ...string) string

func NewClient

func NewClient(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)

func NewClientSkipCertVerify

func NewClientSkipCertVerify(logger lager.Logger, config ClientLocketConfig) (models.LocketClient, error)

Types

type ClientLocketConfig

type ClientLocketConfig struct {
	LocketAddress                string `json:"locket_address,omitempty" yaml:"locket_address,omitempty"`
	LocketCACertFile             string `json:"locket_ca_cert_file,omitempty" yaml:"locket_ca_cert_file,omitempty"`
	LocketClientCertFile         string `json:"locket_client_cert_file,omitempty" yaml:"locket_client_cert_file,omitempty"`
	LocketClientKeyFile          string `json:"locket_client_key_file,omitempty" yaml:"locket_client_key_file,omitempty"`
	LocketClientKeepAliveTime    int    `json:"locket_client_keepalive_time,omitempty" yaml:"locket_client_keepalive_time,omitempty"`
	LocketClientKeepAliveTimeout int    `json:"locket_client_keepalive_timeout,omitempty" yaml:"locket_client_keepalive_timeout,omitempty"`
}