Skip to content

Commit 1c6f382

Browse files
committed
[WIP]OSDOCS-5187: Revise storage section to MicroShift-specific
1 parent a5013ca commit 1c6f382

28 files changed

+181
-232
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -117,25 +117,22 @@ Topics:
117117
File: index
118118
- Name: Understanding ephemeral storage for MicroShift
119119
File: understanding-ephemeral-storage-microshift
120-
- Name: Understanding persistent storage for MicroShift
121-
File: understanding-persistent-storage-microshift
122-
- Name: Configuring persistent storage for MicroShift
123-
Dir: persistent_storage_microshift
124-
Topics:
125-
- Name: MicroShift storage plugin overview
126-
File: microshift-storage-plugin-overview
127-
- Name: Using container storage interface (CSI) for MicroShift
128-
Dir: container_storage_interface_microshift
129-
Distros: microshift
130-
Topics:
131-
- Name: Configuring CSI volumes for MicroShift
132-
File: microshift-persistent-storage-csi
133120
- Name: Generic ephemeral volumes for MicroShift
134121
File: generic-ephemeral-volumes-microshift
122+
- Name: Understanding persistent storage for MicroShift
123+
File: understanding-persistent-storage-microshift
135124
- Name: Expanding persistent volumes for MicroShift
136125
File: expanding-persistent-volumes-microshift
137-
- Name: Dynamic provisioning for MicroShift
138-
File: dynamic-provisioning-microshift
126+
- Name: Dynamic storage using the LVMS plugin
127+
File: microshift-storage-plugin-overview
128+
#- Name: Using container storage interface (CSI) for MicroShift
129+
# Dir: container_storage_interface_microshift
130+
# Distros: microshift
131+
# Topics:
132+
# - Name: Configuring CSI volumes for MicroShift
133+
# File: microshift-persistent-storage-csi
134+
#- Name: Dynamic provisioning for MicroShift
135+
# File: dynamic-provisioning-microshift
139136
---
140137
Name: Running applications
141138
Dir: microshift_running_apps

microshift_networking/microshift-networking.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ include::modules/microshift-mDNS.adoc[leveloffset=+1]
2929
[id="additional-resources_microshift-applying-networking-settings"]
3030
.Additional resources
3131

32-
. xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-version[Troubleshooting]
33-
. xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-troubleshooting-nodeport[Troubleshooting the NodePort service].
34-
. xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-nodeport-unreachable-workaround[NodePort unreachable workround].
32+
* xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-version[Troubleshooting]
33+
* xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-troubleshooting-nodeport[Troubleshooting the NodePort service]
34+
* xref:../microshift_troubleshooting/microshift-troubleshooting.adoc#microshift-nodeport-unreachable-workaround[NodePort unreachable workround]

microshift_storage/container_storage_interface_microshift/microshift-persistent-storage-csi.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ as persistent storage.
1616
{product-title} {product-version} supports version 1.5.0 of the link:https://github.com/container-storage-interface/spec[CSI specification].
1717
====
1818

19-
include::modules/persistent-storage-csi-architecture.adoc[leveloffset=+1]
20-
include::modules/persistent-storage-csi-external-controllers.adoc[leveloffset=+2]
21-
include::modules/persistent-storage-csi-driver-daemonset.adoc[leveloffset=+2]
2219
include::modules/persistent-storage-csi-dynamic-provisioning.adoc[leveloffset=+1]
2320
include::modules/persistent-storage-csi-mysql-example.adoc[leveloffset=+1]
21+
22+
[role="_additional-resources"]
23+
.Additional resources
24+
25+
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.12/html/storage/using-container-storage-interface-csi#persistent-storage-csi[{ocp} CSI Overview]

microshift_storage/expanding-persistent-volumes-microshift.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
:_content-type: ASSEMBLY
22
[id="expanding-persistent-volumes-microshift"]
33
= Expanding persistent volumes for {product-title}
4-
include::_attributes/common-attributes.adoc[]
4+
include::_attributes/attributes-microshift.adoc[]
55
:context: expanding-persistent-volumes-microshift
66

77
toc::[]
88

9-
//include::modules/storage-expanding-add-volume-expansion.adoc[leveloffset=+1]
9+
Learn how to expand persistent volumes in {product-title}.
1010

1111
include::modules/storage-expanding-csi-volumes.adoc[leveloffset=+1]
1212

13-
//include::modules/storage-expanding-flexvolume.adoc[leveloffset=+1]
14-
1513
include::modules/storage-expanding-local-volumes.adoc[leveloffset=+1]
1614

1715
include::modules/storage-expanding-filesystem-pvc.adoc[leveloffset=+1]

microshift_storage/index.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,19 @@ toc::[]
1616
[id="microshift-ephemeral-storage"]
1717
=== Ephemeral storage
1818

19-
Pods and containers are ephemeral or transient in nature and designed for stateless applications. Ephemeral storage allows administrators and developers to better manage the local storage for some of their operations. For more information about ephemeral storage overview, types, and management, refer to xref:../microshift_storage/understanding-ephemeral-storage-microshift.adoc#understanding-ephemeral-storage-microshift[Understanding ephemeral storage].
19+
Pods and containers are ephemeral or transient in nature and designed for stateless applications. Ephemeral storage allows administrators and developers to better manage the local storage for some of their operations. To read details about ephemeral storage, click xref:../microshift_storage/understanding-ephemeral-storage-microshift.adoc#understanding-ephemeral-storage-microshift[Understanding ephemeral storage].
2020

2121
[id="microshift-persistent-storage"]
2222
=== Persistent storage
2323

24-
Stateful applications deployed in containers require persistent storage. {product-title} uses a pre-provisioned storage framework called persistent volumes (PV) to allow cluster administrators to provision persistent storage. The data inside these volumes can exist beyond the lifecycle of an individual pod. Developers can use persistent volume claims (PVCs) to request storage requirements. For more information about persistent storage overview, configuration, and lifecycle, refer to xref:../microshift_storage/understanding-persistent-storage-microshift.adoc#understanding-persistent-storage-microshift[Understanding persistent storage].
25-
26-
[id="microshift-container-storage-interface"]
27-
== Container Storage Interface (CSI)
28-
29-
CSI is an API specification for the management of container storage across different container orchestration (CO) systems. You can manage the storage volumes within the container native environments, without having specific knowledge of the underlying storage infrastructure. With the CSI, storage works uniformly across different container orchestration systems, regardless of the storage vendors you are using. For more information about CSI, refer to xref:../microshift_storage/container_storage_interface_microshift/microshift-persistent-storage-csi.adoc#persistent-storage-csi-microshift[Using Container Storage Interface (CSI) for MicroShift].
24+
Stateful applications deployed in containers require persistent storage. {product-title} uses a pre-provisioned storage framework called persistent volumes (PV) to allow cluster administrators to provision persistent storage. The data inside these volumes can exist beyond the lifecycle of an individual pod. Developers can use persistent volume claims (PVCs) to request storage requirements. For persistent storage details, read xref:../microshift_storage/understanding-persistent-storage-microshift.adoc#understanding-persistent-storage-microshift[Understanding persistent storage].
3025

3126
[id="microshift-dynamic-provisioning-overview"]
32-
== Dynamic Provisioning
27+
=== Dynamic storage provisioning
28+
29+
Using dynamic provisioning allows you to create storage volumes on-demand, eliminating the need for pre-provisioned storage. For more information about how dynamic provisioning works in {product-title}, read xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-plugin-overview[Dynamic provisioning].
3330

34-
Dynamic Provisioning allows you to create storage volumes on-demand, eliminating the need for cluster administrators to pre-provision storage. For more information about dynamic provisioning, refer to xref:../microshift_storage/dynamic-provisioning-microshift.adoc#dynamic-provisioning-microshift[Dynamic provisioning].
31+
//[id="microshift-container-storage-interface"]
32+
//== Container Storage Interface (CSI)
3533

34+
//CSI is an API specification for the management of container storage across different container orchestration (CO) systems. You can manage the storage volumes within the container native environments, without having specific knowledge of the underlying storage infrastructure. With the CSI, storage works uniformly across different container orchestration systems, regardless of the storage vendors you are using. For more information about CSI, read ../microshift_storage/container_storage_interface_microshift/microshift-persistent-storage-csi.adoc#persistent-storage-csi-microshift[Using Container Storage Interface (CSI) for MicroShift].
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_content-type: ASSEMBLY
22
[id="microshift-storage-plugin-overview"]
3-
= {product-title} storage plugin overview
4-
include::_attributes/common-attributes.adoc[]
3+
= Dynamic storage using the LVMS plugin
4+
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-storage-plugin-overview
66

77
toc::[]
@@ -10,12 +10,12 @@ toc::[]
1010

1111
LVMS provisions new logical volume management (LVM) logical volumes (LVs) for container workloads with appropriately configured persistent volume claims (PVC). Each PVC references a storage class that represents an LVM Volume Group (VG) on the host node. LVs are only provisioned for scheduled pods.
1212

13-
include::modules/microshift-lvms-deployment.adoc[leveloffset=+1]
13+
include::modules/microshift-lvms-system-requirements.adoc[leveloffset=+1]
1414

15-
include::modules/microshift-lvms-configuring.adoc[leveloffset=+1]
15+
include::modules/microshift-lvms-deployment.adoc[leveloffset=+1]
1616

17-
include::modules/microshift-setting-lvms-path.adoc[leveloffset=+2]
17+
include::modules/microshift-lvms-setting-path.adoc[leveloffset=+2]
1818

19-
include::modules/microshift-lvms-system-requirements.adoc[leveloffset=+1]
19+
include::modules/microshift-lvms-configuring.adoc[leveloffset=+1]
2020

2121
include::modules/microshift-using-lvms.adoc[leveloffset=+1]

microshift_storage/persistent_storage_microshift/_attributes

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_storage/persistent_storage_microshift/images

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_storage/persistent_storage_microshift/modules

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_storage/persistent_storage_microshift/snippets

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)