package
0.0.0-20250306163500-5f3bb2705e1f
Repository: https://github.com/versoriumx/teleport.git
Documentation: pkg.go.dev

# Packages

Package dynamo implements DynamoDB storage backend for Teleport auth service, similar to etcd backend.
Package etcdbk implements Etcd powered backend.
Package firestoreFirestoreBackend implements Firestore storage backend for Teleport auth service, similar to DynamoDB backend.
Package kubernetes implements Kubernetes Secret backend used for persisting identity and state for agent's running in Kubernetes clusters.
Package lite implements SQLite backend used for local persistent caches in proxies and nodes and for standalone auth service deployments.
Package memory implements backend interface using a combination of Minheap (to store expiring items) and B-Tree for storing sorted dictionary of items.
No description provided by the author
Package test contains a backend acceptance test suite that is backend implementation independent each backend will use the suite to test itself.

# Functions

AcquireLock grabs a lock that will be released automatically in TTL.
BacklogGracePeriod sets the amount of time a watcher with a backlog will be tolerated.
BufferCapacity sets the event capacity of the circular buffer.
BufferClock sets a custom clock for the buffer (used in tests).
CreateRevision generates a new identifier to be used as a resource revision.
EarliestExpiry returns first of the otherwise returns empty.
ExactKey is like Key, except a Separator is appended to the result path of Key.
Expiry converts ttl to expiry time, if ttl is 0 returns empty time.
No description provided by the author
GetPaginationKey returns the pagination key given resource.
IterateRange is a helper for stepping over a range.
Key joins parts into path separated by Separator, makes sure path always starts with Separator ("/").
MaskKeyName masks the given key name.
NewCircularBuffer returns a new uninitialized instance of circular buffer.
NewLease creates a lease for the provided [Item].
NewReporter returns a new Reporter.
NewReporterWatcher creates new reporter watcher instance.
NewSanitizer returns a new Sanitizer.
NewWrapper returns a new Wrapper.
NextPaginationKey returns the next pagination key.
RangeEnd returns end of the range for given key.
RemoveRedundantPrefixes will remove redundant prefixes from the given prefix list.
RunWhileLocked allows you to run a function while a lock is held.
StreamRange constructs a Stream for the given key range.
TTL returns TTL in duration units, rounds up to one second.

# Constants

DefaultBacklogGracePeriod is the default amount of time that the circular buffer will tolerate an event backlog in one of its watchers.
DefaultBufferCapacity is a default circular buffer size used by backends to fan out events.
DefaultEventsTTL is a default events TTL period.
DefaultPollStreamPeriod is a default event poll stream period.
DefaultRangeLimit is used to specify some very large limit when limit is not specified explicitly to prevent OOM due to infinite loops or other issues along those lines.
Forever means that object TTL will not expire unless deleted.
NoLimit specifies no limits.
Separator is used as a separator between key parts.

# Variables

BlankRevision is a placeholder revision to be used by backends when the revision of the item in the backend is empty.
ErrIncorrectRevision is returned from conditional operations when revisions do not match the expected value.

# Structs

BufferWatcher is a watcher connected to the buffer and receiving fan-out events from the watcher.
CircularBuffer implements in-memory circular buffer of predefined size, that is capable of fan-out of the backend events.
Config is used for 'storage' config section.
Event is a event containing operation with item.
GetResult provides the result of GetRange request.
Item is a key value item.
Lease represents a lease on the item that can be used to extend item's TTL without updating its contents.
No description provided by the author
No description provided by the author
Reporter wraps a Backend implementation and reports statistics about the backend operations.
ReporterConfig configures reporter wrapper.
ReporterWatcher is a wrapper around backend watcher that reports events.
RunWhileLockedConfig is configuration for RunWhileLocked function.
Sanitizer wraps a Backend implementation to make sure all values requested of the backend are whitelisted.
Watch specifies watcher parameters.
Wrapper wraps a Backend implementation that can fail on demand.

# Interfaces

Backend implements abstraction over local or remote storage backend.
Watcher returns watcher.

# Type aliases

No description provided by the author
Items is a sortable list of backend items.
Params type defines a flexible unified back-end configuration API.