IBM Support

Configure PersistentVolumeClaim for Doclink File Storage in Maximo Manage on OpenShift

How To


Summary

This guide shows two supported ways to configure file‑based attachments (Doclinks) for Maximo Manage on OpenShift using a PersistentVolumeClaim (PVC). You can configure the PVC either in OpenShift (by editing the ManageWorkspace custom resource instance) or in Manage Admin. Then align Maximo’s doclinks properties and folder defaults to the same mount path.

Steps

Step 1 — Plan

  • Pick an absolute Linux mount path (for example, /DOCLINKS)
  • Identify an RWX‑capable StorageClass (for example, CephFS)
  • Decide a lowercase RFC‑1123‑compliant pvcName (for example, doclinks)
 
Step 2 Option A — Configure the PVC in OpenShift (ManageWorkspace custom resource)

 

1) Navigate to Administration > CustomResourceDefinitions > search for ManageWorkspace

2) Select ManageWorkspace and click YAML tab 

3) Search for persistentvolume

4) Edit the YAML file. 

For example:

deployment:
      persistentVolumes:
        - accessModes:
            - ReadWriteMany
          mountPath: /DOCLINKS
          pvcName: doclinks
          size: 2Gi
          storageClassName: ocs-external-storagecluster-cephfs

 

5) Click Save.
 
6) In OpenShift console → Storage → PersistentVolumeClaims
 
Confirm that the PVC is created and Bound.
 
 
 
 
Step 2 Option B — Configure the PVC from Manage Admin

 

1) In Manage, navigate to Administration > Workspace > Manage

2) Actions > Update Configuration > click the pencil icon to edit Persistent Volume Claims (PVC)  

3) Enter Mount path, PVC name and size

  • Mount path is the in‑container folder where Manage reads/writes files (for example, /DOCLINKS).
  • When using a PVC, Attachment Library folders (Attachments, Images, Diagrams, etc.) save under that mount path.
  • PVC name must follow Kubernetes RFC‑1123 rules: all lowercase letters or digits, hyphen or dot allowed; must start and end with a letter or digit; up to 253 characters; unique within the namespace.

4) Click View under Additional properties

5) Enter a Storage class name 

Copy the Storage class name from OpenShift > Storage > StorageClasses).  If you have multiple storage classes, choose the one that supports ReadWriteMany (RWX) so multiple pods can mount and read/write the same volume concurrently.

6) Click Save

7) Scroll up the page and click Apply Changes

8) Go to OpenShift > Storage > PersistentVolumeClaims 

9) Check to see if it has created an entry for PVC and is Bound.

 

Step 3 — Configure Maximo doclinks system properties (file/PVC backend)

 

mxe.doclink.doctypes.defpath = /DOCLINKS

mxe.doclink.doctypes.topLevelPaths = /DOCLINKS

mxe.doclink.path01 = /DOCLINKS=https://hostname/maximo

mxe.doclink.securedAttachment = true

 
Step 4 — Configure Attachment Library / Folders

 

1) Open any Manage application with attachments

2) More Action > Attachment Library/Folders > Manage folders 

For each folder, set Default File Path to the Mount Path plus the folder name

/DOCLINKS/ATTACHMENTS
/DOCLINKS/IMAGES
/DOCLINKS/DIAGRAMS
/DOCLINKS/CAD
 

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB77","label":"Automation Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSRHPA","label":"IBM Maximo Application Suite"},"ARM Category":[{"code":"a8m50000000CbMTAA0","label":"System Administration-\u003EDoclinks"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"8.0.0;8.0.1;8.1.0;8.10.0;8.11.0;8.2.0;8.3.0;8.4.0;8.5.0;8.6.0;8.7.0;8.8.0;8.9.0;9.0.0;9.1.0;9.2.0"},{"Type":"MASTER","Line of Business":{"code":"LOB77","label":"Automation Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSO1W7","label":"IBM Maximo Application Suite as a Service"},"ARM Category":[{"code":"a8m50000000CbMTAA0","label":"System Administration-\u003EDoclinks"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":""},{"Type":"MASTER","Line of Business":{"code":"LOB77","label":"Automation Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSWT9A","label":"IBM Control Desk"},"ARM Category":[{"code":"a8m500000008b3TAAQ","label":"Miscellaneous Category (Portal, UI, Maximo, Install)"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.6.1"}]

Product Synonym

Maximo Manage;MAS; Attached documents

Document Information

Modified date:
11 July 2026

UID

ibm17266616

Page Feedback