Merge pull request #196 from andyzhangx/rename-driver-name

andyzhangx · web-flow · commit 88aea0d89eca · 2020-08-05T21:52:42.000+08:00
doc: rename driver as "Azure Blob Storage CSI driver"
diff --git a/README.md b/README.md
@@ -26,8 +26,8 @@ Please refer to `blob.csi.azure.com` [driver parameters](./docs/driver-parameter
  - This driver also supports [read cloud config from kuberenetes secret](./docs/read-from-secret.md).
  - If cluster identity is [Managed Service Identity(MSI)](https://docs.microsoft.com/en-us/azure/aks/use-managed-identity), make sure user assigned identity has `Contributor` role on node resource group
 
-### Install blobfuse CSI driver on a kubernetes cluster
-Please refer to [install blobfuse csi driver](https://github.com/kubernetes-sigs/blobfuse-csi-driver/blob/master/docs/install-blobfuse-csi-driver.md)
+### Install Azure Blob Storage CSI driver on a kubernetes cluster
+Please refer to [install Azure Blob Storage CSI driver](https://github.com/kubernetes-sigs/blobfuse-csi-driver/blob/master/docs/install-blobfuse-csi-driver.md)
 
 ### Usage
  - [Basic usage](./deploy/example/e2e_usage.md)
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,6 +1,6 @@
 # Release Process
 
-The Blobfuse CSI Driver is released on an as-needed basis. The process is as follows:
+The Azure Blob Storage CSI driver is released on an as-needed basis. The process is as follows:
 
 1. An issue is proposing a new release with a changelog since the last release
 1. All [OWNERS](OWNERS) must LGTM this release
diff --git a/charts/README.md b/charts/README.md
@@ -1,6 +1,6 @@
 # Installation with Helm 3
 
-Quick start instructions for the setup and configuration of blobfuse CSI driver using Helm.
+Quick start instructions for the setup and configuration of Azure Blob Storage CSI driver using Helm.
 
 ## Prerequisites
 
@@ -38,7 +38,7 @@ $ helm uninstall blobfuse-csi-driver -n kube-system
 ```  
 ## The Latest Helm Chart Configuration
 
-The following table lists the configurable parameters of the latest Blobfuse CSI Driver chart and their default values.
+The following table lists the configurable parameters of the latest Azure Blob Storage CSI driver chart and their default values.
 
 | Parameter                                         | Description                                                | Default                                                           |
 |---------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------------|
diff --git a/charts/latest/blobfuse-csi-driver/templates/NOTES.txt b/charts/latest/blobfuse-csi-driver/templates/NOTES.txt
@@ -1,5 +1,5 @@
-The BlobFuse CSI Driver is getting deployed to your cluster.
+The Azure Blob Storage CSI driver is getting deployed to your cluster.
 
-To check Blobfuse CSI Driver pods status, please run:
+To check Azure Blob Storage CSI driver pods status, please run:
 
   kubectl --namespace={{ .Release.Namespace }} get pods --selector="release={{ .Release.Name }}" --watch
diff --git a/deploy/install-driver.sh b/deploy/install-driver.sh
@@ -33,10 +33,10 @@ if [ $ver != "master" ]; then
   repo="$repo/$ver"
 fi
 
-echo "Installing Blobfuse CSI driver, version: $ver ..."
+echo "Installing Azure Blob Storage CSI driver, version: $ver ..."
 kubectl apply -f $repo/rbac-csi-blobfuse-controller.yaml
 kubectl apply -f $repo/rbac-csi-blobfuse-node.yaml
 kubectl apply -f $repo/csi-blobfuse-driver.yaml
 kubectl apply -f $repo/csi-blobfuse-controller.yaml
 kubectl apply -f $repo/csi-blobfuse-node.yaml
-echo 'Blobfuse CSI driver installed successfully.'
+echo 'Azure Blob Storage CSI driver installed successfully.'
diff --git a/deploy/uninstall-driver.sh b/deploy/uninstall-driver.sh
@@ -33,10 +33,10 @@ if [ $ver != "master" ]; then
   repo="$repo/$ver"
 fi
 
-echo "Uninstalling Blobfuse CSI driver, version: $ver ..."
+echo "Uninstalling Azure Blob Storage CSI driver, version: $ver ..."
 kubectl delete -f $repo/csi-blobfuse-controller.yaml --ignore-not-found
 kubectl delete -f $repo/csi-blobfuse-node.yaml --ignore-not-found
 kubectl delete -f $repo/csi-blobfuse-driver.yaml --ignore-not-found
 kubectl delete -f $repo/rbac-csi-blobfuse-controller.yaml --ignore-not-found
 kubectl delete -f $repo/rbac-csi-blobfuse-node.yaml --ignore-not-found
-echo 'Uninstalled Blobfuse CSI driver successfully.'
+echo 'Uninstalled Azure Blob Storage CSI driver successfully.'
diff --git a/docs/csi-dev.md b/docs/csi-dev.md
@@ -1,4 +1,4 @@
-# Blobfuse CSI driver development guide
+# Azure Blob Storage CSI driver development guide
 
  - Clone repo
 ```console
diff --git a/docs/design.md b/docs/design.md
@@ -1,5 +1,5 @@
-# blobfuse CSI driver design goals
- > blobfuse CSI driver is implemented as compatitable as possible with built-in [blobfuse](https://kubernetes.io/docs/concepts/storage/volumes/#blobfuse) plugin, it has following goals:
+# Azure Blob Storage CSI driver design goals
+ > Azure Blob Storage CSI driver is implemented as compatitable as possible with built-in [blobfuse](https://kubernetes.io/docs/concepts/storage/volumes/#blobfuse) plugin, it has following goals:
 
 Goal | Status | Notes
 --- | --- | --- |
@@ -21,4 +21,4 @@ Implement NodeStage/NodeUnstage functions | to-do | two pods on same node could
 Implement azure blobfuse.csi driver on Windows | to-do |  |
 
 ### Implementation details
-To prevent possible regression issues, blobfuse CSI driver use [azure cloud provider](https://github.com/kubernetes/kubernetes/tree/v1.13.0/pkg/cloudprovider/providers/azure) library. Thus, all bug fixes in the built-in blobfuse plugin would be incorporated into this driver.
+To prevent possible regression issues, Azure Blob Storage CSI driver use [azure cloud provider](https://github.com/kubernetes/kubernetes/tree/v1.13.0/pkg/cloudprovider/providers/azure) library. Thus, all bug fixes in the built-in blobfuse plugin would be incorporated into this driver.
diff --git a/docs/install-blobfuse-csi-driver.md b/docs/install-blobfuse-csi-driver.md
@@ -1,4 +1,4 @@
-## Install blobfuse CSI driver on a Kubernetes cluster
+## Install Azure Blob Storage CSI driver on a Kubernetes cluster
 
  - [install CSI driver master version](./install-csi-driver-master.md)
  - [install v0.6.0 CSI driver](./install-csi-driver-v0.6.0.md)
diff --git a/docs/install-csi-driver-master.md b/docs/install-csi-driver-master.md
@@ -1,6 +1,6 @@
-# Install blobfuse CSI driver master version on a kubernetes cluster
+# Install Azure Blob Storage CSI driver master version on a kubernetes cluster
 
-If you have already installed Helm, you can also use it to install blobfuse CSI driver. Please see [Installation with Helm](../charts/README.md).
+If you have already installed Helm, you can also use it to install Azure Blob Storage CSI driver. Please see [Installation with Helm](../charts/README.md).
 
 ## Install with kubectl
  - remote install
@@ -31,7 +31,7 @@ csi-blobfuse-node-cvgbs                        3/3     Running   0          35s
 csi-blobfuse-node-dr4s4                        3/3     Running   0          35s     10.240.0.4     k8s-agentpool-22533604-0
 ```
 
-- clean up blobfuse CSI driver
+- clean up Azure Blob Storage CSI driver
 ```console
 curl -skSL https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/uninstall-driver.sh | bash -s master --
 ```
diff --git a/docs/read-from-keyvault.md b/docs/read-from-keyvault.md
@@ -20,8 +20,8 @@
    az keyvault set-policy -n $keyvaultname --certificate-permissions get --spn $aadclientid
    ```
 
-## Install blobfuse CSI driver on a kubernetes cluster
-Please refer to [install blobfuse csi driver](https://github.com/kubernetes-sigs/blobfuse-csi-driver/blob/master/docs/install-blobfuse-csi-driver.md)
+## Install Azure Blob Storage CSI driver on a kubernetes cluster
+Please refer to [install Azure Blob Storage CSI driver](https://github.com/kubernetes-sigs/blobfuse-csi-driver/blob/master/docs/install-blobfuse-csi-driver.md)
 
 ## Create PV
 1.  Download a `pv-blobfuse-csi-keyvault.yaml`, edit `keyVaultURL`, `keyVaultSecretName`, `containerName` in PV
diff --git a/pkg/blobfuseplugin/Dockerfile b/pkg/blobfuseplugin/Dockerfile
@@ -28,6 +28,6 @@ RUN apt remove wget -y
 # this is a workaround to install nfs-common and don't quit with error
 RUN apt install nfs-common -y || true
 LABEL maintainers="andyzhangx"
-LABEL description="Blobfuse CSI Driver"
+LABEL description="Azure Blob Storage CSI driver"
 
 ENTRYPOINT ["/blobfuseplugin"]
diff --git a/pkg/blobfuseplugin/dev.Dockerfile b/pkg/blobfuseplugin/dev.Dockerfile
@@ -16,7 +16,7 @@ FROM mcr.microsoft.com/aks/fundamental/base-ubuntu:v0.0.5
 RUN wget -O /tmp/packages-microsoft-prod.deb https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb
 RUN dpkg -i /tmp/packages-microsoft-prod.deb && apt-get update && apt-get install -y ca-certificates pkg-config libfuse-dev cmake libcurl4-gnutls-dev libgnutls28-dev uuid-dev libgcrypt20-dev blobfuse nfs-common
 LABEL maintainers="andyzhangx"
-LABEL description="Blobfuse CSI Driver"
+LABEL description="Azure Blob Storage CSI driver"
 
 COPY ./_output/blobfuseplugin /blobfuseplugin
 ENTRYPOINT ["/blobfuseplugin"]
diff --git a/pkg/blobfuseplugin/main.go b/pkg/blobfuseplugin/main.go
@@ -66,7 +66,7 @@ func main() {
 func handle() {
 	driver := blobfuse.NewDriver(*nodeID)
 	if driver == nil {
-		klog.Fatalln("Failed to initialize blobfuse CSI Driver")
+		klog.Fatalln("Failed to initialize Azure Blob Storage CSI driver")
 	}
 	driver.Run(*endpoint, *kubeconfig)
 }
diff --git a/test/e2e/suite_test.go b/test/e2e/suite_test.go
@@ -84,12 +84,12 @@ var _ = ginkgo.BeforeSuite(func() {
 		gomega.Expect(err).NotTo(gomega.HaveOccurred())
 		log.Println("docker login is successful")
 
-		// Install Blobfuse CSI Driver on cluster from project root
+		// Install Azure Blob Storage CSI driver on cluster from project root
 		e2eBootstrap := testCmd{
 			command:  "make",
 			args:     []string{"e2e-bootstrap"},
-			startLog: "Installing Blobfuse CSI Driver...",
-			endLog:   "Blobfuse CSI Driver installed",
+			startLog: "Installing Azure Blob Storage CSI driver...",
+			endLog:   "Azure Blob Storage CSI driver installed",
 		}
 		execTestCmd([]testCmd{e2eBootstrap})
 
@@ -114,8 +114,8 @@ var _ = ginkgo.AfterSuite(func() {
 		e2eTeardown := testCmd{
 			command:  "make",
 			args:     []string{"e2e-teardown"},
-			startLog: "Uninstalling Blobfuse CSI Driver...",
-			endLog:   "Blobfuse CSI Driver uninstalled",
+			startLog: "Uninstalling Azure Blob Storage CSI driver...",
+			endLog:   "Azure Blob Storage CSI driver uninstalled",
 		}
 		execTestCmd([]testCmd{blobfuseLog, e2eTeardown})
 
@@ -146,7 +146,7 @@ func TestE2E(t *testing.T) {
 		reportDir = defaultReportDir
 	}
 	r := []ginkgo.Reporter{reporters.NewJUnitReporter(path.Join(reportDir, "junit_01.xml"))}
-	ginkgo.RunSpecsWithDefaultAndCustomReporters(t, "Blobfuse CSI Driver End-to-End Tests", r)
+	ginkgo.RunSpecsWithDefaultAndCustomReporters(t, "Azure Blob Storage CSI driver End-to-End Tests", r)
 }
 
 func execTestCmd(cmds []testCmd) {
diff --git a/test/utils/credentials/credentials.go b/test/utils/credentials/credentials.go
@@ -80,7 +80,7 @@ type FromProw struct {
 	StorageAccountKey  string
 }
 
-// Credentials is used in Blobfuse CSI Driver to store Azure credentials
+// Credentials is used in Azure Blob Storage CSI driver to store Azure credentials
 type Credentials struct {
 	Cloud           string
 	TenantID        string
@@ -92,7 +92,7 @@ type Credentials struct {
 }
 
 // CreateAzureCredentialFile creates a temporary Azure credential file for
-// Blobfuse CSI driver tests and returns the credentials
+// Azure Blob Storage CSI driver tests and returns the credentials
 func CreateAzureCredentialFile(isAzureChinaCloud bool) (*Credentials, error) {
 	// Search credentials through env vars first
 	var cloud, tenantID, subscriptionID, aadClientID, aadClientSecret, resourceGroup, location string
@@ -156,7 +156,7 @@ func DeleteAzureCredentialFile() error {
 }
 
 // getCredentialsFromAzureCredentials parses the azure credentials toml (AZURE_CREDENTIALS)
-// in Prow and returns the credential information usable to Blobfuse CSI driver
+// in Prow and returns the credential information usable to Azure Blob Storage CSI driver
 func getCredentialsFromAzureCredentials(azureCredentialsPath string) (*FromProw, error) {
 	content, err := ioutil.ReadFile(azureCredentialsPath)
 	log.Printf("Reading credentials file %v", azureCredentialsPath)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Blobfuse CSI driver development guide`
	`1`	`+# Azure Blob Storage CSI driver development guide`
`2`	`2`
`3`	`3`	`- Clone repo`
`4`	`4`	```console
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Install blobfuse CSI driver on a Kubernetes cluster`
	`1`	`+## Install Azure Blob Storage CSI driver on a Kubernetes cluster`
`2`	`2`
`3`	`3`	`- [install CSI driver master version](./install-csi-driver-master.md)`
`4`	`4`	`- [install v0.6.0 CSI driver](./install-csi-driver-v0.6.0.md)`