Skip to content

Commit

Permalink
doc: rename driver name as "Azure Blob Storage CSI driver"
Browse files Browse the repository at this point in the history
  • Loading branch information
andyzhangx committed Aug 5, 2020
1 parent 47327da commit 72ee8ca
Show file tree
Hide file tree
Showing 16 changed files with 33 additions and 33 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Please refer to `blobfuse.csi.azure.com` [driver parameters](./docs/driver-param
- 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)
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions charts/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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 |
|---------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------------|
Expand Down
4 changes: 2 additions & 2 deletions charts/latest/blobfuse-csi-driver/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions deploy/install-driver.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
4 changes: 2 additions & 2 deletions deploy/uninstall-driver.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
2 changes: 1 addition & 1 deletion docs/csi-dev.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Blobfuse CSI driver development guide
# Azure Blob Storage CSI driver development guide

- Clone repo
```console
Expand Down
6 changes: 3 additions & 3 deletions docs/design.md
Original file line number Diff line number Diff line change
@@ -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
--- | --- | --- |
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/install-blobfuse-csi-driver.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/install-csi-driver-master.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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 --
```
4 changes: 2 additions & 2 deletions docs/read-from-keyvault.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pkg/blobfuseplugin/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
2 changes: 1 addition & 1 deletion pkg/blobfuseplugin/dev.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
2 changes: 1 addition & 1 deletion pkg/blobfuseplugin/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}
Expand Down
12 changes: 6 additions & 6 deletions test/e2e/suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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})

Expand All @@ -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})

Expand Down Expand Up @@ -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) {
Expand Down
6 changes: 3 additions & 3 deletions test/utils/credentials/credentials.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 72ee8ca

Please sign in to comment.