Skip to content

Commit 12f3f5d

Browse files
lpabonlpabon
authored
Merge pull request #16 from xing-yang/cinder_doc
Add Cinder CSI driver to docs
2 parents c31de40 + 0bf7066 commit 12f3f5d

25 files changed

+1434
-86
lines changed

‎book/src/Drivers.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Name | Status | More Information
2020
[ScaleIO](https://github.com/thecodeteam/csi-scaleio)|v0.1.0|A Container Storage Interface (CSI) Storage Plugin for DellEMC ScaleIO
2121
[vSphere](https://github.com/thecodeteam/csi-vsphere)|v0.1.0|A Container Storage Interface (CSI) Storage Plug-in for VMware vSphere
2222
[RBD](https://github.com/ceph/ceph-csi)|v0.2.0|A Container Storage Interface (CSI) Storage RBD Plug-in for Ceph
23+
[Cinder](https://github.com/kubernetes/cloud-provider-openstack/tree/master/pkg/csi/cinder)|v0.2.0|A Container Storage Interface (CSI) Storage Plug-in for Cinder
2324

2425
## Testing
2526
There are multiple ways to test your driver. Please see [Testing Drivers](Testing-Drivers.html) for more information.

‎docs/Archive.html

+40-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang="en" class="sidebar-visible">
33
<head>
4+
<!-- Book generated using mdBook -->
45
<meta charset="UTF-8">
56
<title>Archive - Kubernetes CSI Documentation</title>
67
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
@@ -36,6 +37,14 @@
3637
}
3738
</script>
3839

40+
<noscript>
41+
<style type="text/css">
42+
.javascript-only {
43+
display: none;
44+
}
45+
</style>
46+
</noscript>
47+
3948
</head>
4049
<body class="light">
4150
<!-- Work around some values being stored in localStorage wrapped in quotes -->
@@ -65,12 +74,14 @@
6574

6675
<!-- Hide / unhide sidebar before it is displayed -->
6776
<script type="text/javascript">
77+
var html = document.querySelector('html');
6878
var sidebar = 'hidden';
6979
if (document.body.clientWidth >= 1080) {
7080
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
7181
sidebar = sidebar || 'visible';
7282
}
73-
document.querySelector('html').classList.add("sidebar-" + sidebar);
83+
html.classList.remove('sidebar-visible');
84+
html.classList.add("sidebar-" + sidebar);
7485
</script>
7586

7687
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
@@ -83,7 +94,7 @@
8394

8495
<div id="menu-bar" class="menu-bar">
8596
<div id="menu-bar-sticky-container">
86-
<div class="left-buttons">
97+
<div class="left-buttons javascript-only">
8798
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
8899
<i class="fa fa-bars"></i>
89100
</button>
@@ -97,9 +108,14 @@
97108
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
98109
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
99110
</ul>
111+
112+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
113+
<i class="fa fa-search"></i>
114+
</button>
115+
100116
</div>
101117

102-
<h1 class="menu-title">Kubernetes CSI Documentation</h1>
118+
<h1 class="menu-title">Kubernetes CSI Documentation</h1>
103119

104120
<div class="right-buttons">
105121
<a href="print.html" title="Print this book" aria-label="Print this book">
@@ -109,6 +125,17 @@ <h1 class="menu-title">Kubernetes CSI Documentation</h1>
109125
</div>
110126
</div>
111127

128+
129+
<div id="searchbar-outer" class="searchbar-outer">
130+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
131+
</div>
132+
<div id="searchresults-outer" class="searchresults-outer">
133+
<div class="searchresults-header" id="searchresults-header"></div>
134+
<ul id="searchresults">
135+
</ul>
136+
</div>
137+
138+
112139
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
113140
<script type="text/javascript">
114141
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
@@ -179,6 +206,15 @@ <h1 class="menu-title">Kubernetes CSI Documentation</h1>
179206

180207

181208

209+
<script src="searchindex.js" type="text/javascript" charset="utf-8"></script>
210+
211+
212+
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
213+
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
214+
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
215+
216+
217+
182218

183219
<script src="highlight.js"></script>
184220
<script src="book.js"></script>

‎docs/CSI-Driver.html

+40-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang="en" class="sidebar-visible">
33
<head>
4+
<!-- Book generated using mdBook -->
45
<meta charset="UTF-8">
56
<title>Developing a CSI driver - Kubernetes CSI Documentation</title>
67
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
@@ -36,6 +37,14 @@
3637
}
3738
</script>
3839

40+
<noscript>
41+
<style type="text/css">
42+
.javascript-only {
43+
display: none;
44+
}
45+
</style>
46+
</noscript>
47+
3948
</head>
4049
<body class="light">
4150
<!-- Work around some values being stored in localStorage wrapped in quotes -->
@@ -65,12 +74,14 @@
6574

6675
<!-- Hide / unhide sidebar before it is displayed -->
6776
<script type="text/javascript">
77+
var html = document.querySelector('html');
6878
var sidebar = 'hidden';
6979
if (document.body.clientWidth >= 1080) {
7080
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
7181
sidebar = sidebar || 'visible';
7282
}
73-
document.querySelector('html').classList.add("sidebar-" + sidebar);
83+
html.classList.remove('sidebar-visible');
84+
html.classList.add("sidebar-" + sidebar);
7485
</script>
7586

7687
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
@@ -83,7 +94,7 @@
8394

8495
<div id="menu-bar" class="menu-bar">
8596
<div id="menu-bar-sticky-container">
86-
<div class="left-buttons">
97+
<div class="left-buttons javascript-only">
8798
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
8899
<i class="fa fa-bars"></i>
89100
</button>
@@ -97,9 +108,14 @@
97108
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
98109
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
99110
</ul>
111+
112+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
113+
<i class="fa fa-search"></i>
114+
</button>
115+
100116
</div>
101117

102-
<h1 class="menu-title">Kubernetes CSI Documentation</h1>
118+
<h1 class="menu-title">Kubernetes CSI Documentation</h1>
103119

104120
<div class="right-buttons">
105121
<a href="print.html" title="Print this book" aria-label="Print this book">
@@ -109,6 +125,17 @@ <h1 class="menu-title">Kubernetes CSI Documentation</h1>
109125
</div>
110126
</div>
111127

128+
129+
<div id="searchbar-outer" class="searchbar-outer">
130+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
131+
</div>
132+
<div id="searchresults-outer" class="searchresults-outer">
133+
<div class="searchresults-header" id="searchresults-header"></div>
134+
<ul id="searchresults">
135+
</ul>
136+
</div>
137+
138+
112139
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
113140
<script type="text/javascript">
114141
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
@@ -180,6 +207,15 @@ <h1 class="menu-title">Kubernetes CSI Documentation</h1>
180207

181208

182209

210+
<script src="searchindex.js" type="text/javascript" charset="utf-8"></script>
211+
212+
213+
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
214+
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
215+
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
216+
217+
218+
183219

184220
<script src="highlight.js"></script>
185221
<script src="book.js"></script>

‎docs/CSI-Kubernetes.html

+40-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang="en" class="sidebar-visible">
33
<head>
4+
<!-- Book generated using mdBook -->
45
<meta charset="UTF-8">
56
<title>Deploying in Kubernetes - Kubernetes CSI Documentation</title>
67
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
@@ -36,6 +37,14 @@
3637
}
3738
</script>
3839

40+
<noscript>
41+
<style type="text/css">
42+
.javascript-only {
43+
display: none;
44+
}
45+
</style>
46+
</noscript>
47+
3948
</head>
4049
<body class="light">
4150
<!-- Work around some values being stored in localStorage wrapped in quotes -->
@@ -65,12 +74,14 @@
6574

6675
<!-- Hide / unhide sidebar before it is displayed -->
6776
<script type="text/javascript">
77+
var html = document.querySelector('html');
6878
var sidebar = 'hidden';
6979
if (document.body.clientWidth >= 1080) {
7080
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
7181
sidebar = sidebar || 'visible';
7282
}
73-
document.querySelector('html').classList.add("sidebar-" + sidebar);
83+
html.classList.remove('sidebar-visible');
84+
html.classList.add("sidebar-" + sidebar);
7485
</script>
7586

7687
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
@@ -83,7 +94,7 @@
8394

8495
<div id="menu-bar" class="menu-bar">
8596
<div id="menu-bar-sticky-container">
86-
<div class="left-buttons">
97+
<div class="left-buttons javascript-only">
8798
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
8899
<i class="fa fa-bars"></i>
89100
</button>
@@ -97,9 +108,14 @@
97108
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
98109
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
99110
</ul>
111+
112+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
113+
<i class="fa fa-search"></i>
114+
</button>
115+
100116
</div>
101117

102-
<h1 class="menu-title">Kubernetes CSI Documentation</h1>
118+
<h1 class="menu-title">Kubernetes CSI Documentation</h1>
103119

104120
<div class="right-buttons">
105121
<a href="print.html" title="Print this book" aria-label="Print this book">
@@ -109,6 +125,17 @@ <h1 class="menu-title">Kubernetes CSI Documentation</h1>
109125
</div>
110126
</div>
111127

128+
129+
<div id="searchbar-outer" class="searchbar-outer">
130+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
131+
</div>
132+
<div id="searchresults-outer" class="searchresults-outer">
133+
<div class="searchresults-header" id="searchresults-header"></div>
134+
<ul id="searchresults">
135+
</ul>
136+
</div>
137+
138+
112139
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
113140
<script type="text/javascript">
114141
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
@@ -261,6 +288,15 @@ <h1 class="menu-title">Kubernetes CSI Documentation</h1>
261288

262289

263290

291+
<script src="searchindex.js" type="text/javascript" charset="utf-8"></script>
292+
293+
294+
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
295+
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
296+
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
297+
298+
299+
264300

265301
<script src="highlight.js"></script>
266302
<script src="book.js"></script>

0 commit comments

Comments
 (0)