Skip to content

Commit

Permalink
Update DataVolume doc references from the 'pvc' API to the 'storage' …
Browse files Browse the repository at this point in the history
…API (#3244)

* Docs: Replace instances of pvc with storage

All instances of DataVolume > Spec > PVC have been replaced with storage,
except for two cases in datavolumes.md:
- Data Volumes>Target Storage/PVC>PVC
    https://github.com/kubevirt/containerized-data-importer/blob/338bafe/doc/datavolumes.md#pvc
- Data Volumes>Source>PVC source
    https://github.com/kubevirt/containerized-data-importer/blob/338bafe/doc/datavolumes.md#pvc-source

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Docs: Replace `Storage` with `storage` in doc/datavolumes.md

I also reworded it so that the paragraph does not start in lower-case.

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Docs: Remove optional default 'accessModes: ReadWriteOnce' from docs

Removed from storage options, I still kept it for the pvc.

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Docs: Remove resources/requests/storage when cloning a PVC

This argument is optional. Only removed for 'storage', not 'pvc'.

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Replace 'pvc' with 'storage' API in manifests

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Docs: Moved 'Target Storage/PVC' section above 'Source'

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Docs: Rephrase the Storage target section to emphasize it over PVC

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Fix empty field in YAML file

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Rephrase prose around filesystem volume mode

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Fix grammar and spelling

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Write acces mode in upgrade-testing-artifacts manifest

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>

* Update doc/datavolumes.md

Co-authored-by: Alexander Wels <awels@redhat.com>
Signed-off-by: Edu Gómez Escandell <edu1997xyz@gmail.com>

---------

Signed-off-by: Edu Gómez Escandell <egomez@redhat.com>
Signed-off-by: Edu Gómez Escandell <edu1997xyz@gmail.com>
Co-authored-by: Alexander Wels <awels@redhat.com>
  • Loading branch information
EduardGomezEscandell and awels authored Jun 7, 2024
1 parent 5c08db5 commit f3d0060
Show file tree
Hide file tree
Showing 27 changed files with 140 additions and 227 deletions.
16 changes: 4 additions & 12 deletions doc/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ spec:
http:
url: "https://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img"
contentType: kubevirt
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 500Mi
Expand All @@ -49,9 +47,7 @@ spec:
http:
url: "http://geolite.maxmind.com/download/geoip/database/GeoLite2-Country.tar.gz"
contentType: archive
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 500Mi
Expand All @@ -66,9 +62,7 @@ metadata:
spec:
source:
registry: "docker://kubevirt/fedora-cloud-registry-disk-demo"
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 5Gi
Expand All @@ -90,9 +84,7 @@ metadata:
spec:
source:
blank: {}
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 500Mi
Expand Down
4 changes: 1 addition & 3 deletions doc/blank-raw-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ metadata:
spec:
source:
blank: {}
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 500Mi
Expand Down
7 changes: 1 addition & 6 deletions doc/clone-block-datavolume.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,8 @@ spec:
pvc:
namespace: "source-ns"
name: "source-datavolume"
pvc:
storage:
volumeMode: Block
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
```
Deploy the DataVolume manifest:
Expand Down
7 changes: 1 addition & 6 deletions doc/clone-datavolume.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,7 @@ spec:
pvc:
namespace: source-ns
name: source-datavolume
pvc:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 500Mi
storage: {}
```
Deploy the DataVolume manifest:
Expand Down
2 changes: 0 additions & 2 deletions doc/clone-from-volumesnapshot-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,6 @@ spec:
name: golden-volumesnapshot
storage:
storageClassName: rook-ceph-block
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 9Gi
Expand Down
12 changes: 3 additions & 9 deletions doc/datavolume-annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ spec:
source:
http:
url: "http://mirrors.nav.ro/fedora/linux/releases/33/Cloud/x86_64/images/Fedora-Cloud-Base-33-1.2.x86_64.qcow2"
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 1Gi
Expand All @@ -49,9 +47,7 @@ spec:
source:
http:
url: "http://mirrors.nav.ro/fedora/linux/releases/33/Cloud/x86_64/images/Fedora-Cloud-Base-33-1.2.x86_64.qcow2"
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 1Gi
Expand Down Expand Up @@ -81,9 +77,7 @@ spec:
source:
http:
url: "http://mirrors.nav.ro/fedora/linux/releases/33/Cloud/x86_64/images/Fedora-Cloud-Base-33-1.2.x86_64.qcow2"
pvc:
accessModes:
- ReadWriteOnce
storage:
resources:
requests:
storage: 1Gi
Expand Down
Loading

0 comments on commit f3d0060

Please sign in to comment.