forked from kubernetes-sigs/azuredisk-csi-driver
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19 from RomanBednar/rebase-v1.9.0
Rebase to v1.9.0 for OCP 4.10
- Loading branch information
Showing
1,008 changed files
with
62,907 additions
and
34,635 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Trivy vulnerability scanner | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| pull_request: | ||
| jobs: | ||
| build: | ||
| name: Build | ||
| runs-on: ubuntu-18.04 | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Build an image from Dockerfile | ||
| run: | | ||
| export PUBLISH=true | ||
| export REGISTRY=test | ||
| export IMAGE_VERSION=latest | ||
| export DOCKER_CLI_EXPERIMENTAL=enabled | ||
| make container | ||
| - name: Run Trivy vulnerability scanner | ||
| uses: aquasecurity/trivy-action@master | ||
| with: | ||
| image-ref: 'test/azuredisk-csi:latest' | ||
| format: 'table' | ||
| exit-code: '1' | ||
| ignore-unfixed: true | ||
| vuln-type: 'os,library' | ||
| severity: 'CRITICAL,HIGH,MEDIUM,LOW,UNKNOWN' | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,117 @@ | ||
| # Azure Disk CSI driver for Kubernetes | ||
|
|
||
| [](https://travis-ci.org/kubernetes-sigs/azuredisk-csi-driver) | ||
| [](https://coveralls.io/github/kubernetes-sigs/azuredisk-csi-driver?branch=master) | ||
| [](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes-sigs%2Fazuredisk-csi-driver?ref=badge_shield) | ||
|
|
||
| ### About | ||
|
|
||
| This driver allows Kubernetes to use [Azure Disk](https://azure.microsoft.com/en-us/services/storage/disks/) volume, csi plugin name: `disk.csi.azure.com` | ||
|
|
||
| ### Project status: GA | ||
| ### Project status | ||
|
|
||
| V1: GA | ||
|
|
||
| V2: Preview | ||
|
|
||
| ### Container Images & Kubernetes Compatibility | ||
| |Driver Version |Image | supported k8s version | | ||
| |----------------|------------------------------------------------|-----------------------| | ||
| |master branch |mcr.microsoft.com/k8s/csi/azuredisk-csi:latest | 1.18+ | | ||
| |v1.5.1 |mcr.microsoft.com/k8s/csi/azuredisk-csi:v1.5.1 | 1.18+ | | ||
| |v1.4.0 |mcr.microsoft.com/k8s/csi/azuredisk-csi:v1.4.0 | 1.18+ | | ||
| |v1.2.0 |mcr.microsoft.com/k8s/csi/azuredisk-csi:v1.2.0 | 1.17+ | | ||
|
|
||
| #### V1 | ||
|
|
||
| |Driver Version |Image | supported k8s version | | ||
| |----------------|----------------------------------------------------------|-----------------------| | ||
| |`master` branch |mcr.microsoft.com/k8s/csi/azuredisk-csi:latest | 1.19+ | | ||
| |v1.9.0 |mcr.microsoft.com/oss/kubernetes-csi/azuredisk-csi:v1.9.0 | 1.19+ | | ||
| |v1.8.0 |mcr.microsoft.com/oss/kubernetes-csi/azuredisk-csi:v1.8.0 | 1.18+ | | ||
| |v1.7.0 |mcr.microsoft.com/oss/kubernetes-csi/azuredisk-csi:v1.7.0 | 1.18+ | | ||
|
|
||
| #### V2 | ||
|
|
||
| |Driver Version |Image | supported k8s version | | ||
| |----------------|-----------------------------------------------------------------|-----------------------| | ||
| |`main_v2` branch| | 1.21+ | | ||
| |v2.0.0-alpha.1 |mcr.microsoft.com/oss/kubernetes-csi/azuredisk-csi:v2.0.0-alpha.1| 1.21+ | | ||
|
|
||
| ### Driver parameters | ||
|
|
||
| Please refer to [`disk.csi.azure.com` driver parameters](./docs/driver-parameters.md) | ||
| > storage class `disk.csi.azure.com` parameters are compatible with built-in [azuredisk](https://kubernetes.io/docs/concepts/storage/volumes/#azuredisk) plugin | ||
| > storage class `disk.csi.azure.com` parameters are compatible with built-in [azuredisk](https://kubernetes.io/docs/concepts/storage/volumes/#azuredisk) plugin | ||
| ### Set up CSI driver on AKS cluster (only for AKS users) | ||
|
|
||
| follow guide [here](./docs/install-driver-on-aks.md) | ||
|
|
||
| ### Prerequisite | ||
| - The driver depends on [cloud provider config file](https://kubernetes-sigs.github.io/cloud-provider-azure/install/configs/#setting-azure-cloud-provider-from-kubernetes-secrets), usually it's `/etc/kubernetes/azure.json` on all kubernetes nodes deployed by [AKS](https://docs.microsoft.com/en-us/azure/aks/) or [aks-engine](https://github.com/Azure/aks-engine), here is [azure.json example](./deploy/example/azure.json). | ||
| > To specify a different cloud provider config file, create `azure-cred-file` configmap before driver installation, e.g. for OpenShift, it's `/etc/kubernetes/cloud.conf` (make sure config file path is in the `volumeMounts.mountPath`) | ||
| > ```console | ||
| > kubectl create configmap azure-cred-file --from-literal=path="/etc/kubernetes/cloud.conf" --from-literal=path-windows="C:\\k\\cloud.conf" -n kube-system | ||
| > ``` | ||
| - 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 | ||
| - [Set up CSI driver on Azure RedHat OpenShift(ARO)](https://github.com/ezYakaEagle442/aro-pub-storage/blob/master/setup-store-CSI-driver-azure-disk.md) | ||
|
|
||
| - The driver depends on [cloud provider config file](https://kubernetes-sigs.github.io/cloud-provider-azure/install/configs/#setting-azure-cloud-provider-from-kubernetes-secrets), usually it's `/etc/kubernetes/azure.json` on all kubernetes nodes deployed by [AKS](https://docs.microsoft.com/en-us/azure/aks/) or [aks-engine](https://github.com/Azure/aks-engine), here is [azure.json example](./deploy/example/azure.json). | ||
| > To specify a different cloud provider config file, create `azure-cred-file` configmap before driver installation, e.g. for OpenShift, it's `/etc/kubernetes/cloud.conf` (make sure config file path is in the `volumeMounts.mountPath`) | ||
| > | ||
| > ```console | ||
| > kubectl create configmap azure-cred-file --from-literal=path="/etc/kubernetes/cloud.conf" --from-literal=path-windows="C:\\k\\cloud.conf" -n kube-system | ||
| > ``` | ||
| > | ||
| - 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 | ||
| - When installing side-by-side with an earlier version of the driver on an AKS cluster, ensure the agentpool service principal or managed service identity is assigned to the `Contributor` role on the resource groups used to store managed disks. | ||
| - [Set up CSI driver on Azure RedHat OpenShift(ARO)](https://github.com/ezYakaEagle442/aro-pub-storage/blob/master/setup-store-CSI-driver-azure-disk.md) | ||
| ### Install driver on a Kubernetes cluster | ||
| - install via [kubectl](./docs/install-azuredisk-csi-driver.md) on public Azure (please use helm for Azure Stack, RedHat/CentOS) | ||
| - install via [helm charts](./charts) on public Azure, Azure Stack, RedHat/CentOS | ||
| - install via [kubectl](./docs/install-azuredisk-csi-driver.md) on public Azure (please use helm for Azure Stack, RedHat/CentOS) | ||
| - install via [helm charts](./charts) on public Azure, Azure Stack, RedHat/CentOS | ||
| ### Install Azure Disk CSI Driver V2 on a Kubernetes cluster (Preview) | ||
| - install via [helm charts](./charts) | ||
| ### Examples | ||
| - [Basic usage](./deploy/example/e2e_usage.md) | ||
| - [Basic usage](./deploy/example/e2e_usage.md) | ||
| ### Features | ||
| - [Topology(Availability Zone)](./deploy/example/topology) | ||
| - [ZRS disk support(Preview)](./deploy/example/topology#zrs-disk-support) | ||
| - [Snapshot](./deploy/example/snapshot) | ||
| - [Volume Cloning](./deploy/example/cloning) | ||
| - [Volume Expansion](./deploy/example/resize) | ||
| - [Raw Block Volume](./deploy/example/rawblock) | ||
| - [Windows](./deploy/example/windows) | ||
| - [Shared Disk](./deploy/example/sharedisk) | ||
| - [Volume Limits](./deploy/example/volumelimits) | ||
| - [fsGroupPolicy](./deploy/example/fsgroup) | ||
| - [Topology (Availability Zone)](./deploy/example/topology) | ||
| - [ZRS disk support](./deploy/example/topology#zrs-disk-support) | ||
| - [Snapshot](./deploy/example/snapshot) | ||
| - [Volume Cloning](./deploy/example/cloning) | ||
| - [Volume Expansion](./deploy/example/resize) | ||
| - [Raw Block Volume](./deploy/example/rawblock) | ||
| - [Windows](./deploy/example/windows) | ||
| - [Shared Disk](./deploy/example/sharedisk) | ||
| - [Volume Limits](./deploy/example/volumelimits) | ||
| - [fsGroupPolicy](./deploy/example/fsgroup) | ||
| - [Tune disk performance on Linux](./docs/enhancements/feat-add-ability-to-tune-azuredisk-performance-parameters.md) | ||
| #### New in V2 | ||
| - [Attachments Replicas for Faster Pod Failover (Preview)](./docs/design-v2.md) | ||
| - See [pod failover demo](./deploy/example/failover/README.md) for example configuration. | ||
| - [Advanced disk performance tuning (Preview)](./docs/perf-profiles.md) | ||
| ### Troubleshooting | ||
| - [CSI driver troubleshooting guide](./docs/csi-debug.md) | ||
| - [CSI driver troubleshooting guide](./docs/csi-debug.md) | ||
| ### Support | ||
| - Please see our [support policy][support-policy] | ||
| - Please see our [support policy][support-policy] | ||
| ### Limitations | ||
| - Please refer to [Azure Disk CSI Driver Limitations](./docs/limitations.md) | ||
| - Please refer to [Azure Disk CSI Driver Limitations](./docs/limitations.md) | ||
| ## Kubernetes Development | ||
| - Please refer to [development guide](./docs/csi-dev.md) | ||
| - Please refer to [development guide](./docs/csi-dev.md) | ||
| ### View CI Results | ||
| - Check testgrid [provider-azure-azuredisk-csi-driver](https://testgrid.k8s.io/provider-azure-azuredisk-csi-driver) dashboard. | ||
| - Check testgrid [provider-azure-azuredisk-csi-driver](https://testgrid.k8s.io/provider-azure-azuredisk-csi-driver) dashboard. | ||
| ### Links | ||
| - [Kubernetes CSI Documentation](https://kubernetes-csi.github.io/docs/) | ||
| - [CSI Drivers](https://github.com/kubernetes-csi/drivers) | ||
| - [Container Storage Interface (CSI) Specification](https://github.com/container-storage-interface/spec) | ||
| - [Kubernetes CSI Documentation](https://kubernetes-csi.github.io/docs/) | ||
| - [CSI Drivers](https://github.com/kubernetes-csi/drivers) | ||
| - [Container Storage Interface (CSI) Specification](https://github.com/container-storage-interface/spec) | ||
| [support-policy]: support.md |
Oops, something went wrong.