Commit Graph

525 Commits (48bde1f7d5be472200a12bbf4846c60405cb15da)

Author SHA1 Message Date
Anton Gilgur 74ee1d9875
docs(storage-classes): add section on default `StorageClass` (#41843)
* docs(storage-classes): add section on default StorageClass

- empty commit at the beginning for the squash
  - PR template asks the first commit to be named appropriately for squashes

* Update storage-classes.md

Add Note at the end about having a single default storage class is preferred and that Kubernetes does not prevent you from having multiple storage classes.

* Updated storage-classed.md

Updated storage-classed.md based on feedback.

* update storage-class.md

Updated storage-class.md based on feedback

* fix feedback and grammar

- consistently use StorageClass, as that's how it's mostly used in this doc and the PVC doc
  - except when it is plural, in that case "storage classes" is used
  - fix docs reference to use the proper title of the doc too, which also has it as one word
- consolidate two sentences together that both describe what a default StorageClass is for
  - `storageClassName` is the specific PVC field; use backticks and camelCase when describing it
- remove extra new line

- minor grammar and spacing fixes
  - more than one space was occassionally used
  - a cloud provider will similarly only ever set _one_ default StorageClass, so use singular instead of plural

* docs(storage-classes): add section on default StorageClass

- the PVC docs reference this and there is an administrator guide on how to change this, but no section within the central Storage Classes document
  - this has made it a bit difficult to explain how that a default StorageClass exists as the StorageClass docs themselves barely mention it
  - with a new section, this makes it very clear and links out to other existing docs on the topic

- based off a previous PR that went through some review cycles and added this section but was never merged

* update what happens when multiple defaults exist

- c.f. 962235c86a (diff-77fd84defc818b9e6010794bf87e0eece0960dfeff196e19b7d84da8de15ddffR67)
  - chooses the newest by default

* slight modifications according to the style guide

- simplify dynamic provisionining reference
  - it's specific, but very accurate, so I'm hesitant to remove more pieces of it

- simplify tense; this is still a "hypothetical" (if/when) scenario, so still not present tense, but simpler past perfect tense instead of future perfect tense
  - futher modifications welcome!

* use a relative path to the doc instead of a URL

Co-authored-by: Rey Lejano <rlejano@gmail.com>

---------

Co-authored-by: Ju Lim (Red Hat) <julim@redhat.com>
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2023-07-05 21:55:03 -07:00
AKSHAYA MADHURI d1b90faec8
Update storage-classes.md 2023-07-02 16:51:32 +05:30
AKSHAYA MADHURI 80f42ed9b5
Update storage-classes.md 2023-07-02 12:10:27 +05:30
Qiming Teng eea76d1110 Add some tidy up changes for retriggering the CI 2023-06-05 12:46:41 +08:00
Qiming Teng d88628bc3d Add link to reclaiming policy 2023-06-05 12:46:25 +08:00
Michael 2886944017 tweak line wrappings in storage/ 2023-06-01 21:20:18 +08:00
Marcelo Giles a79dee21fb
Remove Docker volumes background reference 2023-05-19 11:22:25 -07:00
Joshua Pare 74770e7025 default readonly mounting is not specified 2023-05-18 09:57:16 -05:00
Niranjan Darshan 2a10536f1b
Added navigational link for ephemeral and persistent volume (#40785)
* Added navigational link for ephemeral and persistent volume

* Update volumes.md
2023-05-08 19:24:52 -07:00
KhushPatibandha e517e3ab99 stated 2 problems in a better for volumes 2023-04-27 13:47:38 +05:30
ziyi-xie 95775ad64a Modified the description about emptyDir sizeLimit 2023-04-17 04:24:25 +00:00
Kubernetes Prow Robot d6350c03bb
Merge pull request #40018 from humblec/dev-1.27
KEP-3107 update docs for csiNodeExpand secret support
2023-03-30 20:37:49 -07:00
Humble Chirammal ea3b7b44e7 KEP-3107 update docs for csiNodeExpand secret support
This feature has moved to Beta in this release. The documentation
has been updated to reflect the same.

Signed-off-by: Humble Chirammal <humble.devassy@gmail.com>
2023-03-23 16:23:07 +05:30
Chris Henzie e600a75b41 Update ReadWriteOncePod feature to beta 2023-03-14 13:52:52 -07:00
Kubernetes Prow Robot 3fc2fa9853
Merge pull request #39142 from tengqm/cleanup-redirects-1
Remove redirect entries for docs/admin/... pages
2023-02-22 08:43:57 -08:00
seancrasto 46ff1a8047
Update persistent-volumes.md
Minor corrections.
2023-02-18 18:42:54 -05:00
windsonsea 4ae516aee8 Tweak line wrappings in PV storage concepts 2023-02-16 09:54:07 +08:00
Kubernetes Prow Robot 17fcb2e70d
Merge pull request #39385 from AkihiroSuda/rprivate
`mountPropagation: None` equates to `rprivate`, not `private`
2023-02-11 17:05:30 -08:00
Akihiro Suda 8355f38ae4
`mountPropagation: None` equates to `rprivate`, not `private`
Evidences:
- https://github.com/containerd/containerd/blob/v1.6.16/pkg/cri/opts/spec_linux.go#L181
- https://github.com/cri-o/cri-o/blob/v1.26.1/server/container_create_linux.go#L982

This commit also replaces the link to https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt
with https://man7.org/linux/man-pages/man8/mount.8.html , as the former one does
not mention `rprivate` .

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2023-02-11 21:11:26 +09:00
Kubernetes Prow Robot 681c103612
Merge pull request #39367 from RaunakShah/3151-update-annotation
Update volume mode change annotation in documentation
2023-02-10 10:21:30 -08:00
Raunak Pradip Shah 9ab8cd6c0b Update volume mode change annotation in documentation 2023-02-09 11:25:13 +05:30
zhuzhenghao f910c027bf Reformat storage-classes page 2023-02-07 13:52:48 +08:00
Qiming Teng 9a727efab8 Remove redirect entries for docs/admin/... pages 2023-01-29 19:56:56 +08:00
shubham82 8877644d48 Added the missing content for glusterfs. 2023-01-17 16:31:53 +09:00
Matt Cary 7a9ab129da
Update content/en/docs/concepts/storage/storage-classes.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2023-01-06 08:21:34 -08:00
Matt Cary 8b778eaaab
Update content/en/docs/concepts/storage/storage-classes.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2023-01-06 08:21:29 -08:00
Matthew Cary d256c64e38 Detail zonal provisioning for GCE PD 2023-01-05 17:11:34 -08:00
Qiming Teng a437285212 Fix nits in markdown links
This PR fixes a few "bad links" identified by the `scripts/linkchecker.py` script.
2022-12-22 08:45:10 +08:00
carolina valencia 7cd85d1fc4 Merge remote-tracking branch 'upstream/main' into dev-1.26 2022-12-07 11:40:37 -03:00
Akihito INOH 8ff2accb27 change the path spec for `sourceVolumeMode`
This commit replace `Spec.SourceVolumeMode` with
`spec.sourceVolumeMode`.
2022-12-04 10:24:27 +09:00
Humble Devassy Chirammal 34c152a433
remove glusterfs references from the docs (#37697)
* removal of glusterfs references from persistent-volumes.md

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>

* removal of glusterfs references from volumes.md

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>

* removal of glusterfs references from reference api guide

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>

* removal of GlusterFS references from storage-classes.md

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-12-01 16:49:54 -08:00
Kubernetes Prow Robot cec61c1754
Merge pull request #38052 from krol3/merged-main-dev-1.26
Merge main branch into dev-1.26
2022-11-29 11:59:09 -08:00
Takafumi Takahashi e837f0f804 Add document for Cross namespace data sources 2022-11-28 07:56:52 -05:00
carolina valencia b4ad83ef13 Merge remote-tracking branch 'upstream/main' into dev-1.26 2022-11-24 11:49:25 -03:00
Kubernetes Prow Robot b5aafaaac4
Merge pull request #37863 from krol3/merged-main-dev-1.26-02
Merge main branch into dev-1.26
2022-11-21 19:32:13 -08:00
Roman Bednar 02bc251655 RetroactiveDefaultStorageClass is beta in 1.26
Changing feature state to beta and correcting the article by removing
reference to its feature gate. As this feature no longer opt-in this
article makes more sense without it.
2022-11-21 08:12:56 +01:00
Kubernetes Prow Robot 89e8f360f9
Merge pull request #37815 from divyenpatel/new-branch-update-vsphere-doc-dev-1.26
CSIMigrationvSphere doc update
2022-11-17 12:24:35 -08:00
Kubernetes Prow Robot ee56ef7861
Merge pull request #37791 from Pradumnasaraf/Update-projected-volumes
docs: Update projected-volumes.md
2022-11-13 18:31:56 -08:00
andyzhangx 0d59a04348 mark CSIMigrationAzureFile as GA 2022-11-10 07:04:22 +00:00
windsonsea cd2d854a8f Tweak line wrappings in /volume-snapshots.md 2022-11-10 10:13:33 +08:00
Divyen Patel 646a4d013d CSIMigrationvSphere doc update 2022-11-09 10:20:45 -08:00
xin.li 337a63a995 [en] modify invalid links
Signed-off-by: xin.li <xin.li@daocloud.io>
2022-11-09 16:41:45 +08:00
Pradumna Saraf 0f9c060a68 docs: Update projected-volumes.md 2022-11-08 17:55:40 +00:00
Kubernetes Prow Robot fb297763e7
Merge pull request #35053 from verb/32351-projected-volumes
Clarify handling of projected SA token permissions
2022-11-08 08:42:19 -08:00
Chris Banks c760959192
Fix tiny typo in NFS Volume example.
`Pod.spec.volumes.nfs.readOnly` was subtly misspelled `readonly`, which was breaking the example.

```
$ k explain Pod.spec.volumes.nfs.readonly
error: field "readonly" does not exist
$ k explain Pod.spec.volumes.nfs.readOnly
KIND:     Pod
VERSION:  v1

FIELD:    readOnly <boolean>
...
```
2022-11-07 22:03:48 +00:00
Kubernetes Prow Robot b317d783ff
Merge pull request #37420 from mattcary/emptysize
Clarify emptyDir sizeLimit
2022-11-07 08:12:17 -08:00
Kubernetes Prow Robot b4bce489d3
Merge pull request #37704 from windsonsea/dynpro
Optimize link text in /dynamic-provisioning.md
2022-11-07 05:10:17 -08:00
Tim Bannister 3c53de8086
Mark glusterfs volume type deprecated everywhere
Fix up a few places where glusterfs wasn't marked as deprecated.
2022-11-05 18:16:27 +00:00
windsonsea 32f1033df0 Optimize link target in /dynamic-provisioning.md 2022-11-04 09:51:15 +08:00
Lee Verberne 3afe0c7cd7 Clarify which files are modified in projected service account tokens 2022-11-02 15:06:18 +01:00
Lee Verberne 77fd1deecd Address reviewer comments 2022-11-02 14:53:05 +01:00
windsonsea 35665871da Fix links about flexvolume 2022-11-01 15:38:12 +08:00
Kubernetes Prow Robot 93f9481370
Merge pull request #37495 from haosdent/haosdent/concepts/storage
KubeCon Docs Sprint: Update page weights for content/en/docs/concepts/storage
2022-10-30 17:18:45 -07:00
Haosdent Huang 54ecdc4896 KubeCon Docs Sprint: Update page weights for content/en/docs/concepts/storage. 2022-10-24 15:55:54 -04:00
Shivay Lamba e3ea67a23d Kubernetes Docs Sprint: lowercase volume
Signed-off-by: Shivay Lamba <shivaylamba@gmail.com>
2022-10-24 18:32:57 +00:00
Matthew Cary 8eece1b4b4 Clarify emptyDir sizeLimit 2022-10-24 10:34:49 -07:00
Grant MacGillivray 8fd0dbbed6
changing parenthesis location as per comment 2022-10-11 11:37:03 -07:00
Grant MacGillivray dc812cdc59
adding missing close parenthesis 2022-10-05 15:27:47 -07:00
Mitesh Jain 0c2ce1dc04
ExpandCSIVolumes is GA since 1.24 2022-09-22 15:20:24 +05:30
Kubernetes Prow Robot 3af9c833f1
Merge pull request #36534 from mac-chaffee/nfs-example
Add a Pod-based example for NFS volumes
2022-09-20 13:53:12 -07:00
Mac Chaffee 5f58dea140
Explicitly mention NFS via PV 2022-09-12 19:03:47 -04:00
Bishal das 3039cc0116
Update persistent-volumes.md 2022-09-06 20:01:48 +05:30
kadtendulkar fe1d65ba61 Update content/en/docs/concepts/storage/storage-capacity.md 2022-09-05 22:07:18 +05:30
Mac Chaffee 82756b1da1
Add a Pod-based example for NFS volumes 2022-09-02 12:32:24 -04:00
Kubernetes Prow Robot 008db23fe7
Merge pull request #36407 from johnlinp/add-note-pre-provisioned-snapshot
Add a note on the pre-provisioned snapshot scenario
2022-09-02 07:32:06 -07:00
John Lin 190cc364c2 Add a note on the pre-provisioned snapshot scenario
I found it confusing when filling a non-existing
volumeSnapshotRef when creating a VolumeSnapshotContent
in the pre-provisioned mode. I hope this note can clear
up some confusion.

Signed-off-by: John Lin <johnlinp@gmail.com>
2022-09-01 22:57:33 -07:00
kadtendulkar abd559c837 Update content/en/docs/concepts/storage/windows-storage.md 2022-08-30 22:06:05 +05:30
Lee Verberne 2512f5d7f1
Update content/en/docs/concepts/storage/projected-volumes.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-08-26 20:13:01 +02:00
kadtendulkar d2a5d8a9c7 Update content/en/docs/concepts/storage/storage-classes.md 2022-08-25 22:12:10 +05:30
Kubernetes Prow Robot 2a42a8a9c3
Merge pull request #36196 from kadtendulkar/kad27
Modify link context on Storage Classes page
2022-08-24 12:01:49 -07:00
kadtendulkar d176764df9 Update content/en/docs/concepts/storage/storage-classes.md 2022-08-23 21:36:34 +05:30
Roman Bednar 0a4a178f64 add documentation for retroactive default storage class assignment 2022-08-19 10:07:15 +02:00
carolina valencia 6810fa976d Merge remote-tracking branch 'upstream/main' into dev-1.25 2022-08-18 15:58:41 -03:00
Arnaud Meukam a180cd6853
Update docs to reference new container image registry
k8s.gcr.io is deprecated in favor of registry.k8s.io. The kubernetes
codebase have been updated with the new endpoint.

Ref: https://github.com/kubernetes/k8s.io/issues/3411

Signed-off-by: Arnaud Meukam <ameukam@gmail.com>
2022-08-18 16:35:26 +02:00
Kubernetes Prow Robot 6ddfd114d2
Merge pull request #35741 from kadtendulkar/kad24
Fix link on Storage Classes page
2022-08-17 02:20:55 -07:00
Jiawei Wang 5db7ddf2da Update CSI migration feature status, and remove docs for unsupported plugins 2022-08-16 04:38:47 +00:00
Kubernetes Prow Robot 7fa2e305bb
Merge pull request #35334 from humblec/nodeExpandDOC
csi: add nodeExpandSecret KEP details
2022-08-15 19:19:07 -07:00
Kubernetes Prow Robot 8bcf5e8458
Merge pull request #35510 from dobsonj/kep-596-1.25-updates
KEP-596: Move CSIInlineVolume to GA
2022-08-12 02:40:46 -07:00
Kubernetes Prow Robot c7350bc0d4
Merge pull request #35551 from divyenpatel/update-vsphere-doc
update migration requirement for in-tree vSphere volumes
2022-08-11 10:50:58 -07:00
Kubernetes Prow Robot 1827f44239
Merge pull request #35691 from Kartik494/update_CSI_Volume_cloning
improve documentation for Cloning support for  different storage classes
2022-08-10 18:32:58 -07:00
kadtendulkar ffb69f96ba Update content/en/docs/concepts/storage/volumes.md 2022-08-09 21:22:41 +05:30
kadtendulkar 68d8e4ad3d Update content/en/docs/concepts/storage/storage-classes.md
Update content/en/docs/concepts/storage/storage-classes.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-08-09 21:11:25 +05:30
kartik494 317c21379d improve documentation 2022-08-09 10:13:32 +05:30
Divyen Patel f5153aa41d update migration requirement for in-tree vSphere volumes
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-08-07 15:02:25 -07:00
Humble Chirammal 2c306bcc12 csi: add nodeExpandSecret KEP details
Ref#
KEP: https://github.com/kubernetes/enhancements/pull/3173/
Implementation: https://github.com/kubernetes/kubernetes/pull/105963
Blog: https://github.com/kubernetes/website/pull/33979

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-08-01 09:31:13 +05:30
Jonathan Dobson 37647c4ce8 KEP-596: Move CSIInlineVolume to GA 2022-07-28 09:31:37 -06:00
Kartik Sharma 9cf150f4c2
Update content/en/docs/concepts/storage/dynamic-provisioning.md
Co-authored-by: divya-mohan0209 <divya.mohan0209@gmail.com>
2022-07-26 09:24:45 +05:30
kartik494 8cc45e347d Add hyperlink for is-default-class annotation 2022-07-24 19:15:05 +05:30
Lee Verberne d825c72ed1
Fix typo in projected volumes formatting
Co-authored-by: Chris Negus <cnegus@redhat.com>
2022-07-19 08:24:51 +02:00
Lee Verberne f84789b099
Improve clarity of projected account token behavior
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-07-17 12:49:15 +02:00
Kubernetes Prow Robot b6faf1c863
Merge pull request #35049 from windsonsea/nodesyhf
[en] fix typos in /projected-volumes.md
2022-07-16 08:00:53 -07:00
John Daniel Maguire 13a3118ca5
Cinder conditionally supports ReadWriteMany volumes (#34219)
* Cinder conditionally supports ReadWriteMany volumes

* Link directly to official docs.

Signed-off-by: John Daniel Maguire <john.maguire@streamnative.io>
2022-07-16 07:26:53 -07:00
Lee Verberne 31416af3fa Clarify handling of projected SA token permissions 2022-07-15 16:57:01 +02:00
Michael 6a1caa355a [en] fix typos in /projected-volumes.md 2022-07-15 17:10:48 +08:00
Qiming Teng d705d9ed1c Batch fix links (3) 2022-07-09 09:14:06 +08:00
kadtendulkar 1092389655 Update content/en/docs/concepts/storage/ephemeral-volumes.md 2022-07-04 21:52:52 +05:30
Yuan Shing Kong 2d2ae604dd
Fix typo 2022-06-19 10:43:23 +08:00
Kubernetes Prow Robot 3a0d817bb8
Merge pull request #32400 from sftim/20220321_document_downward_api_concept
Revise downward API documentation
2022-06-16 23:38:31 -07:00
Kubernetes Prow Robot de82b20085
Merge pull request #33565 from jihoon-seo/220509_Fix_links_to_ephemeral_volume_types
Fix links to ephemeral volume types
2022-06-13 22:43:32 -07:00
Sean Wei 34155fed0b Fix links for k/design-proposals-archive
The contributors/design-proposals in k/community was removed. It's only
available in k/design-proposals-archive repo now.

This commit also changes https://github.com/kubernetes/repo/blob/master/file.md
to https://git.k8s.io/repo/file.md for better consistency.
2022-06-10 22:49:04 +08:00