Categorygithub.com/brightbox/brightbox-volume-device-plugin
modulepackage
1.0.0
Repository: https://github.com/brightbox/brightbox-volume-device-plugin.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
0
Files
231 SLOC

# README

Brightbox Block Storage Volume device plugin for Kubernetes

The repository builds a container image which is stored on Docker Hub.

The plugin can be installed via the daemonset.yaml manifest.

kubectl apply -f https://raw.githubusercontent.com/brightbox/brightbox-volume-device-plugin/main/daemonset.yaml

What it does

The plugin watches for volume attach and detach events on Brightbox servers and creates a custom resource within Kubernetes. The resources are of the form

volumes.brightbox.com/vol-tgl4c

The list of volume resources can be viewed via kubectl describe node

Pods can require a particular volume to be present by adding the volume to their resources stanzas

apiVersion: v1
kind: Pod
metadata:
  name: with-volume-requirement
spec:
  containers:
  - name: with-volume-requirement
    image: k8s.gcr.io/pause:2.0
    resources:
      limits:
        volumes.brightbox.com/vol-qsk4v: 1

# Packages

Package dpm (Device Plugin Manager) provides a framework that makes implementation of Device Plugins https://kubernetes.io/docs/concepts/cluster-administration/device-plugins/ easier.
No description provided by the author

# Functions

NewLister creates a new volumeLister.

# Structs

Completion provides a volumes slice and a completion function that needs to called when the subscriber plugin has finished with the volumes.
VolumeLister is a proxy which takes events from the volumewatcher and posts them to the plugin manager using the Lister interface.