Elim Tsiagbey
8506ed3e2c
- add `LocalStorageState` to worker status reports - update worker service handler to process `LocalStorageState`. If is empty for workers older workers, we set the `LocalStorageState` to `unknown` - update field mask paths to support `LocalStorageState`
107 lines
4.0 KiB
Go
107 lines
4.0 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package storage
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"io/fs"
|
|
|
|
"github.com/hashicorp/boundary/internal/boundary"
|
|
"github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/storagebuckets"
|
|
plgpb "github.com/hashicorp/boundary/sdk/pbs/plugin"
|
|
)
|
|
|
|
// DefaultMinimumAvailableDiskSpace is the default value a Boundary worker will use
|
|
// if the user does not configure the worker with a RecordingStorageMinimumAvailableCapacity
|
|
// value. This value is equivalent to 500MiB. This value is used to determine the worker's
|
|
// local storage state.
|
|
const DefaultMinimumAvailableDiskSpace = 500 * 1024 * 1024
|
|
|
|
// RecordingStorage can be used to create an FS usable for session recording.
|
|
type RecordingStorage interface {
|
|
// NewSyncingFS returns an FS that will use local storage as a cache and sync files when they are closed.
|
|
NewSyncingFS(ctx context.Context, bucket *storagebuckets.StorageBucket, _ ...Option) (FS, error)
|
|
|
|
// NewRemoteFS returns a ReadOnly FS that can be used to retrieve files from a storage bucket.
|
|
NewRemoteFS(ctx context.Context, bucket *storagebuckets.StorageBucket, _ ...Option) (FS, error)
|
|
|
|
// PluginClients returns a map of storage plugin clients keyed on the plugin name.
|
|
PluginClients() map[string]plgpb.StoragePluginServiceClient
|
|
|
|
// CreateTemp creates a temporary file that is cleaned up when closed. All temp files
|
|
// are also removed when storage is initialized.
|
|
CreateTemp(ctx context.Context, p string) (TempFile, error)
|
|
}
|
|
|
|
// Bucket is a resource that represents a bucket in an external object store
|
|
type Bucket interface {
|
|
boundary.Resource
|
|
GetScopeId() string
|
|
GetBucketName() string
|
|
GetBucketPrefix() string
|
|
GetWorkerFilter() string
|
|
}
|
|
|
|
// FS is a filesystem for creating or reading files and containers.
|
|
type FS interface {
|
|
New(ctx context.Context, name string) (Container, error)
|
|
Open(ctx context.Context, name string) (Container, error)
|
|
}
|
|
|
|
// A Container is a filesystem abstraction that can create files or other containers.
|
|
type Container interface {
|
|
io.Closer
|
|
Create(context.Context, string) (File, error)
|
|
OpenFile(context.Context, string, ...Option) (File, error)
|
|
SubContainer(context.Context, string, ...Option) (Container, error)
|
|
}
|
|
|
|
// File represents a storage File.
|
|
type File interface {
|
|
fs.File
|
|
io.StringWriter
|
|
Writer
|
|
}
|
|
|
|
// TempFile is a temporary File. It will get removed when Closed.
|
|
type TempFile interface {
|
|
File
|
|
io.Seeker
|
|
}
|
|
|
|
// Writer is an interface that extends the io.Writer interface with an additional
|
|
// WriteAndClose method. WriteAndClose writes a byte slice and closes the file in
|
|
// a single call.
|
|
type Writer interface {
|
|
io.Writer
|
|
WriteAndClose([]byte) (int, error)
|
|
}
|
|
|
|
// LocalStorageState is represents the state of local storage.
|
|
type LocalStorageState string
|
|
|
|
const (
|
|
// AvailableLocalStorageState indicates local storage is
|
|
// (minimumAvailableDiskSpace * 1.25) above the minimum disk space threshold.
|
|
// This could indicates recovery from a low, critical, or out of disk space
|
|
// local storage state.
|
|
AvailableLocalStorageState LocalStorageState = "available"
|
|
// LowStorageLocalStorageState indicates local storage is below the minimum
|
|
// disk space threshold.
|
|
LowStorageLocalStorageState LocalStorageState = "low storage"
|
|
// CriticallyLowStorageLocalStorageState indicates local storage is below the
|
|
// half the minimum disk space threshold.
|
|
CriticallyLowStorageLocalStorageState LocalStorageState = "critically low storage"
|
|
// OutOfStorageLocalStorageState indicates local storage is below 1MB.
|
|
OutOfStorageLocalStorageState LocalStorageState = "out of storage"
|
|
// NotConfiguredLocalStorageState indicates the local storage path is not
|
|
// configured. Intervention from an admin might be necessary to help resolve
|
|
// the issue.
|
|
NotConfiguredLocalStorageState LocalStorageState = "not configured"
|
|
// UnknownLocalStorageState is the default state for local storage. It indicates
|
|
// the local storage state is unknown.
|
|
UnknownLocalStorageState LocalStorageState = "unknown"
|
|
)
|