REX-Ray+CSI: Once more unto the breach

README.md

REX-Ray+CSI: Once more unto the breach

This document outlines the roadmap for supporting CSI with libStorage and REX-Ray:

Release	Description
R1	Initial CSI compatibility
R2	CNCF-ready
R3	Reference CSI implementation

R1 - Initial CSI compatibility

The first release will support both CSI architectures: centralized and decentralized, as well as the hybrid model necessary to satisfy Mesos. Many thanks to @codenrhoden for providing the illustrations!

Arch	Diagram
Centralized
Decentralized
Hybrid

Currently the only analogue to the CSI centralized model is K8s where there is a CO master. Docker and Mesos both function in a decentralized model with the libStorage API controller providing optional centralization.

Work	Summary	Story Points
#1	New REX-Ray module for CSI Ident+Node+Controller Services	21
		21

R2 - CNCF-ready

The second release represents a project ready to donate to the CNCF as the default implementation of CSI. The primary feature of this release will be support for out-of-tree drivers via Go plug-ins, making it trivial to deliver CSI compatibility for a given storage platform via REX-Ray.

The diagrams for R2 do not change in any significant way from R1 and will not be repeated. While there is now support for Go plug-ins and the executor will be deprecated, the absence of distributed configuration support means a central libStorage API controller is still required in order to provide single, centralized configuration for storage platforms such as ScaleIO.

Work	Summary	Story Points
#1	Convert existing drivers into plug-ins	40
#2	Deprecate libStorage executor	21
#3	Update build process to account for plug-ins	21
		82

R3 - Reference implementation

Rounding out the roadmap is R3, the release that transforms REX-Ray from a program that embeds the libStorage API into the reference implementation of CSI. This release introduces support for distributed configuration via one or more well-known providers such as Etcd or abstraction libraries like Docker's libkv.

Arch	Diagram
Centralized
Decentralized
Hybrid	This release no longer includes the hybrid model as the reasons for such a design have been rendered moot by the introduction of distributed configuration support. Please be aware that the Decentralized model below is applicable to both Docker and Mesos.

The introduction of distributed configuration support will also sunset the libStorage API and complete the transformation of REX-Ray into a reference implementation of the CSI specification.

Work	Summary	Story Points
#1	Distributed configuration support	40
#2	Relocate CSI endpoint from REX-Ray to libStorage	20
		60

r1-c.puml

@startuml

database storage [
    Backend
    Storage
    <U+0020><U+0020><U+0020><U+0020>API
]

rectangle "k8s Master" as knode1 {
    frame "k8s" as knode1k {
        component "kube-controller-manager" as knode1kd
    }
    frame "REX-Ray" as knode1rr {
        component knode1csi [
            **CSI Controller**
            ---
            libStorage Client
        ]
        component "libS Server" as knode1lss
    }
    knode1kd <-> knode1csi: gRPC
    knode1csi <-> knode1lss: HTTP(s)\nJSON
}

rectangle "k8s Minion" as knode2 {
    frame "k8s" as knode2k {
        component "kubelet" as knode2kd
    }
    frame "REX-Ray" as knode2rr {
        component knode2csi [
            **CSI Node**
            ---
            libStorage Client
        ]
    }
    knode2kd <-> knode2csi: gRPC
    knode2csi <-> knode1lss: HTTP(s)\nJSON
}

knode1lss -> storage
knode1 -[hidden]> storage
storage -[hidden]> knode2
storage -[hidden]> knode2csi

@enduml

r1-c.svg

r1-d.puml

@startuml

database storage [
    Backend
    Storage
    <U+0020><U+0020><U+0020><U+0020>API
]

rectangle "Docker Node 1" as dnode1 {
    frame "Docker" as dnode1d {
        component "dockerd" as dnode1dd
    }
    frame "REX-Ray" as dnode1rr {
        component dnode1csi [
            **CSI Node+Controller**
            ---
            libStorage Client
        ]
        component "libS Server" as dnode1lss
    }
    dnode1dd <-> dnode1csi: gRPC
    dnode1csi <-> dnode1lss: HTTP(s)\nJSON
}

rectangle "Docker Node 2" as dnode2 {
    frame "Docker" as dnode2d {
        component "dockerd" as dnode2dd
    }
    frame "REX-Ray" as dnode2rr {
        component dnode2csi [
            **CSI Node+Controller**
            ---
            libStorage Client
        ]
        component "libS Server" as dnode2lss
    }
    dnode2dd <-> dnode2csi: gRPC
    dnode2csi <-> dnode2lss: HTTP(s)\nJSON
}

storage <-> dnode1lss
storage <-> dnode2lss

@enduml

r1-d.svg

r1-h.puml

@startuml

database storage [
    Backend
    Storage
    <U+0020><U+0020><U+0020><U+0020>API
]

rectangle "Mesos Node 1" as mnode1 {
    frame "Mesos" as mnode1m {
        component "mesosd" as mnode1md
    }
    frame "REX-Ray" as mnode1rr {
        component mnode1csi [
            **CSI Node+Controller**
            ---
            libStorage Client
        ]
        component "libS Server" as mnode1lss
    }
    mnode1md <-> mnode1csi: gRPC
    mnode1csi <-> mnode1lss: HTTP(s)\nJSON
}

rectangle "Mesos Node 2" as mnode2 {
    frame "Mesos" as mnode2m {
        component "mesosd" as mnode2md
    }
    frame "REX-Ray" as mnode2rr {
        component mnode2csi [
            **CSI Node+Controller**
            ---
            libStorage Client
        ]
    }
    mnode2md <-> mnode2csi: gRPC
    mnode2csi <-> mnode1lss: HTTP(s)\nJSON
}

mnode1lss -> storage
mnode1 -[hidden]> storage
storage -[hidden]> mnode2
storage -[hidden]> mnode2csi

@enduml

r1-h.svg

r3-c.puml

@startuml

database storage [
    Backend
    Storage
    <U+0020><U+0020><U+0020><U+0020>API
]

rectangle "k8s Master" as knode1 {
    frame "k8s" as knode1k {
        component "kube-controller-manager" as knode1kd
    }
    frame "REX-Ray" as knode1rr {
        component "CSI Controller" as knode1csi
    }
    knode1kd <-> knode1csi: gRPC
}

rectangle "k8s Minion" as knode2 {
    frame "k8s" as knode2k {
        component "kubelet" as knode2kd
    }
    frame "REX-Ray" as knode2rr {
        component "CSI Node" as knode2csi
    }
    knode2kd <-> knode2csi: gRPC
}

knode1csi -> storage
knode2csi -> storage

@enduml

r3-c.svg

r3-d.puml

@startuml

database storage [
    Backend
    Storage
    <U+0020><U+0020><U+0020><U+0020>API
]

rectangle "Docker Node 1" as dnode1 {
    frame "Docker" as dnode1d {
        component "dockerd" as dnode1dd
    }
    frame "REX-Ray" as dnode1rr {
        component "CSI Node+Controller" as dnode1csi
    }
    dnode1dd <-> dnode1csi: gRPC
}

rectangle "Docker Node 2" as dnode2 {
    frame "Docker" as dnode2d {
        component "dockerd" as dnode2dd
    }
    frame "REX-Ray" as dnode2rr {
        component "CSI Node+Controller" as dnode2csi
    }
    dnode2dd <-> dnode2csi: gRPC
}

dnode1csi -> storage
dnode2csi -> storage

@enduml

r3-d.svg

<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="432px" preserveAspectRatio="none" style="width:421px;height:432px;" version="1.1" viewBox="0 0 421 432" width="421px" zoomAndPan="magnify"><defs><filter height="300%" id="f18todzeq8d2r8" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><!--cluster dnode1--><rect fill="#FFFFFF" filter="url(#f18todzeq8d2r8)" height="286" style="stroke: #000000; stroke-width: 2.0;" width="196" x="14" y="16"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="106" x="59" y="31.5352">Docker Node 1</text><!--cluster dnode1d--><rect fill="#FFFFFF" filter="url(#f18todzeq8d2r8)" height="71" style="stroke: #000000; stroke-width: 2.0;" width="92" x="66" y="43"/><path d="M126,44 L126,52.4883 L116,62.4883 L66,62.4883 " fill="none" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="50" x="69" y="57.5352">Docker</text><!--cluster dnode1rr--><rect fill="#FFFFFF" filter="url(#f18todzeq8d2r8)" height="71" style="stroke: #000000; stroke-width: 2.0;" width="180" x="22" y="223"/><path d="M94,224 L94,232.4883 L84,242.4883 L22,242.4883 " fill="none" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="62" x="25" y="237.5352">REX-Ray</text><!--cluster dnode2--><rect fill="#FFFFFF" filter="url(#f18todzeq8d2r8)" height="286" style="stroke: #000000; stroke-width: 2.0;" width="196" x="218" y="16"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="106" x="263" y="31.5352">Docker Node 2</text><!--cluster dnode2d--><rect fill="#FFFFFF" filter="url(#f18todzeq8d2r8)" height="71" style="stroke: #000000; stroke-width: 2.0;" width="92" x="270" y="43"/><path d="M330,44 L330,52.4883 L320,62.4883 L270,62.4883 " fill="none" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="50" x="273" y="57.5352">Docker</text><!--cluster dnode2rr--><rect fill="#FFFFFF" filter="url(#f18todzeq8d2r8)" height="71" style="stroke: #000000; stroke-width: 2.0;" width="180" x="226" y="223"/><path d="M298,224 L298,232.4883 L288,242.4883 L226,242.4883 " fill="none" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="62" x="229" y="237.5352">REX-Ray</text><!--entity dnode1dd--><rect fill="#FEFECE" filter="url(#f18todzeq8d2r8)" height="36.4883" style="stroke: #A80036; stroke-width: 1.5;" width="76" x="74" y="70"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="69" y="75"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="69" y="96.4883"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="56" x="84" y="93.5352">dockerd</text><!--entity dnode1csi--><rect fill="#FEFECE" filter="url(#f18todzeq8d2r8)" height="36.4883" style="stroke: #A80036; stroke-width: 1.5;" width="163" x="30.5" y="250"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="25.5" y="255"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="25.5" y="276.4883"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="143" x="40.5" y="273.5352">CSI Node+Controller</text><!--entity dnode2dd--><rect fill="#FEFECE" filter="url(#f18todzeq8d2r8)" height="36.4883" style="stroke: #A80036; stroke-width: 1.5;" width="76" x="278" y="70"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="273" y="75"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="273" y="96.4883"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="56" x="288" y="93.5352">dockerd</text><!--entity dnode2csi--><rect fill="#FEFECE" filter="url(#f18todzeq8d2r8)" height="36.4883" style="stroke: #A80036; stroke-width: 1.5;" width="163" x="234.5" y="250"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="229.5" y="255"/><rect fill="#FEFECE" height="5" style="stroke: #A80036; stroke-width: 1.5;" width="10" x="229.5" y="276.4883"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="143" x="244.5" y="273.5352">CSI Node+Controller</text><!--entity storage--><path d="M174.5,357 C174.5,347 213,347 213,347 C213,347 251.5,347 251.5,357 L251.5,415.4648 C251.5,425.4648 213,425.4648 213,425.4648 C213,425.4648 174.5,425.4648 174.5,415.4648 L174.5,357 " fill="#FEFECE" filter="url(#f18todzeq8d2r8)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M174.5,357 C174.5,367 213,367 213,367 C213,367 251.5,367 251.5,357 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="57" x="184.5" y="384.5352">Backend</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="53" x="184.5" y="401.0234">Storage</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="22" x="200.5" y="417.5117">API</text><!--link dnode1dd to dnode1csi--><path d="M112,111.3702 C112,145.907 112,210.1999 112,244.6976 " fill="none" id="dnode1dd-dnode1csi" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="112,249.9694,116,240.9694,112,244.9694,108,240.9694,112,249.9694" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="112,106.2499,108,115.2499,112,111.2499,116,115.2499,112,106.2499" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="32" x="113" y="180.5684">gRPC</text><!--link dnode2dd to dnode2csi--><path d="M316,111.3702 C316,145.907 316,210.1999 316,244.6976 " fill="none" id="dnode2dd-dnode2csi" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="316,249.9694,320,240.9694,316,244.9694,312,240.9694,316,249.9694" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="316,106.2499,312,115.2499,316,111.2499,320,115.2499,316,106.2499" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="32" x="317" y="180.5684">gRPC</text><!--link dnode1csi to storage--><path d="M127.5599,286.1789 C140.4252,301.2096 159.2246,323.1733 175.9159,342.674 " fill="none" id="dnode1csi-storage" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="179.2237,346.5385,176.4102,337.1,175.9724,342.7399,170.3325,342.3021,179.2237,346.5385" style="stroke: #A80036; stroke-width: 1.0;"/><!--link dnode2csi to storage--><path d="M300.132,286.1789 C287.0119,301.2096 267.8402,323.1733 250.8184,342.674 " fill="none" id="dnode2csi-storage" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="247.4452,346.5385,256.3771,342.3886,250.7332,342.7717,250.3501,337.1278,247.4452,346.5385" style="stroke: #A80036; stroke-width: 1.0;"/><!--
@startuml

database storage [
    Backend
    Storage
    <U+0020><U+0020><U+0020><U+0020>API
]

rectangle "Docker Node 1" as dnode1 {
    frame "Docker" as dnode1d {
        component "dockerd" as dnode1dd
    }
    frame "REX-Ray" as dnode1rr {
        component "CSI Node+Controller" as dnode1csi
    }
    dnode1dd <-> dnode1csi: gRPC
}

rectangle "Docker Node 2" as dnode2 {
    frame "Docker" as dnode2d {
        component "dockerd" as dnode2dd
    }
    frame "REX-Ray" as dnode2rr {
        component "CSI Node+Controller" as dnode2csi
    }
    dnode2dd <-> dnode2csi: gRPC
}

dnode1csi -> storage
dnode2csi -> storage

@enduml

PlantUML version 1.2017.13(Wed May 10 11:52:33 CDT 2017)
(GPL source distribution)
Java Runtime: Java(TM) SE Runtime Environment
JVM: Java HotSpot(TM) 64-Bit Server VM
Java Version: 1.8.0_20-b26
Operating System: Mac OS X
OS Version: 10.12.5
Default Encoding: UTF-8
Language: en
Country: US
--></g></svg>