Skip to content

Commit 432d269

Browse files
ankediarjeberhard
authored andcommitted
Add the PV and PVC requirements for the domain home on PV usage documentation.
1 parent e668647 commit 432d269

File tree

2 files changed

+16
-8
lines changed
  • documentation/site/content

2 files changed

+16
-8
lines changed

documentation/site/content/managing-domains/domain-on-pv/usage.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,14 @@ for you.
142142
The specifications of `PersistentVolume` and `PersistentVolumeClaim` are environment specific and often require information
143143
from your Kubernetes cluster administrator. See [Persistent Storage](#references) in different environments.
144144

145-
For example, if you specify the specification of the `Persistent Volume` and `Persistent Volume Claim` in the domain resource YAML file,
145+
##### PV and PVC requirements
146+
- Domain on PV requires that the PV and PVC are created with `Filesystem` volume mode; `Block` volume mode is **not** supported.
147+
- If you request that the operator creates the PV and PVC, then it uses the default `Filesystem` volume mode.
148+
- If you plan to use an existing PV and PVC, then ensure that it was created with `Filesystem` volume mode.
149+
- You must use a storage provider that supports the `ReadWriteMany` option.
150+
- The operator will automatically set the owner of all files in the domain home on the persistent volume to `uid 1000` with `gid 0`. If you want to use a different user and group, then configure the desired `runAsUser` and `runAsGroup` in the security context under the `spec.serverPod.podSecurityContext` section of the Domain YAML file. The operator will use these values when setting the owner for files in the domain home directory.
151+
152+
For example, if you provide the specification of the `Persistent Volume` and `Persistent Volume Claim` in the domain resource YAML file,
146153
then the operator will create the `PV` and `PVC`, and mount the persistent volume to the `/share` directory.
147154

148155
```

documentation/site/content/samples/domains/domain-home-on-pv/sample.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
---
2-
title: "Domain on PV sample"
2+
title: "Sample"
33
date: 2019-02-23T17:32:31-05:00
44
weight: 3
55
description: "Sample for creating a WebLogic domain home on a PV for deploying the generated WebLogic domain."
66
---
77

88
{{< table_of_contents >}}
99

10+
{{% notice note %}}
11+
12+
**Before you begin**: Perform the steps in [Prerequisites]({{< relref "/samples/domains/domain-home-on-pv/prerequisites.md" >}}) and then build a Domain on PV `domain creation image` by completing the steps in [Build the domain creation image]({{< relref "/samples/domains/domain-home-on-pv/build-domain-creation-image#build-the-domain-creation-image" >}}).
13+
If you are taking the `JRF` path through the sample, then substitute `JRF` for `WLS` in your image names and directory paths. Also note that the JRF-v1 model YAML file differs from the WLS-v1 YAML file (it contains an additional `domainInfo -> RCUDbInfo` stanza).
14+
{{% /notice %}}
15+
1016
### Overview
1117

12-
The sample demonstrates setting up a WebLogic domain with a domain home on a Kubernetes PersistentVolume (PV) (Domain on PV). This involves:
18+
The sample demonstrates setting up a WebLogic domain with a domain home on a Kubernetes PersistentVolume (PV) (**Domain on PV**). This involves:
1319

1420
- Using the [domain creation image](#domain-creation-image) that you previously built.
1521
- Creating secrets for the domain.
@@ -19,11 +25,6 @@ The sample demonstrates setting up a WebLogic domain with a domain home on a Kub
1925
- Defines PV and PVC metadata and specifications in the `spec.configuration.initializeDomainOnPV` section to create a PV and PVC (optional).
2026

2127

22-
{{% notice note %}}
23-
**Before you begin**: Perform the steps in [Prerequisites]({{< relref "/samples/domains/domain-home-on-pv/prerequisites.md" >}}) and then build a Domain on PV `domain creation image` by completing the steps in [Build the domain creation image]({{< relref "/samples/domains/domain-home-on-pv/build-domain-creation-image#build-the-domain-creation-image" >}}).
24-
If you are taking the `JRF` path through the sample, then substitute `JRF` for `WLS` in your image names and directory paths. Also note that the JRF-v1 model YAML file differs from the WLS-v1 YAML file (it contains an additional `domainInfo -> RCUDbInfo` stanza).
25-
{{% /notice %}}
26-
2728

2829
**PV and PVC Notes:**
2930
- The specifications of PersistentVolume and PersistentVolumeClaim defined in the `spec.configuration.initializeDomainOnPV` section of the Domain resource YAML file are environment specific and often require information from your Kubernetes cluster administrator to provide the information. See [Persistent volume and Persistent Volume Claim]({{< relref "/managing-domains/domain-on-pv/usage#persistent-volume-and-persistent-volume-claim" >}}) in the user documentation for more details.

0 commit comments

Comments
 (0)