contributing

Ramping up on Kubernetes Storage

We recommend the following presentations, docs, and videos to help get familiar with Kubernetes Storage concepts.

Date Title Link Description
- Persistent Volume Framework Doc Public user docs for Kubenretes Persistent Volume framework.
2018 May 03 SIG Storage Intro Video An overview of SIG Storage By Saad Ali at Kubecon EU 2018.
2018 May 04 Kubernetes Storage Lingo 101 Video An overview of various terms used in Kubernetes storage and what they mean by Saad Ali at Kubecon EU 2018.
2017 May 18 Storage Classes & Dynamic Provisioning in Kubernetes Video Intro to the basic Kubernetes storage concepts for users (direct volume reference, PV/PVC, and dynamic provisioning).
2017 March 29 Dynamic Provisioning and Storage Classes in Kubernetes Blog post Overview of Dynamic Provisioning and Storage Classes in Kubernetes at GA.
2017 March 29 How Kubernetes Storage Works Slides Overview for developers on how Kubernetes storage works for KubeCon EU 2017 by Saad Ali
2017 February 17 Overview of Dynamic Provisioning for SIG Apps Video Overview of Storage Classes and Dynamic Provisioning for SIG Apps
2016 October 7 Dynamic Provisioning and Storage Classes in Kubernetes Blog post Overview of Dynamic Provisioning and Storage Classes in Kubernetes at Beta.
2016 July 26 Overview of Basic Volume for SIG Apps Video Overview of Basic Volume for SIG Apps
2016 March 25 The State of State Video The State of State at KubeCon EU 2016 by Matthew Bates
2016 March 25 Kubernetes Storage 101 Video Kubernetes Storage 101 at KubeCon EU 2016 by Erin Boyd

Keep in mind that these artifacts reflect the state of the art at the time they were created. In Kubernetes we try very hard to maintain backwards compatibility, but Kubernetes is a fast moving project and we do add features going forward and attending the Storage SIG meetings and the Storage SIG Google group are both good ways of continually staying up to speed.

How to help

We love having folks help in any capacity! We recommend you start by reading the overall Kubernetes contributor’s guide

Helping with Features

If you have a feature idea, please submit a feature proposal PR first and put it on the Storage SIG Meeting Agenda. Our PR review bandwidth is fairly small, as such, we strongly recommend that you do not start writing the implementation before you’ve discussed the feature with the community. This helps the community understand what you’re trying to do with the proposal and helps the community and you work through the approach until there is consensus. The community then will also be able to communicate with you how soon they will be able to review your proposal PR, to set expectations. However, generally speaking once the your proposal PR is merged, your implementation PR review and merge should go fairly quickly as the review is focused on the implementation quality and not what you are proposing. We are really trying to improve our test coverage and documentation, so please include functional tests, e2e tests and documentation in your implementation PR.

Helping with Issues

A great way to get involved is to pick an issue and help address it. We would love help here. Storage related issues are listed here.

Adding support for a new storage platform in Kubernetes

For folks looking to add support for a new storage platform in Kubernetes, you have several options: - Write an in-tree volume plugin or provisioner: You can contribute a new in-tree volume plugin or provisioner, that gets built and ships with Kubernetes, for use within the Persistent Volume Framework. See the Ceph RBD volume plugin example or the AWS Provisioner example - Write a FlexVolume plugin: This is an out-of-tree volume plugin which you develop and build separately outside of Kubernetes. You then install the plugin on every Kubernetes host within your cluster and then configure the plugin in Kubernetes as a FlexVolume - Write a Provisioner Controller: You can write a separate controller that watches for pending claims with a specific selector label on them. Once an appropriate claim is discovered, the controller then provisions the appropriate storage intended for the claim and creates a corresponding persistent volume for the claim that includes the same label used in the original claim selector. This will ensure that the PV for the new storage provisioned gets bound to the original claim.