kubernetes-csi/docs

Stars
140
Rank 261,473 (Top 6 %)
Language
CSS
License
Apache License 2.0
Created almost 7 years ago
Updated 4 months ago

kubernetes-csi/docs

kubernetes-csi

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Documentation for CSI integration with Kubernetes

Kubernetes-CSI Documentation

This repository contains documentation capturing how to develop and deploy a Container Storage Interface (CSI) driver on Kubernetes.

To access the documentation go to: kubernetes-csi.github.io/docs

To make changes to the documentation, modify the files in book/src and submit a new PR.

Once the PR is reviewed and merged, the CI will automatically generate (using mdbook) the HTML to serve and check it in to src/_book.

To update the CRD API documentation, run:

./hack/gen-api.sh

The script uses the gen-crd-api-reference-docs tool to generate a markdown document for the VolumeSnapshot CRD API. See the script for more information and supported configuration.

Community, discussion, contribution, and support

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

You can reach the maintainers of this project at:

Code of conduct

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

To start editing on localhost

$ git clone [email protected]:kubernetes-csi/docs.git
$ cd docs
$ make $(pwd)/mdbook
$ make serve

Access to http:localhost:3000 and you can view a book on localhost!

csi-driver-nfs

This driver allows Kubernetes to access NFS server on Linux node.

external-snapshotter

Sidecar container that watches Kubernetes Snapshot CRD objects and triggers CreateSnapshot/DeleteSnapshot against a CSI endpoint.

csi-driver-smb

This driver allows Kubernetes to access SMB Server on both Linux and Windows nodes.

external-provisioner

Sidecar container that watches Kubernetes PersistentVolumeClaim objects and triggers CreateVolume/DeleteVolume against a CSI endpoint

csi-driver-host-path

A sample (non-production) CSI Driver that creates a local directory as a volume on a single node

external-attacher

Sidecar container that watches Kubernetes VolumeAttachment objects and triggers ControllerPublish/Unpublish against a CSI endpoint

csi-test

CSI test frameworks

node-driver-registrar

Sidecar container that registers a CSI driver with the kubelet using the kubelet plugin registration mechanism.

external-resizer

Sidecar container that watches Kubernetes PersistentVolumeClaims objects and triggers controller side expansion operation against a CSI endpoint

csi-driver-iscsi

livenessprobe

A sidecar container that can be included in a CSI plugin pod to enable integration with Kubernetes Liveness Probe.

external-health-monitor

This repo contains sidecar controller and agent for volume health monitoring.

csi-driver-nvmf

CSI driver NVMf mainly supports RDMA and TCP for Software Defined Storage by NVMf

csi-proxy

CSI Proxy utility to enable CSI Plugins on Windows

csi-lib-utils

Common code for Kubernetes CSI sidecar containers (e.g. `external-attacher`, `external-provisioner`, etc.)

driver-registrar

[Deprecated] Sidecar container that 1) registers the CSI driver with kubelet, and 2) adds the drivers custom NodeId to a label on the Kubernetes Node API Object

csi-release-tools

shared build and test files used by kubernetes-csi projects

lib-volume-populator

Shared library for use by volume populators.

csi-lib-iscsi

cluster-driver-registrar

DEPRECATED: Sidecar container that registers the CSI driver with the Kubernetes cluster

kubernetes-csi.github.io

volume-data-source-validator

Controller responsible for validating PVC data sources

external-snapshot-metadata

This repo contains sidecar controller for the snapshot metadata service.

.github

Default files for all repos in the Kubernetes CSI GitHub org