k8s

Documentation

Overview

Package k8s provides a configuration reader implementation for Kubernetes ConfigMaps and Secrets. It supports reading configuration data from Kubernetes resources and subscribing to changes.

Index

• Constants
• type K8SReader
  • func NewK8SReader(uri string) (*K8SReader, error)
  • func (k *K8SReader) Close() error
  • func (k *K8SReader) Read(ctx context.Context) ([]byte, error)
  • func (k *K8SReader) Subscribe(ctx context.Context) (<-chan *reader.ReadEvent, error)

Constants

const (
	// SchemeK8S represents kubernetes URI scheme
	SchemeK8S reader.Scheme = "k8s"

	// ResourceTypeConfigMap represents configmap resource type
	ResourceTypeConfigMap = "configmap"

	// ResourceTypeSecret represents secret resource type
	ResourceTypeSecret = "secret"
)

Types

type K8SReader

type K8SReader struct {
	// contains filtered or unexported fields
}

K8SReader implements ConfReader for kubernetes configmap/secret

func NewK8SReader

func NewK8SReader(uri string) (*K8SReader, error)

NewK8SReader creates a new k8s reader URI format: k8s://{resourceType}/{namespace}/{name}[/{key}] Example: k8s://configmap/default/my-config/config.yaml

func (*K8SReader) Close

func (k *K8SReader) Close() error

Close closes the reader and cleans up resources

func (*K8SReader) Read

func (k *K8SReader) Read(ctx context.Context) ([]byte, error)

Read reads configuration data from k8s configmap/secret

func (*K8SReader) Subscribe

func (k *K8SReader) Subscribe(ctx context.Context) (<-chan *reader.ReadEvent, error)

Subscribe subscribes to k8s configmap/secret changes and returns update channel