-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
405 lines (375 loc) · 21.1 KB
/
index.html
File metadata and controls
405 lines (375 loc) · 21.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>CSI-Addons - Advanced Storage Operations for Kubernetes</title>
<meta name="description" content="CSI-Addons extends the Container Storage Interface specification with advanced storage operations for Kubernetes including volume replication, space reclamation, network fencing, and more.">
<link rel="stylesheet" href="css/style.css">
<link rel="icon" type="image/svg+xml" href="images/favicon.svg">
</head>
<body>
<!-- Navigation -->
<nav class="navbar" id="navbar">
<div class="container nav-container">
<a href="#" class="nav-logo">
<svg class="logo-icon" viewBox="0 0 32 32" width="32" height="32" fill="none" xmlns="http://www.w3.org/2000/svg">
<rect width="32" height="32" rx="6" fill="#2563eb"/>
<path d="M8 12h6v8H8zM18 8h6v12h-6zM13 16h6v4h-6z" fill="#fff" opacity="0.9"/>
<path d="M13 10h6v4h-6z" fill="#93c5fd"/>
</svg>
<span>CSI-Addons</span>
</a>
<button class="nav-toggle" id="nav-toggle" aria-label="Toggle navigation">
<span></span><span></span><span></span>
</button>
<ul class="nav-links" id="nav-links">
<li><a href="#features">Features</a></li>
<li><a href="#architecture">Architecture</a></li>
<li><a href="#getting-started">Get Started</a></li>
<li><a href="#repositories">Repositories</a></li>
<li><a href="#community">Community</a></li>
<li><a href="https://github.com/csi-addons" class="nav-github" target="_blank" rel="noopener">GitHub</a></li>
</ul>
</div>
</nav>
<!-- Hero Section -->
<section class="hero">
<div class="container">
<div class="hero-content">
<h1>Advanced Storage Operations for Kubernetes</h1>
<p class="hero-subtitle">
CSI-Addons extends the <a href="https://github.com/container-storage-interface/spec" target="_blank" rel="noopener">Container Storage Interface</a>
with powerful operations for disaster recovery, performance optimization, and operational management of storage volumes.
</p>
<div class="hero-actions">
<a href="#getting-started" class="btn btn-primary">Get Started</a>
<a href="https://github.com/csi-addons/spec" class="btn btn-secondary" target="_blank" rel="noopener">View Spec</a>
</div>
</div>
<div class="hero-visual">
<div class="hero-diagram">
<div class="diagram-layer layer-app">
<span>Kubernetes CRs</span>
</div>
<div class="diagram-arrow"></div>
<div class="diagram-layer layer-controller">
<span>CSI-Addons Controller</span>
</div>
<div class="diagram-arrow"></div>
<div class="diagram-layer layer-sidecar">
<span>CSI-Addons Sidecar</span>
</div>
<div class="diagram-arrow"></div>
<div class="diagram-layer layer-storage">
<span>Storage Backend</span>
</div>
</div>
</div>
</div>
</section>
<!-- Features Section -->
<section class="features" id="features">
<div class="container">
<h2 class="section-title">Key Features</h2>
<p class="section-subtitle">A comprehensive set of storage operations beyond the core CSI specification</p>
<div class="features-grid">
<!-- BEGIN:FEATURES -->
<div class="feature-card">
<div class="feature-icon icon-replication">
<svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="4" y="10" width="16" height="20" rx="3" stroke="currentColor" stroke-width="2.5"/><rect x="28" y="18" width="16" height="20" rx="3" stroke="currentColor" stroke-width="2.5"/><path d="M20 20h8m0 0l-3-3m3 3l-3 3" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28 30h-8m0 0l3-3m-3 3l3 3" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/></svg>
</div>
<h3>Volume Replication</h3>
<p>Define a standard that will enable storage vendors (SP) to develop controllers/plugins for DR or to talk to the different CO systems.<br><small class="feature-rpcs">Operations: Enable Volume Replication, Disable Volume Replication, Promote Volume, Demote Volume, Resync Volume, Get Volume Replication Info</small></p>
</div>
<div class="feature-card">
<div class="feature-icon icon-reclaim">
<svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="8" y="8" width="32" height="32" rx="4" stroke="currentColor" stroke-width="2.5"/><path d="M16 30V18h4l6 8V18" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M30 18v12" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/><path d="M34 18v12" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/></svg>
</div>
<h3>Reclaim Space</h3>
<p>Define an extension to the CSI Specification that will enable storage vendors (SP) to develop controllers/plugins that can free unused storage allocations from existing volumes.<br><small class="feature-rpcs">Operations: Controller Reclaim Space, Node Reclaim Space</small></p>
</div>
<div class="feature-card">
<div class="feature-icon icon-fence">
<svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="24" cy="24" r="16" stroke="currentColor" stroke-width="2.5"/><path d="M14 14l20 20M14 34l20-20" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/><circle cx="24" cy="24" r="6" stroke="currentColor" stroke-width="2.5"/></svg>
</div>
<h3>Network Fencing</h3>
<p>Define a standard that will enable storage providers (SP) to perform node level fencing using corresponding CIDR blocks.<br><small class="feature-rpcs">Operations: Fence Cluster Network, Unfence Cluster Network, List Cluster Fence, Get Fence Clients</small></p>
</div>
<div class="feature-card">
<div class="feature-icon icon-group">
<svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="6" y="14" width="12" height="16" rx="2" stroke="currentColor" stroke-width="2.5"/><rect x="18" y="10" width="12" height="20" rx="2" stroke="currentColor" stroke-width="2.5"/><rect x="30" y="14" width="12" height="16" rx="2" stroke="currentColor" stroke-width="2.5"/><path d="M24 6v4M24 30v6" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/></svg>
</div>
<h3>Volume Groups</h3>
<p>Define a standard that will enable storage vendors (SP) to develop controllers/plugins for managing VolumeGroups.<br><small class="feature-rpcs">Operations: Create Volume Group, Modify Volume Group Membership, Delete Volume Group, List Volume Groups, Controller Get Volume Group</small></p>
</div>
<div class="feature-card">
<div class="feature-icon icon-encryption">
<svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="10" y="20" width="28" height="20" rx="3" stroke="currentColor" stroke-width="2.5"/><path d="M16 20v-6a8 8 0 1116 0v6" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/><circle cx="24" cy="31" r="3" fill="currentColor"/><path d="M24 34v3" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/></svg>
</div>
<h3>Encryption Key Rotation</h3>
<p>Define an extension to the CSI specification that will enable storage vendors (SP) to develop controllers/plugins that can rotate the Key Encryption Keys (KEK) of existing volumes that are encrypted.<br><small class="feature-rpcs">Operations: Encryption Key Rotate</small></p>
</div>
<div class="feature-card">
<div class="feature-icon icon-identity">
<svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="24" cy="16" r="8" stroke="currentColor" stroke-width="2.5"/><path d="M10 40c0-7.732 6.268-14 14-14s14 6.268 14 14" stroke="currentColor" stroke-width="2.5" stroke-linecap="round"/><path d="M30 14l4-4m0 0h-4m4 0v4" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/></svg>
</div>
<h3>Identity Service</h3>
<p>Define an API that makes it possible for the CSI-Addons plugin for a CO to communicate with CSI-driver components that can execute storage maintenance operations.<br><small class="feature-rpcs">Operations: Get Identity, Get Capabilities, Probe</small></p>
</div>
<!-- END:FEATURES -->
</div>
</div>
</section>
<!-- Architecture Section -->
<section class="architecture" id="architecture">
<div class="container">
<h2 class="section-title">Architecture</h2>
<p class="section-subtitle">A modular design built on Kubernetes Custom Resources and gRPC</p>
<div class="arch-grid">
<div class="arch-component">
<div class="arch-header">
<h3>Controller Manager</h3>
</div>
<p>Watches for Custom Resources in Kubernetes, discovers CSI-Addons sidecars, and routes operations to appropriate drivers. Supports leader election for high availability.</p>
<ul class="arch-details">
<li>Manages operation lifecycle and retries</li>
<li>Auto-creates CronJobs from annotations</li>
<li>TLS + token-based authentication</li>
</ul>
</div>
<div class="arch-component">
<div class="arch-header">
<h3>Sidecar</h3>
</div>
<p>Runs alongside CSI driver containers, registers with the controller via CSIAddonsNode CRs, and translates gRPC calls into driver operations.</p>
<ul class="arch-details">
<li>Auto-registers with CSIAddonsNode CR</li>
<li>Volume health condition reporting</li>
<li>Pluggable operation support</li>
</ul>
</div>
<div class="arch-component">
<div class="arch-header">
<h3>Custom Resources</h3>
</div>
<p>Kubernetes-native interface for all storage operations. Users create CRs to trigger operations, and status is reported back through CR conditions.</p>
<ul class="arch-details">
<!-- BEGIN:CRDS -->
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/csiaddonsnode.md" target="_blank" rel="noopener">CSIAddonsNode</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/encryptionkeyrotation.md" target="_blank" rel="noopener">EncryptionKeyRotationCronJob</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/encryptionkeyrotation.md" target="_blank" rel="noopener">EncryptionKeyRotationJob</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/networkfence.md" target="_blank" rel="noopener">NetworkFence</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/networkfenceclass.md" target="_blank" rel="noopener">NetworkFenceClass</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/reclaimspace.md" target="_blank" rel="noopener">ReclaimSpaceCronJob</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/reclaimspace.md" target="_blank" rel="noopener">ReclaimSpaceJob</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/volumegroupreplication.md" target="_blank" rel="noopener">VolumeGroupReplication</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/volumegroupreplicationclass.md" target="_blank" rel="noopener">VolumeGroupReplicationClass</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/volumegroupreplicationcontent.md" target="_blank" rel="noopener">VolumeGroupReplicationContent</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons/blob/main/docs/volumereplicationclass.md" target="_blank" rel="noopener">VolumeReplicationClass</a></li>
<!-- END:CRDS -->
</ul>
</div>
</div>
<div class="arch-flow">
<h3>Operation Flow</h3>
<div class="flow-steps">
<div class="flow-step">
<div class="flow-number">1</div>
<p>User creates a Custom Resource (e.g., ReclaimSpaceJob)</p>
</div>
<div class="flow-connector"></div>
<div class="flow-step">
<div class="flow-number">2</div>
<p>Controller Manager watches and processes the CR</p>
</div>
<div class="flow-connector"></div>
<div class="flow-step">
<div class="flow-number">3</div>
<p>Controller sends gRPC request to the appropriate Sidecar</p>
</div>
<div class="flow-connector"></div>
<div class="flow-step">
<div class="flow-number">4</div>
<p>Sidecar forwards the operation to the CSI Driver</p>
</div>
<div class="flow-connector"></div>
<div class="flow-step">
<div class="flow-number">5</div>
<p>Status is reported back through the CR</p>
</div>
</div>
</div>
</div>
</section>
<!-- Getting Started Section -->
<section class="getting-started" id="getting-started">
<div class="container">
<h2 class="section-title">Getting Started</h2>
<p class="section-subtitle">Deploy CSI-Addons on your Kubernetes cluster in minutes</p>
<div class="tabs">
<div class="tab-buttons">
<button class="tab-btn active" data-tab="yaml">YAML</button>
<button class="tab-btn" data-tab="kustomize">Kustomize</button>
<button class="tab-btn" data-tab="operator">Operator SDK</button>
</div>
<div class="tab-content active" id="tab-yaml">
<h3>Deploy with YAML manifests</h3>
<div class="code-block">
<div class="code-header">
<span>bash</span>
<button class="copy-btn" data-target="code-yaml">Copy</button>
</div>
<pre><code id="code-yaml"># Set the release version
export RELEASE="v0.14.0"
# Install CRDs
kubectl create -f \
https://github.com/csi-addons/kubernetes-csi-addons/releases/download/${RELEASE}/crds.yaml
# Install RBAC
kubectl create -f \
https://github.com/csi-addons/kubernetes-csi-addons/releases/download/${RELEASE}/rbac.yaml
# Deploy the controller
kubectl create -f \
https://github.com/csi-addons/kubernetes-csi-addons/releases/download/${RELEASE}/setup-controller.yaml</code></pre>
</div>
</div>
<div class="tab-content" id="tab-kustomize">
<h3>Deploy with Kustomize</h3>
<div class="code-block">
<div class="code-header">
<span>bash</span>
<button class="copy-btn" data-target="code-kustomize">Copy</button>
</div>
<pre><code id="code-kustomize"># Clone the repository
git clone https://github.com/csi-addons/kubernetes-csi-addons.git
cd kubernetes-csi-addons
# Deploy using make
make deploy</code></pre>
</div>
</div>
<div class="tab-content" id="tab-operator">
<h3>Deploy with Operator SDK</h3>
<div class="code-block">
<div class="code-header">
<span>bash</span>
<button class="copy-btn" data-target="code-operator">Copy</button>
</div>
<pre><code id="code-operator"># Create the namespace
kubectl create namespace storage-csi-addons
# Run the operator bundle
operator-sdk run bundle \
-n storage-csi-addons \
quay.io/csiaddons/k8s-bundle:latest</code></pre>
</div>
</div>
</div>
<div class="example-cr">
<h3>Example: Reclaim Space on a PVC</h3>
<div class="code-block">
<div class="code-header">
<span>yaml</span>
<button class="copy-btn" data-target="code-example">Copy</button>
</div>
<pre><code id="code-example">apiVersion: csiaddons.openshift.io/v1alpha1
kind: ReclaimSpaceJob
metadata:
name: reclaim-space-my-pvc
spec:
target:
persistentVolumeClaim: my-pvc
backOffLimit: 10
timeout: 600</code></pre>
</div>
</div>
</div>
</section>
<!-- Repositories Section -->
<section class="repositories" id="repositories">
<div class="container">
<h2 class="section-title">Repositories</h2>
<p class="section-subtitle">The CSI-Addons ecosystem is composed of several focused repositories</p>
<div class="repo-grid">
<a href="https://github.com/csi-addons/spec" class="repo-card" target="_blank" rel="noopener">
<div class="repo-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M14 2H6a2 2 0 00-2 2v16a2 2 0 002 2h12a2 2 0 002-2V8z"/><polyline points="14,2 14,8 20,8"/><line x1="16" y1="13" x2="8" y2="13"/><line x1="16" y1="17" x2="8" y2="17"/><polyline points="10,9 9,9 8,9"/></svg>
</div>
<h3>spec</h3>
<p>gRPC specification and protocol buffer definitions for all CSI-Addons operations.</p>
</a>
<a href="https://github.com/csi-addons/kubernetes-csi-addons" class="repo-card" target="_blank" rel="noopener">
<div class="repo-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polygon points="12,2 22,8.5 22,15.5 12,22 2,15.5 2,8.5"/><line x1="12" y1="22" x2="12" y2="15.5"/><polyline points="22,8.5 12,15.5 2,8.5"/><polyline points="2,15.5 12,8.5 22,15.5"/><line x1="12" y1="2" x2="12" y2="8.5"/></svg>
</div>
<h3>kubernetes-csi-addons</h3>
<p>Kubernetes controllers, sidecar, and CLI tool. The reference implementation of CSI-Addons.</p>
</a>
</div>
</div>
</section>
<!-- Community Section -->
<section class="community" id="community">
<div class="container">
<h2 class="section-title">Community</h2>
<p class="section-subtitle">CSI-Addons is an open-source, community-driven project</p>
<div class="community-grid">
<div class="community-card">
<h3>Mailing List</h3>
<p>Join the open discussion list for questions, proposals, and announcements.</p>
<a href="https://groups.google.com/a/redhat.com/g/csi-addons/about" class="btn btn-outline" target="_blank" rel="noopener">Join the List</a>
</div>
<div class="community-card">
<h3>Archives</h3>
<p>Browse past discussions and decisions in the mailing list archives. Requires joining the list with a Google account.</p>
<a href="https://groups.google.com/a/redhat.com/g/csi-addons" class="btn btn-outline" target="_blank" rel="noopener">View Archives</a>
</div>
<div class="community-card">
<h3>Contribute</h3>
<p>Contribute code, report bugs, or suggest features on GitHub.</p>
<a href="https://github.com/csi-addons" class="btn btn-outline" target="_blank" rel="noopener">GitHub Organization</a>
</div>
</div>
</div>
</section>
<!-- Footer -->
<footer class="footer">
<div class="container">
<div class="footer-content">
<div class="footer-brand">
<span class="footer-logo">CSI-Addons</span>
<p>Advanced storage operations for Kubernetes</p>
</div>
<div class="footer-links">
<div class="footer-col">
<h4>Project</h4>
<ul>
<li><a href="#features">Features</a></li>
<li><a href="#architecture">Architecture</a></li>
<li><a href="#getting-started">Get Started</a></li>
</ul>
</div>
<div class="footer-col">
<h4>Resources</h4>
<ul>
<li><a href="https://github.com/csi-addons/spec" target="_blank" rel="noopener">Specification</a></li>
<li><a href="https://github.com/csi-addons/kubernetes-csi-addons" target="_blank" rel="noopener">Kubernetes Implementation</a></li>
<li><a href="https://github.com/csi-addons" target="_blank" rel="noopener">All Repositories</a></li>
</ul>
</div>
<div class="footer-col">
<h4>Community</h4>
<ul>
<li><a href="https://groups.google.com/a/redhat.com/g/csi-addons/about" target="_blank" rel="noopener">Mailing List</a></li>
<li><a href="https://github.com/csi-addons" target="_blank" rel="noopener">GitHub</a></li>
</ul>
</div>
</div>
</div>
<div class="footer-bottom">
<p>Licensed under the <a href="https://github.com/csi-addons/csi-addons.github.io/blob/main/LICENSE" target="_blank" rel="noopener">Apache License 2.0</a>.
</p>
</div>
</div>
</footer>
<script src="js/main.js"></script>
</body>
</html>