Skip to content

Commit

Permalink
BZ1850510 - Update NFS registry storage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bob Furu authored and openshift-cherrypick-robot committed Aug 4, 2020
1 parent 2a298eb commit f6a11e3
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 14 deletions.
14 changes: 9 additions & 5 deletions modules/registry-configuring-storage-baremetal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ ReadWriteMany access mode.
. To configure your registry to use storage, change the `spec.storage.pvc` in
the `configs.imageregistry/cluster` resource.
+
[NOTE]
====
When using shared storage such as NFS, it is strongly recommended to use the `supplementalGroups` strategy, which dictates the allowable supplemental groups for the Security Context, rather than the `fsGroup` ID. Refer to the NFS *Group IDs* documentation for details.
====

. Verify you do not have a registry Pod:
+
----
Expand All @@ -34,13 +39,12 @@ $ oc get pod -n openshift-image-registry
+
[NOTE]
=====
If the storage type is `emptyDIR`, the replica number cannot be greater than `1`.
If the storage type is `NFS`, and you want to scale up the registry Pod by setting
`replica>1` you must enable the `no_wdelay` mount option. For example:
* If the storage type is `emptyDIR`, the replica number cannot be greater than `1`.
* If the storage type is `NFS`, you must enable the `no_wdelay` and `root_squash` mount options. For example:
+
----
# cat /etc/exports
/mnt/data *(rw,sync,no_wdelay,no_root_squash,insecure,fsid=0)
/mnt/data *(rw,sync,no_wdelay,root_squash,insecure,fsid=0)
sh-4.2# exportfs -rv
exporting *:/mnt/data
----
Expand Down
14 changes: 9 additions & 5 deletions modules/registry-configuring-storage-vsphere.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ a different storage backend, such as `NFS`, to configure the registry storage.
. To configure your registry to use storage, change the `spec.storage.pvc` in the
`configs.imageregistry/cluster` resource.
+
[NOTE]
====
When using shared storage such as NFS, it is strongly recommended to use the `supplementalGroups` strategy, which dictates the allowable supplemental groups for the Security Context, rather than the `fsGroup` ID. Refer to the NFS *Group IDs* documentation for details.
====

. Verify you do not have a registry Pod:
+
----
Expand All @@ -42,13 +47,12 @@ $ oc get pod -n openshift-image-registry
+
[NOTE]
=====
If the storage type is `emptyDIR`, the replica number cannot be greater than `1`.
If the storage type is `NFS`, and you want to scale up the registry Pod by setting
`replica>1` you must enable the `no_wdelay` mount option. For example:
* If the storage type is `emptyDIR`, the replica number cannot be greater than `1`.
* If the storage type is `NFS`, you must enable the `no_wdelay` and `root_squash` mount options. For example:
+
----
# cat /etc/exports
/mnt/data *(rw,sync,no_wdelay,no_root_squash,insecure,fsid=0)
/mnt/data *(rw,sync,no_wdelay,root_squash,insecure,fsid=0)
sh-4.2# exportfs -rv
exporting *:/mnt/data
----
Expand Down
5 changes: 3 additions & 2 deletions modules/storage-persistent-storage-nfs-group-ids.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
// Module included in the following assemblies:
//
// * storage/persistent_storage/persistent-storage-nfs.adoc
// * storage/registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc

[id=storage-persistent-storage-nfs-group-ids_{context}]
= Group IDs

The recommended way to handle NFS access, assuming it is not an option to
Expand All @@ -13,8 +15,7 @@ Pod's `securityContext`.

[NOTE]
====
It is generally preferable to use supplemental group IDs to gain access to
persistent storage versus using user IDs.
To gain access to persistent storage, it is generally preferable to use supplemental group IDs versus user IDs.
====

Because the group ID on the example target NFS directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ include::modules/installation-registry-storage-config.adoc[leveloffset=+1]

include::modules/registry-configuring-storage-baremetal.adoc[leveloffset=+1]

See xref:../../storage/persistent_storage/persistent-storage-nfs.adoc#storage-persistent-storage-nfs-group-ids_persistent-storage-nfs[Group IDs] for additional details about using supplemental groups to handle NFS access.

include::modules/installation-registry-storage-non-production.adoc[leveloffset=+1]


[id="configuring-registry-storage-baremetal-addtl-resources"]
== Additional resources

For more details on configuring registry storage for bare metal, see xref:../../scalability_and_performance/optimizing-storage.adoc#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].
For more details about configuring registry storage for bare metal, see xref:../../scalability_and_performance/optimizing-storage.adoc#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ include::modules/installation-registry-storage-config.adoc[leveloffset=+2]

include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+1]

See xref:../../storage/persistent_storage/persistent-storage-nfs.adoc#storage-persistent-storage-nfs-group-ids_persistent-storage-nfs[Group IDs] for additional details about using supplemental groups to handle NFS access.

include::modules/installation-registry-storage-non-production.adoc[leveloffset=+1]

include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+1]
Expand All @@ -21,4 +23,4 @@ For instructions about configuring registry storage so that it references the co
[id="configuring-registry-storage-vsphere-addtl-resources"]
== Additional resources

For more details on configuring registry storage for vSphere, see xref:../../scalability_and_performance/optimizing-storage.adoc#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].
For more details about configuring registry storage for vSphere, see xref:../../scalability_and_performance/optimizing-storage.adoc#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].

0 comments on commit f6a11e3

Please sign in to comment.