Merge pull request #74 from dims/add-support-for-csi

Add support for csi

Author: dims

Makefile

@@ -31,7 +31,7 @@ endif
 depend-update: work
 	cd $(DEST) && glide update
 
-build: openstack-cloud-controller-manager cinder-provisioner cinder-flex-volume-driver k8s-keystone-auth
+build: openstack-cloud-controller-manager cinder-provisioner cinder-flex-volume-driver cinder-csi-plugin k8s-keystone-auth
 
 openstack-cloud-controller-manager: depend $(SOURCES)
 	cd $(DEST) && CGO_ENABLED=0 GOOS=$(GOOS) go build \
@@ -45,6 +45,12 @@ cinder-provisioner: depend $(SOURCES)
 		-o cinder-provisioner \
 		cmd/cinder-provisioner/main.go
 
+cinder-csi-plugin: depend $(SOURCES)
+	cd $(DEST) && CGO_ENABLED=0 GOOS=$(GOOS) go build \
+		-ldflags "-X 'main.version=${VERSION}'" \
+		-o cinder-csi-plugin \
+		cmd/cinder-csi-plugin/main.go
+
 cinder-flex-volume-driver: depend $(SOURCES)
 	cd $(DEST) && CGO_ENABLED=0 GOOS=$(GOOS) go build \
 		-ldflags "-X 'main.version=${VERSION}'" \
@@ -123,7 +129,7 @@ install-distro-packages:
 	tools/install-distro-packages.sh
 
 clean:
-	rm -rf .bindep openstack-cloud-controller-manager cinder-flex-volume-driver cinder-provisioner k8s-keystone-auth
+	rm -rf .bindep openstack-cloud-controller-manager cinder-flex-volume-driver cinder-provisioner cinder-csi-plugin k8s-keystone-auth
 
 realclean: clean
 	rm -rf vendor
@@ -134,7 +140,7 @@ realclean: clean
 shell: work
 	cd $(DEST) && $(SHELL) -i
 
-images: image-controller-manager image-flex-volume-driver image-provisioner image-k8s-keystone-auth
+images: image-controller-manager image-flex-volume-driver image-provisioner image-csi-plugin image-k8s-keystone-auth
 
 image-controller-manager: depend openstack-cloud-controller-manager
 ifeq ($(GOOS),linux)
@@ -163,6 +169,15 @@ else
 	$(error Please set GOOS=linux for building the image)
 endif
 
+image-csi-plugin: depend cinder-csi-plugin
+ifeq ($(GOOS),linux)
+	cp cinder-csi-plugin cluster/images/cinder-csi-plugin
+	docker build -t $(REGISTRY)/cinder-csi-plugin:$(VERSION) cluster/images/cinder-csi-plugin
+	rm cluster/images/cinder-csi-plugin/cinder-csi-plugin
+else
+	$(error Please set GOOS=linux for building the image)
+endif
+
 image-k8s-keystone-auth: depend k8s-keystone-auth
 ifeq ($(GOOS),linux)
 	cp k8s-keystone-auth cluster/images/webhook

cluster/images/cinder-csi-plugin/Dockerfile

@@ -0,0 +1,11 @@
+# Based on centos
+FROM centos:7.4.1708
+LABEL maintainers="Kubernetes Authors"
+LABEL description="Cinder CSI Plugin"
+
+# Install e4fsprogs for format
+RUN yum -y install e4fsprogs
+
+ADD cinder-csi-plugin /bin/
+
+CMD ["/bin/cinder-csi-plugin"]

cmd/cinder-csi-plugin/main.go

@@ -0,0 +1,72 @@
+/*
+Copyright 2017 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+
+	"git.openstack.org/openstack/openstack-cloud-controller-manager/pkg/csi/cinder"
+	"github.com/spf13/cobra"
+)
+
+var (
+	endpoint    string
+	nodeID      string
+	cloudconfig string
+)
+
+func init() {
+	flag.Set("logtostderr", "true")
+}
+
+func main() {
+
+	flag.CommandLine.Parse([]string{})
+
+	cmd := &cobra.Command{
+		Use:   "Cinder",
+		Short: "CSI based Cinder driver",
+		Run: func(cmd *cobra.Command, args []string) {
+			handle()
+		},
+	}
+
+	cmd.Flags().AddGoFlagSet(flag.CommandLine)
+
+	cmd.PersistentFlags().StringVar(&nodeID, "nodeid", "", "node id")
+	cmd.MarkPersistentFlagRequired("nodeid")
+
+	cmd.PersistentFlags().StringVar(&endpoint, "endpoint", "", "CSI endpoint")
+	cmd.MarkPersistentFlagRequired("endpoint")
+
+	cmd.PersistentFlags().StringVar(&cloudconfig, "cloud-config", "", "CSI driver cloud config")
+	cmd.MarkPersistentFlagRequired("cloud-config")
+
+	if err := cmd.Execute(); err != nil {
+		fmt.Fprintf(os.Stderr, "%s", err.Error())
+		os.Exit(1)
+	}
+
+	os.Exit(0)
+}
+
+func handle() {
+	d := cinder.NewDriver(nodeID, endpoint, cloudconfig)
+	d.Run()
+}

docs/using-cinder-csi-plugin.md

@@ -0,0 +1,97 @@
+# CSI Cinder driver
+
+## Kubernetes
+
+### Requirements
+
+The following feature gates and runtime config have to be enabled to deploy the driver.
+
+```
+FEATURE_GATES=CSIPersistentVolume=true,MountPropagation=true
+RUNTIME_CONFIG="storage.k8s.io/v1alpha1=true"
+```
+
+Mountprogpation requires support for privileged containers. So, make sure privileged containers are enabled in the cluster.
+
+### Example local-up-cluster.sh
+
+```ALLOW_PRIVILEGED=true FEATURE_GATES=CSIPersistentVolume=true,MountPropagation=true RUNTIME_CONFIG="storage.k8s.io/v1alpha1=true" LOG_LEVEL=5 hack/local-up-cluster.sh```
+
+### Deploy
+
+Encode your ```cloud.conf``` file content using base64.
+
+```base64 -w 0 cloud.conf```
+
+Update ```cloud.conf``` configuration in ```deploy/kubernetes/csi-secret-cinderplugin.yaml``` file
+by using the result of the above command.
+
+```kubectl -f deploy/kubernetes create```
+
+### Example Nginx application
+
+```kubectl -f examples/kubernetes/nginx.yaml create```
+
+## Using CSC tool
+
+### Start Cinder driver
+```
+$ sudo ./_output/cinderplugin --endpoint tcp://127.0.0.1:10000 --cloud-config /etc/cloud.conf --nodeid CSINodeID
+```
+
+### Test using csc
+Get ```csc``` tool from https://github.com/thecodeteam/gocsi/tree/master/csc
+
+#### Get plugin info
+```
+$ csc identity plugin-info --endpoint tcp://127.0.0.1:10000
+"csi-cinderplugin"	"0.1.0"
+```
+
+#### Get supported versions
+```
+$ csc identity supported-versions --endpoint tcp://127.0.0.1:10000
+0.1.0
+```
+
+#### Create a volume
+```
+$ csc controller new --endpoint tcp://127.0.0.1:10000 CSIVolumeName
+CSIVolumeID
+```
+
+#### Delete a volume
+```
+$ csc controller del --endpoint tcp://127.0.0.1:10000 CSIVolumeID
+CSIVolumeID
+```
+
+#### ControllerPublish a volume
+```
+$ csc controller publish --endpoint tcp://127.0.0.1:10000 --node-id=CSINodeID CSIVolumeID
+CSIVolumeID	"DevicePath"="/dev/xxx"
+```
+
+#### ControllerUnpublish a volume
+```
+$ csc controller unpublish --endpoint tcp://127.0.0.1:10000 --node-id=CSINodeID CSIVolumeID
+CSIVolumeID
+```
+
+#### NodePublish a volume
+```
+$ csc node publish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/cinder --pub-info DevicePath="/dev/xxx" CSIVolumeID
+CSIVolumeID
+```
+
+#### NodeUnpublish a volume
+```
+$ csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path /mnt/cinder CSIVolumeID
+CSIVolumeID
+```
+
+#### Get NodeID
+```
+$ csc node get-id --endpoint tcp://127.0.0.1:10000
+CSINodeID
+```

examples/cinder-csi-plugin/nginx.yaml

@@ -0,0 +1,44 @@
+# This YAML file contains nginx & csi cinder driver objects,
+# which are necessary to run nginx with csi cinder driver.
+
+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: csi-sc-cinderplugin
+provisioner: csi-cinderplugin
+parameters:
+
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: csi-pvc-cinderplugin
+spec:
+  accessModes:
+  - ReadWriteOnce
+  resources:
+    requests:
+      storage: 1Gi
+  storageClassName: csi-sc-cinderplugin
+
+---
+apiVersion: v1
+kind: Pod
+metadata:
+  name: nginx 
+spec:
+  containers:
+  - image: nginx
+    imagePullPolicy: IfNotPresent
+    name: nginx
+    ports:
+    - containerPort: 80
+      protocol: TCP
+    volumeMounts:
+      - mountPath: /var/lib/www/html
+        name: csi-data-cinderplugin 
+  volumes:
+  - name: csi-data-cinderplugin
+    persistentVolumeClaim:
+      claimName: csi-pvc-cinderplugin
+      readOnly: false