csitranslation

README

Purpose

This repository contains functions to be consumed by various Kubernetes and out-of-tree CSI components like external provisioner to facilitate migration of code from Kubernetes In-tree plugin code to CSI plugin repositories.

Consumers can make use of this repository can make use of functions like TranslateToCSI and TranslateToInTree functions to translate PV sources.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this repository at:

• Slack: #sig-storage (on https://kubernetes.slack.com -- get an invite at slack.kubernetes.io)
• Mailing List: https://groups.google.com/forum/#!forum/kubernetes-sig-storage

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

Contibution Guidelines

See CONTRIBUTING.md for more information.

Documentation

Index

• func GetCSINameFromIntreeName(pluginName string) (string, error)
• func IsInlineMigratable(vol *v1.Volume) bool
• func IsMigratableByName(pluginName string) bool
• func IsPVMigratable(pv *v1.PersistentVolume) bool
• func TranslateCSIPVToInTree(pv *v1.PersistentVolume) (*v1.PersistentVolume, error)
• func TranslateInTreePVToCSI(pv *v1.PersistentVolume) (*v1.PersistentVolume, error)

Functions

func GetCSINameFromIntreeName

func GetCSINameFromIntreeName(pluginName string) (string, error)

GetCSINameFromIntreeName maps the name of a CSI driver to its in-tree version

func IsInlineMigratable

func IsInlineMigratable(vol *v1.Volume) bool

IsInlineMigratable tests whether there is Migration logic for the given Inline Volume

func IsMigratableByName

func IsMigratableByName(pluginName string) bool

IsMigratableByName tests whether there is Migration logic for the in-tree plugin for the given `pluginName`

func IsPVMigratable

func IsPVMigratable(pv *v1.PersistentVolume) bool

IsPVMigratable tests whether there is Migration logic for the given Persistent Volume

func TranslateCSIPVToInTree

func TranslateCSIPVToInTree(pv *v1.PersistentVolume) (*v1.PersistentVolume, error)

TranslateCSIPVToInTree takes a PV with a CSI PersistentVolume Source and will translate it to a in-tree Persistent Volume Source for the specific in-tree volume specified by the `Driver` field in the CSI Source. The input PV object will not be modified.

func TranslateInTreePVToCSI

func TranslateInTreePVToCSI(pv *v1.PersistentVolume) (*v1.PersistentVolume, error)

TranslateInTreePVToCSI takes a persistent volume and will translate the in-tree source to a CSI Source if the translation logic has been implemented. The input persistent volume will not be modified