Documentation
¶
Index ¶
Constants ¶
const ( // PluginLaunchedByEngineVar is used to inform engine-launched plugins about their name. PluginLaunchedByEngineVar = "DOCKER_SECRETS_ENGINE_PLUGIN_LAUNCH_CFG" // DefaultPluginRegistrationTimeout is the default timeout for plugin registration. DefaultPluginRegistrationTimeout = 5 * time.Second // DefaultClientRequestTimeout is the default timeout for clients to handle a request. DefaultClientRequestTimeout = time.Duration(0) // 0 means no limit // DefaultClientResponseHeaderTimeout is the default timeout for response // headers, excluding the body. No limit by default: a request may block // on user interaction daemon-side. Use [client.WithResponseTimeout] or a // context deadline for a hard bound. DefaultClientResponseHeaderTimeout = time.Duration(0) // 0 means no limit // DefaultClientTLSHandshakeTimeout is the default timeout for clients to handle // tls handshakes. It should usually be short. DefaultClientTLSHandshakeTimeout = time.Second // DefaultClientIdleConnTimeout is the time a connection may stay alive for. // Clients that are long-lived take advantage of re-using the same connection // when making subsequent requests. This reduces latency. DefaultClientIdleConnTimeout = 90 * time.Second // DefaultClientMaxConnsPerHost is the maximum number of open connections // to the same host. DefaultClientMaxConnsPerHost = 100 // DefaultClientMaxIdleConnsPerHost is the maximum number of idle connections // to the same host. Long-lived clients can re-use a connection from the // connection pool. DefaultClientMaxIdleConnsPerHost = 10 )
Variables ¶
var ( ErrEmptyVersion = errors.New("empty version") ErrVPrefix = errors.New("missing version prefix") )
var ErrEmptyName = errors.New("empty name")
Functions ¶
func Compare ¶
Compare returns an integer comparing two versions according to semantic versioning. The result will be 0 if a == b, -1 if a < b, or +1 if a > b. An invalid semver string is considered less than a valid one.
func DaemonSocketPath
deprecated
func DaemonSocketPath() string
DaemonSocketPath returns the address of the standalone Secrets Engine's listening socket.
Deprecated: Use StandaloneSocketPath instead.
func DefaultSocketPath
deprecated
func DefaultSocketPath() string
DefaultSocketPath returns the Secrets Engine socket path used by Docker Desktop.
Deprecated: Use DesktopSocketPath instead.
func DesktopSocketPath ¶ added in v0.8.2
func DesktopSocketPath() string
DesktopSocketPath returns the Secrets Engine socket path used by Docker Desktop.
- Linux: $XDG_CACHE_HOME/docker-secrets-engine/engine.sock, or $HOME/.cache/docker-secrets-engine/engine.sock when XDG_CACHE_HOME is unset.
- macOS: $HOME/Library/Caches/docker-secrets-engine/engine.sock.
- Windows: %LOCALAPPDATA%\docker-secrets-engine\engine.sock.
If the user cache directory cannot be determined, it returns <temp>/docker-secrets-engine/engine.sock, where <temp> is the directory returned by os.TempDir.
func StandaloneSocketPath ¶ added in v0.8.2
func StandaloneSocketPath() string
StandaloneSocketPath returns the address of the standalone Secrets Engine's listening socket, @docker-secrets-engine/<UID>/daemon.sock. For example, UID 1000 uses @docker-secrets-engine/1000/daemon.sock.
On Linux it is an abstract Unix domain socket: the address has a leading "@", which Go's net package maps to a NUL byte, placing the socket in the abstract namespace instead of on the filesystem.
The address is namespaced by the user's UID so daemons run by different users on the same host do not collide (the abstract namespace is shared per network namespace, not per user as a filesystem path would be).
Types ¶
type DaemonVersion ¶
DaemonVersion holds version information reported by the daemon.
type Name ¶
type Name interface {
String() string
}
func MustNewName ¶
MustNewName creates a new Name as NewName does, but panics when a validation error occurs.
type Version ¶
type Version interface {
String() string
}
func MustNewVersion ¶
MustNewVersion creates a new Version as NewVersion does, but panics when a validation error occurs.