Skip to content

Commit 99e9928

Browse files
authored
Merge pull request #84 from humblec/md
Correct markdown linter errors.
2 parents a7c6dec + 0421d1d commit 99e9928

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The CSI external-snapshotter is part of Kubernetes implementation of [Container Storage Interface (CSI)](https://github.com/container-storage-interface/spec).
44

5-
The volume snapshot feature supports CSI v1.0 and it has been an Alpha feature in Kubernetes since v1.12.
5+
The volume snapshot feature supports CSI v1.0 and it has been an Alpha feature in Kubernetes since v1.12.
66

77
## Overview
88

@@ -16,7 +16,7 @@ External snapshotter follows [controller](https://github.com/kubernetes/communit
1616

1717
Snapshotter talks to CSI over socket (/run/csi/socket by default, configurable by -csi-address). The snapshotter then:
1818

19-
* Discovers the supported snapshotter name by `GetDriverName` call.
19+
* Discovers the supported snapshotter name by `GetDriverName` call.
2020

2121
* Uses ControllerGetCapabilities for find out if CSI driver supports `ControllerServiceCapability_RPC_CREATE_DELETE_SNAPSHOT` and `ControllerServiceCapability_RPC_LIST_SNAPSHOTS` calls. Otherwise, the controller will not start.
2222

@@ -26,7 +26,6 @@ Snapshotter talks to CSI over socket (/run/csi/socket by default, configurable b
2626
* `SnapshotContentName` is not empty: the controller verifies whether the snapshot content exists and also binds to the snapshot. If verification passes, the controller binds the snapshot and its content objects and marks it is ready. Otherwise, it updates the error status of the snapshot.
2727
* `SnapshotContentName` is set empty: the controller will first check whether there is already a content object which binds the snapshot correctly with snapshot uid (`VolumeSnapshotRef.UID`) specified. If so, the controller binds these two objects. Otherwise, the controller issues a create snapshot operation. Please note that if the error status shows that snapshot creation already failed before, it will not try to create snapshot again.
2828

29-
3029
* Processes new/updated/deleted `VolumeSnapshotContents`: The snapshotter only processes `VolumeSnapshotContent` in which the CSI driver specified in the spec matches the controller's driver name.
3130
* If the `VolumeSnapshotRef` is set to nil, skip this content since it is not bound to any snapshot object.
3231
* Otherwise, the controller verifies whether the content object is correctly bound to a snapshot object. In case the `VolumeSnapshotRef.UID` is set but it does not match its snapshot object or snapshot no long exists, the content object and its associated snapshot will be deleted.
@@ -37,29 +36,30 @@ Snapshotter talks to CSI over socket (/run/csi/socket by default, configurable b
3736

3837
For debugging, it is possible to run snapshotter on command line. For example,
3938

40-
```
41-
$ csi-snapshotter -kubeconfig ~/.kube/config -v 5 -csi-address /run/csi/socket
39+
```bash
40+
csi-snapshotter -kubeconfig ~/.kube/config -v 5 -csi-address /run/csi/socket
4241
```
4342

4443
### Running in a statefulset
4544

4645
It is necessary to create a new service account and give it enough privileges to run the snapshotter. We provide .yaml files that deploy for use together with the hostpath example driver. A real production deployment must customize them:
4746

48-
```
49-
$ for i in $(find deploy/kubernetes -name '*.yaml'); do kubectl create -f $i; done
47+
```bash
48+
for i in $(find deploy/kubernetes -name '*.yaml'); do kubectl create -f $i; done
5049
```
5150

5251
## Testing
5352

5453
Running Unit Tests:
55-
```
56-
$ go test -timeout 30s github.com/kubernetes-csi/external-snapshotter/pkg/controller
54+
55+
```bash
56+
go test -timeout 30s github.com/kubernetes-csi/external-snapshotter/pkg/controller
5757
```
5858

5959
## Dependency Management
6060

61-
```
62-
$ dep ensure
61+
```bash
62+
dep ensure
6363
```
6464

6565
To modify dependencies or versions change `./Gopkg.toml`
@@ -70,8 +70,8 @@ Learn how to engage with the Kubernetes community on the [community page](http:/
7070

7171
You can reach the maintainers of this project at:
7272

73-
- [Slack channel](https://kubernetes.slack.com/messages/sig-storage)
74-
- [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-storage)
73+
* [Slack channel](https://kubernetes.slack.com/messages/sig-storage)
74+
* [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-storage)
7575

7676
### Code of conduct
7777

0 commit comments

Comments
 (0)