Skip to content

Commit

Permalink
refactor documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Bala.FA <[email protected]>
  • Loading branch information
balamurugana committed Jun 24, 2023
1 parent bfff552 commit bac77e5
Show file tree
Hide file tree
Showing 27 changed files with 1,251 additions and 1,083 deletions.
24 changes: 24 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# DirectPV
DirectPV is a CSI driver to provision local volumes to Pods using [Direct Attached Storage](https://en.wikipedia.org/wiki/Direct-attached_storage). It comes with two components.
1. `DirectPV plugin` - To be installed on local machine, to manage DirectPV CSI driver.
2. `DirectPV CSI driver` - To be installed on kubernetes cluster, to provision local volumes.

## For new users
Refer below documentation
* [Installation guide](./installation.md)
* [Drive management guide](./drive-management.md)
* [Volume provisioning guide](./volume-provisioning.md)
* [Volume management guide](./volume-management.md)
* [Command reference guide](./command-reference.md)
* [Monitoring guide](./monitoring.md)

## For existing users
Refer below documentation
* [Upgrade guide](./upgrade.md)
* [Node management guide](./node-management.md)

## Further references
* [Volume scheduling guide](./volume-scheduling.md)
* [Issue reporting](./issue-reporting.md)
* [DirectPV CSI driver specification](./specification.md)
* [Troubleshooting guide](./troubleshooting.md)
234 changes: 96 additions & 138 deletions docs/architecture.md

Large diffs are not rendered by default.

Loading

0 comments on commit bac77e5

Please sign in to comment.