Skip to content

Commit

Permalink
Merge pull request #473 from andyzhangx/update-with-2.7.0
Browse files Browse the repository at this point in the history
doc: update doc with 2.7.0 version
  • Loading branch information
andyzhangx authored Dec 29, 2024
2 parents d37f066 + ba3cf6c commit 16fc083
Show file tree
Hide file tree
Showing 23 changed files with 49 additions and 85 deletions.
52 changes: 8 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ provisioning.
* [Best Practices](#best-practices)
- [Version Compatibility](#version-compatibility)
- [K8s Feature Status](#k8s-feature-status)
* [1.14: GA](#114-ga)
* [1.12: Beta](#112-beta)
* [1.10: Beta](#110-beta)
* [1.9: Alpha](#19-alpha)
* [1.7: Alpha](#17-alpha)
* GA from 1.14
* [Future features](#future-features)
- [E2E Tests](#e2e-tests)
* [Running](#running)
Expand Down Expand Up @@ -95,53 +91,21 @@ See [Best Practices](docs/best-practices.md).

Recommended provisioner versions with Kubernetes versions

| Provisioner version | K8s version | Reason |
| ------------------- | ------------- | ------------------------- |
| [2.6.0][6] | 1.12+ | |
| [2.5.0][5] | 1.12+ | |
| [2.4.0][4] | 1.12+ | fs on block support |
| [2.2.0][3] | 1.10 | Beta API default, block |
| [2.0.0][2] | 1.8, 1.9 | Mount propagation |
| [1.0.1][1] | 1.7 | |

[1]: https://github.com/kubernetes-incubator/external-storage/tree/local-volume-provisioner-v1.0.1/local-volume
[2]: https://github.com/kubernetes-incubator/external-storage/tree/local-volume-provisioner-v2.0.0/local-volume
[3]: https://github.com/kubernetes-incubator/external-storage/tree/local-volume-provisioner-v2.2.0/local-volume
[4]: https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/tree/v2.4.0
| Provisioner version | K8s version |
| ------------------- | ------------- |
| [2.7.0][7] | 1.21+ |
| [2.6.0][6] | 1.12+ |
| [2.5.0][5] | 1.12+ |

[5]: https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/tree/v2.5.0
[6]: https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/tree/v2.6.0
[7]: https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/tree/v2.7.0


## K8s Feature Status

Also see [known issues](KNOWN_ISSUES.md) and [CHANGELOG](CHANGELOG.md).

### 1.14: GA

* No new features added

### 1.12: Beta

* Added support for automatically formatting a filesystem on the given block device in `localVolumeSource.path`

### 1.10: Beta

* New PV.NodeAffinity field added.
* **Important:** Alpha PV NodeAffinity annotation is deprecated. Users must manually update
their PVs to use the new NodeAffinity field or run a [one-time update job](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/tree/master/cmd/utils/update-pv-to-beta).
* Alpha: Raw block support added.

### 1.9: Alpha

* New StorageClass `volumeBindingMode` parameter that will delay PVC binding
until a pod is scheduled.

### 1.7: Alpha

* New `local` PersistentVolume source that allows specifying a directory or mount
point with node affinity.
* Pod using the PVC that is bound to this PV will always get scheduled to that node.

### Future features

* Local block devices as a volume source, with partitioning and fs formatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ spec:
spec:
serviceAccountName: local-storage-admin
containers:
- image: "registry.k8s.io/sig-storage/local-volume-provisioner:v2.4.0"
- image: "registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0"
imagePullPolicy: "Always"
name: provisioner
securityContext:
Expand Down
2 changes: 1 addition & 1 deletion helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ provisioner chart and their default values.
| classes.[n].storageClass.provisioner | Specify provisioner of storage class. | str | `kubernetes.io/no-provisioner` |
| podAnnotations | Annotations for each Pod in the DaemonSet. | map | `-` |
| podLabels | Labels for each Pod in the DaemonSet. | map | `-` |
| image | Provisioner image. | str | `registry.k8s.io/sig-storage/local-volume-provisioner:v2.5.0` |
| image | Provisioner image. | str | `registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0` |
| imagePullPolicy | Provisioner DaemonSet image pull policy. | str | `-` |
| imagePullSecrets | Provisioner image pull secrets. | list | `-` |
| priorityClassName | Provisioner DaemonSet Pod Priority Class name. | str | `` |
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/additional-volumes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ spec:
name: signal
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -135,7 +135,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-affinity.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ spec:
- localssd
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -144,7 +144,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-cleanbyjobs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -173,7 +173,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-default-storage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -133,7 +133,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-nodeselector.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ spec:
localVolume: present
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -136,7 +136,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-priority-critical.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -135,7 +135,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-priority-noncritical.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -135,7 +135,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-prometheus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -155,7 +155,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-provisioner.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -133,7 +133,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-resyncperiod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -134,7 +134,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-tolerations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ spec:
key: node-role.kubernetes.io/master
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -141,7 +141,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-with-resource-limits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
resources:
Expand All @@ -142,7 +142,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal-without-rbac.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -87,7 +87,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/baremetal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -134,7 +134,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/eks-nvme-ssd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -130,7 +130,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/gce-retain.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -148,7 +148,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
4 changes: 2 additions & 2 deletions helm/generated_examples/gce.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ spec:
kubernetes.io/os: linux
containers:
- name: provisioner
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
image: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
securityContext:
privileged: true
env:
Expand All @@ -148,7 +148,7 @@ spec:
fieldRef:
fieldPath: metadata.namespace
- name: JOB_CONTAINER_IMAGE
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.6.0
value: registry.k8s.io/sig-storage/local-volume-provisioner:v2.7.0
ports:
- name: metrics
containerPort: 8080
Expand Down
Loading

0 comments on commit 16fc083

Please sign in to comment.