Creating volumes and folders for deployment on Kubernetes

The content services component containers require some persistent volumes, persistent volume claims, and folders to be created before you can deploy. The deployment process uses these volumes and folders during the deployment.

About this task

 New in 20.0.2  You can choose to have the operator dynamically provision storage for you at deployment time. In that case, you do not need to create volumes and folders manually for your container environment. You can leave all storage values for your FileNet® Content Manager components with the default value in the custom resource YAML.

Remember:  New in 20.0.2  Storage can be provisioned using a mixture of static and dynamic. The operator uses the persistent volume claim names, of the default values, to determine if a claim already exists.
  • If the claim does not exist, dynamic provisioning is used. The persistent volume claim names provided in the custom resource YAML are used when the claim is created.
  • If the claim does exist, that claim is used when deploying.
  • If static provisioning is used, the persistent volumes and persistent volume claims must be pre-created and the persistent volume claim name provided in the CR.

If you are deploying  For 20.0.1  or earlier, or you want to use manual configuration for your storage, use the steps in this topic.

Although the following information describes the volumes that are generally required, you can decide to designate more or fewer persistent volumes and volume claims.

You can use a YAML file to capture details like the name and the specifications of the persistent volume that you want to create, and use the Kubectl command line tool with the file to create the persistent volume object. You use a similar approach to create the persistent volume claims. See the following example for more details: Configure a persistent volume for storage.

Directory permissions and ownership

The permissions that are described in the following steps are examples that provide a secure environment. Your environment might have different permission requirements. Consider the following possibilities when you apply permissions to your folders:
  • The NFS export root_squash option is strongly recommended for security. If you use the root_squash option, then the file directories to be used for the PVs group ownership must be set to the one specified by the anongid option given in the NFS export definition. The default anongid value is 65534.
  • If the no_root_squash option is used, the PV group ownership must be set to the root group 0.
  • Assign read, write, execute permissions to both the user and group owners, for example, chmod 770
The following settings are required by FileNet Content Manager when creating your NFS exports:
  • The rw,sync,no_wdelay settings are required.
  • The no_subtree_check setting is recommended for performance.
Tip: When you replace the value for the <NFS Server> in the samples, you might need to provide the private IP of the server, depending on your environment.
Remember: The storage volumes that you create must specify the appropriate reclaim policy and access modes:
  • accessModes: - ReadWriteMany
  • persistentVolumeReclaimPolicy: Retain
Note: For deployments with a preexisting FileNet P8 domain, ensure that all folders and files are updated with the permissions and group ownership settings that are described in this topic. For example, if you want to deploy a new environment against your existing data and configuration to upgrade the Cloud Pak version, check your settings and update permissions and ownership as needed.
On the NFS server, navigate to the root path that contains all related PV folders, and run 
chmod -R g+rw

The persistent volume and persistent volume claim names that are provided in the following tables are examples.

Procedure

  • Create the folders, persistent volumes, and persistent volume claims for the Content Platform Engine container deployment:
    Note: The tables show a single value in the example volume and volume claim name because in most cases the persistent volume and persistent volume claim have the same name.
    Table 1. Volumes, volume claims, and folders for Content Platform Engine
    Volume purpose Example Folder to Create Example Volume and Volume Claim to Create mountPath as Seen by Container
    Content Platform Engine Liberty configuration /home/cfgstore/cpe/configDropins/overrides cpe-cfgstore-pv

    cpe-cfgstore-pvc

    		 /opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides
    Content Platform Engine Liberty logs /home/cfgstore/cpe/logs cpe-logstore-pv

    cpe-logstore-pvc

    		 /opt/ibm/wlp/usr/servers/defaultServer/logs
    Content Platform Engine FileNet logs /home/cfgstore/cpe/cpefnlogstore cpe-fnlogstore-pv

    cpe-fnlogstore-pvc

    		 /opt/ibm/wlp/usr/servers/defaultServer/FileNet
    Content Platform Engine FileNet (for upgrade) /home/cfgstore/cpe/bootstrap cpe- bootstrapstore-pv

    cpe- bootstrapstore-pvc

    		 /opt/ibm/wlp/usr/servers/defaultServer/lib/Bootstrap
    Content Platform Engine temporary working space /home/cfgstore/cpe/textext cpe-textextstore-pv

    cpe-textextstore-pvc

    		 /opt/ibm/textext
    Content Platform Engine IBM Case Manager rules /home/cfgstore/cpe/icmrules cpe-icmrulesstore-pv

    cpe-icmrulesstore-pvc

    		 /opt/ibm/icmrules
    Content Platform Engine file system-based advanced storage device or file store /home/cfgstore/cpe/asa cpe-filestore-pv

    cpe-filestore-pvc

    		 /opt/ibm/asa
    For each of the folders, set the ownership as follows:
    chgrp -R 65534 /cpecfgstore
    For each of the folders, set the permissions as follows:
    chmod -Rf g=u /cpecfgstore

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Platform Engine configuration store volume.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-cfgstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/configDropins/overrides
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-cfgstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-cfgstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-cfgstore-pv
  volumeName: cpe-cfgstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Platform Engine Liberty logs volume.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-logstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/logs
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-logstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-logstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-logstore-pv
  volumeName: cpe-logstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Platform Engine FileNet logs volume.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-fnlogstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/asa
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-fnlogstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-fnlogstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-fnlogstore-pv
  volumeName: cpe-fnlogstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Platform Engine bootstrap information (upgrade only).

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-bootstrap-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/bootstrap
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-bootstrap-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-bootstrap-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-bootstrap-pv
  volumeName: cpe-bootstrap-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Platform Engine temporary working space.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-textext-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/textext
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-textext-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-textext-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-textext-pv
  volumeName: cpe-textext-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the IBM Case Manager rules.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-icmrules-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/icmrules
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-icmrules-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-icmrules-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-icmrules-pv
  volumeName: cpe-icmrules-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Platform Engine file system-based advanced storage device or file store.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cpe-filestore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cpe/asa
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cpe-filestore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cpe-filestore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cpe-filestore-pv
  volumeName: cpe-filestore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  • Create the persistent volumes and persistent volume claims for the Content Search Services container deployment:
    Table 2. Volumes, volume claims, and folders for Content Search Services
    Volume purpose Example Folder to Create Example Volume and Volume Claim to Create mountPath as seen by container
    Content Search services container data /home/cfgstore/css/CSS_Server_data/sslkeystore css-cfgstore-pv

    css-cfgstore-pvc

    		 /opt/IBM/ContentSearchServices/CSS_Server/data
    Content Search Services temporary working space /home/cfgstore/css/CSS_Server_temp css-tempstore-pv

    css-tempstore-pvc

    		 /opt/IBM/ContentSearchServices/CSS_Server/temp
    Content Search Services logs /home/cfgstore/css/CSS_Server_log css-logstore-pv

    css-logstore-pvc

    		 /opt/IBM/ContentSearchServices/CSS_Server/log
    Content Search Services full text indexes /home/cfgstore/css/CSS_Indexes css-indexstore

    css-indexstore-pvc

    		 /opt/ibm/indexareas
    Content Search Services custom store /mnt/nfsshare/css/customstore cs-icp-customstore-pv

    cs-icp-customstore-pvc

    		 /css/customstore
    For each of the folders, set the ownership as follows:
    chgrp -R 65534 /csscfgstore
    For each of the folders, set the permissions as follows:
    chmod -Rf g=u /csscfgstore

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Search Services container data.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: css-cfgstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/css/CSS_Server_data
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: css-cfgstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: css-cfgstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: css-cfgstore-pv
  volumeName: css-cfgstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Search Services temporary working space.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: css-tempstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/css/CSS_Server_temp
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: css-tempstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: css-tempstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: css-tempstore-pv
  volumeName: css-tempstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Search Services logs.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: css-logstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/css/CSS_Server_log
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: css-logstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: css-logstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: css-logstore-pv
  volumeName: css-logstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Search Services full text indexes.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: css-indexstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/css/CSSIndex_OS1
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: css-indexstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: css-indexstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: css-indexstore-pv
  volumeName: css-indexstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Content Search Services custom store.

    Persistent volume:
    apiVersion: v1
{
  "kind": "PersistentVolume",
  "apiVersion": "v1",
  "metadata": {
    "name": "css-icp-customstore-pv",
    "labels": {}
  },
  "spec": {
    "storageClassName": "css-icp-customstore",
    "capacity": {
      "storage": "1Gi"
    },
    "accessModes": [
      "ReadWriteMany"
    ],
    "persistentVolumeReclaimPolicy": "Retain",
    "nfs": {
      "path": "/mnt/nfsshare/css/customstore",
      "server": "9.30.166.71"
    }
  }
}
    Persistent volume claim:
    apiVersion: v1
{
  "kind": "PersistentVolumeClaim",
  "apiVersion": "v1",
  "metadata": {
    "name": "css-icp-customstore",
    "namespace": "default"
  },
  "spec": {
    "storageClassName": "css-icp-customstore",
    "resources": {
      "requests": {
        "storage": "1Gi"
      }
    },
    "accessModes": [
      "ReadWriteMany"
    ]
  }
}
  • Create the persistent volumes and persistent volume claims for the Content Management Interoperability Services (CMIS) container deployment:
    Table 3. Volumes, volume claims, and folders for Content Management Interoperability Services (CMIS)
    Volume purpose Example Folder to Create Example Volume and Volume Claim Name mountPath as seen by container
    CMIS and Liberty configuration data /home/cfgstore/cmis/configDropins/overrides cmis-cfgstore-pv

    cmis-cfgstore-pvc

    		 /cmiscfgstore/cmis/configDropins/overrides
    Logs volume for IBM Content Navigator and Liberty logs /home/cfgstore/cmis/logs cmis-logstore-pv

    cmis-logstore-pvc

    		 /cmislogstore/cmis/logs
    For each of the folders, set the ownership sat follows:
    chgrp -R 65534 /cmiscfgstore
    For each of the folders, set the permissions as follows:
    chmod -Rf g=u /cmiscfgstore

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the CMIS configuration data.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cmis-cfgstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cmis/configDropins/overrides
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cmis-cfgstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cmis-cfgstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cmis-cfgstore-pv
  volumeName: cmis-cfgstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the CMIS logs.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: cmis-logstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/cmis/logs
    server: <NFS Server>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: cmis-logstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: cmis-logstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: cmis-logstore-pv
  volumeName: cmis-logstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  • Create the persistent volumes and persistent volume claims for the Task Manager container deployment:
    Table 4. Volumes, volume claims, and folders for Task Manager
    Volume purpose Example Folder to Create Example Volume and Volume Claim to Create mountPath as seen by container
    Task Manager Liberty configuration /home/cfgstore/tm/configDropins/overrides tm-cfgstore-pv

    tm-cfgstore-pvc

    		 /opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides
    Task Manager and Liberty logs /home/cfgstore/tm/logs tm-logstore-pv

    tm-logstore-pvc

    		 /opt/ibm/wlp/usr/servers/defaultServer/logs
    Custom plug-ins for Task Manager /home/cfgstore/tm/extTM tm-pluginstore-pv

    tm-pluginstore-pvc

    		 /opt/ibm/extTM
    For each of the folders, set the ownership as follows: 
    chgrp -R 65534 /tmcfgstore
    For each of the folders, change the permissions settings as follows:
    chmod -Rf g=u /tmcfgstore

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Task Manager configuration store volume.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: tm-cfgstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/tm/configDropin/overrides
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: tm-cfgstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: tm-cfgstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: tm-cfgstore-pv
  volumeName: tm-cfgstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for the Task Manager and Liberty logs.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: tm-logstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/tm/logs
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: tm-logstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: tm-logstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: tm-logstore-pv
  volumeName: tm-logstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi

    The following examples illustrate the YAML file contents to create a persistent volume and persistent volume claim for Task Manager plugins.

    Persistent volume:
    apiVersion: v1
kind: PersistentVolume
metadata:
  name: tm-pluginstore-pv
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi
  nfs:
    path: /home/cfgstore/tm/plugins
    server: <NFS_SERVER>
  persistentVolumeReclaimPolicy: Retain
  storageClassName: tm-pluginstore-pv
    Persistent volume claim:
    apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: tm-pluginstore-pvc
  namespace: <NAMESPACE>
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Gi
  storageClassName: tm-pluginstore-pv
  volumeName: tm-pluginstore-pv
status:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 1Gi