v1.0.0 changes (#61)

- driver name change
- Non-default namespace support 
- MULTI-STAGE build support 
- Removed auto unmount functionality
- Added check to reject the ReadOnlyMany volume creation request.
- Improved log collection tool
- Improved generate_pv_yaml
- CSI Sanity changes
- README update
- New custom SCC

Author: deeghuge

contributing.md renamed to CONTRIBUTING.md

@@ -1,6 +1,31 @@
-------------------------------
-Sign your work for submittal
-------------------------------
+[go_effectivego]: https://golang.org/doc/effective_go.html
+[go_gettingstarted]: https://github.com/golang/go/wiki#getting-started-with-go
+[go_goreturns]: https://github.com/sqs/goreturns
+[go_golangci-lint]: https://github.com/golangci/golangci-lint#install
+[go_codecomments]: https://github.com/golang/go/wiki/CodeReviewComments
+
+# Contributing
+
+## Before You Submit a Pull Request
+
+1. Follow [coding practices](#coding-practices)
+2. [Verify](#run-local-verifications) your pull request
+3. [Sign your work](#sign-your-work-for-submittal) (required)
+
+### Coding Practices
+
+* Go 
+    - get started with [go-lang][go_gettingstarted]
+    - practice [Effective Go][go_effectivego]
+    - format code with [goreturns][go_goreturns]
+    - keep in mind [common review comments][go_codecomments]
+
+### Run Local Verifications
+You can run these verifications locally to predict the pass or fail of continuous integration.
+
+* ```goreturns -d ./```
+
+### Sign your work for submittal
 
 The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
 

Dockerfile

@@ -1,7 +1,14 @@
 FROM registry.access.redhat.com/ubi7-minimal:latest
-LABEL maintainers="IBM Spectrum Scale"
-LABEL description="CSI Plugin for IBM Spectrum Scale"
+LABEL name="IBM Spectrum Scale CSI driver" \
+      vendor="ibm" \
+      version="1.0.0" \
+      release="1" \
+      run='docker run ibm-spectrum-scale-csi-driver' \
+      summary="An implementation of CSI Plugin for the IBM Spectrum Scale product."\
+      description="CSI Plugin for IBM Spectrum Scale"\
+      maintainers="IBM Spectrum Scale"
+COPY licenses /licenses
 
-COPY _output/csi-spectrum-scale /csi-spectrum-scale
-RUN chmod +x /csi-spectrum-scale
-ENTRYPOINT ["/csi-spectrum-scale"]
+COPY _output/ibm-spectrum-scale-csi /ibm-spectrum-scale-csi
+RUN chmod +x /ibm-spectrum-scale-csi
+ENTRYPOINT ["/ibm-spectrum-scale-csi"]

Dockerfile.msb

@@ -0,0 +1,23 @@
+# MULTI-STAGE BUILD for IBM Spectrum Scale CSI Driver
+
+FROM golang:1.13.1 AS builder
+RUN wget -q -O $GOPATH/bin/dep https://github.com/golang/dep/releases/download/v0.5.1/dep-linux-amd64
+RUN chmod +x $GOPATH/bin/dep && export PATH=$PATH:$GOPATH/bin
+WORKDIR /go/src/github.com/IBM/ibm-spectrum-scale-csi-driver/
+COPY . .
+RUN [ -d /go/src/github.com/IBM/ibm-spectrum-scale-csi-driver/vendor ] || dep ensure
+RUN CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-extldflags "-static"' -o  _output/ibm-spectrum-scale-csi ./cmd/ibm-spectrum-scale-csi
+
+FROM registry.access.redhat.com/ubi7-minimal:latest
+LABEL name="IBM Spectrum Scale CSI driver" \
+      vendor="ibm" \
+      version="1.0.0" \
+      release="1" \
+      run='docker run ibm-spectrum-scale-csi-driver' \
+      summary="An implementation of CSI Plugin for the IBM Spectrum Scale product."\
+      description="CSI Plugin for IBM Spectrum Scale"\
+      maintainers="IBM Spectrum Scale"
+COPY licenses /licenses
+COPY --from=builder /go/src/github.com/IBM/ibm-spectrum-scale-csi-driver/_output/ibm-spectrum-scale-csi /ibm-spectrum-scale-csi
+RUN chmod +x /ibm-spectrum-scale-csi
+ENTRYPOINT ["/ibm-spectrum-scale-csi"]

MANUAL_BUILD.md

@@ -0,0 +1,54 @@
+
+# Manual Build
+
+
+## Using local golang build environment to build the CSI driver code
+
+	This method involves installation of golang and dep package on local build machine
+
+1. Install the latest version of Go and add it to PATH. Refer https://golang.org/
+
+   ```
+   export PATH=$PATH:<go_install_dir>/bin
+   ```
+
+2. Set your GOPATH to a directory where you want to clone the repo
+
+   ```
+   export GOPATH=<path_to_repo_base>
+   ```
+
+3. Clone the code
+
+   ```
+   mkdir -p $GOPATH/src/github.com/IBM
+   cd $GOPATH/src/github.com/IBM
+   git clone https://github.com/IBM/ibm-spectrum-scale-csi-driver.git
+   ```
+
+4. Build
+
+     4.1 Get dep (*Go's dependency manager*), which will be used by Makefile:
+
+     ```
+     wget --directory-prefix=/tmp/ https://github.com/golang/dep/releases/download/v0.5.1/dep-linux-amd64
+     mkdir -p $GOPATH/bin
+     mv /tmp/dep-linux-amd64 $GOPATH/bin/dep
+     chmod +x $GOPATH/bin/dep
+     export PATH=$PATH:$GOPATH/bin
+     ```
+  
+     4.2 Compile:
+
+     ```
+     cd $GOPATH/src/github.com/IBM/ibm-spectrum-scale-csi-driver
+     make
+     ```
+  
+     4.3 Compile/build the docker image:
+
+     ```
+     cd $GOPATH/src/github.com/IBM/ibm-spectrum-scale-csi-driver
+     make build-image
+     ```
+

Makefile

@@ -12,18 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-NAME=csi-spectrum-scale
+NAME=ibm-spectrum-scale-csi
 
 .PHONY: all $NAME
 
-IMAGE_VERSION=v0.9.0
+IMAGE_VERSION=v1.0.0
 IMAGE_NAME=$(NAME)
 
 all: $NAME
 
 $NAME:
 	if [ ! -d ./vendor ]; then dep ensure; fi
-	CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-extldflags "-static"' -o  _output/$(NAME) ./cmd/csi-spectrum-scale
+	CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-extldflags "-static"' -o  _output/$(NAME) ./cmd/ibm-spectrum-scale-csi
 
 build-image: $NAME
 	docker build --network=host -t $(IMAGE_NAME):$(IMAGE_VERSION) .