README
¶
secfs
Package secfs implements afero.Fs and afero.File for Kubernetes secrets.
A Kubernetes secret path can be written as /NAMESPACE/SECRET[/KEY]. Where /NAMESPACE/SECRET represents the directory and KEY the file part of the path.
Documentation
¶
Overview ¶
Package secfs is a filesystem for k8s secrets Namespace -> directory Secret -> directory Secret key -> file Absolute path to secret key: namespace/secret/key
Index ¶
- Constants
- Variables
- func New(k kubernetes.Interface, opts ...Option) afero.Fs
- type File
- func (f *File) Close() error
- func (f *File) Data() map[string][]byte
- func (f *File) Delete() bool
- func (f *File) IsDir() bool
- func (f *File) Key() string
- func (f *File) ModTime() time.Time
- func (f *File) Mode() fs.FileMode
- func (f *File) Name() string
- func (f *File) Namespace() string
- func (f *File) Read(p []byte) (n int, err error)
- func (f *File) ReadAt(p []byte, off int64) (n int, err error)
- func (f *File) Readdir(count int) ([]os.FileInfo, error)
- func (f *File) Readdirnames(n int) ([]string, error)
- func (f *File) Secret() string
- func (f *File) Seek(offset int64, whence int) (int64, error)
- func (f *File) SetData(data map[string][]byte)
- func (f *File) SetTime(mtime time.Time)
- func (f *File) Size() int64
- func (f *File) Stat() (os.FileInfo, error)
- func (f *File) Sync() error
- func (f *File) Sys() interface{}
- func (f *File) Truncate(size int64) error
- func (f *File) Value() []byte
- func (f *File) Write(p []byte) (n int, err error)
- func (f *File) WriteAt(p []byte, off int64) (n int, err error)
- func (f *File) WriteString(st string) (int, error)
- type Option
Constants ¶
const ( // DefaultSecretPrefix for k8s secrets DefaultSecretPrefix = "" // DefaultSecretSuffix for k8s secrets DefaultSecretSuffix = "" // DefaultRequestTimeout for k8s API requests DefaultRequestTimeout = 5 * time.Second )
Variables ¶
var ( // ErrMoveCrossNamespace is currently not allowed ErrMoveCrossNamespace = errors.New("move a secret between namespaces is not allowed") // ErrMoveConvert secrets can contain files only ErrMoveConvert = errors.New("convert a secret to a file is not allowed") )
Functions ¶
Types ¶
type File ¶
type File struct {
TLS bool // TODO: corev1.SecretTypeTLS
// contains filtered or unexported fields
}
File is the corev1.Secret without k8s specific data
func FileCreate ¶
FileCreate create a new or truncated file https://pkg.go.dev/os#Create returns *File (implements afero.File and os.FileInfo)
func Open ¶
Open open a secret or file https://pkg.go.dev/os#Open returns *File (implements afero.File and os.FileInfo)
func (*File) Read ¶
Read io.Reader https://pkg.go.dev/io#Reader
func (*File) ReadAt ¶
ReadAt io.ReaderAt https://pkg.go.dev/io#ReaderAt
func (*File) Readdirnames ¶
Readdirnames (afero.File)
func (*File) Seek ¶
Seek io.Seeker https://pkg.go.dev/io#Seeker
func (*File) Sys ¶
func (f *File) Sys() interface{}
Sys returns underlying data source (io.FileInfo) can return nil
func (*File) Write ¶
Write io.Writer https://pkg.go.dev/io#Writer
func (*File) WriteAt ¶
WriteAt io.WriterAt https://pkg.go.dev/io#WriterAt Source: https://github.com/aws/aws-sdk-go/blob/e8afe81156c70d5bf7b6d2ed5aeeb609ea3ba3f8/aws/types.go#L183
type Option ¶
type Option func(*secfs)
Option represents a functional Option
func WithSecretLabels ¶
WithSecretLabels configures a custom secret labels
func WithSecretPrefix ¶
WithSecretPrefix configures a custom secret prefix
func WithSecretSuffix ¶
WithSecretSuffix configures a custom secret suffix
func WithTimeout ¶
WithTimeout configures a custom request timeout
Source Files
Directories