Creating volumes and folders for deployment

The document processing 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

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 Automation Document Processing components with the default value in the custom resource YAML.

For deployments on all other platforms, you specify your type of storage class, for example, ibmc-file-bronze-gid, ibmc-file-silver-gid, or ibmc-file-gold-gid for the following parameters:

shared_configuration.storage_configuration.sc_slow_file_storage_classname

shared_configuration.storage_configuration.sc_medium_file_storage_classname

shared_configuration.storage_configuration.sc_fast_file_storage_classname

You can use the same storage type for all the parameters.

Remember: 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 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 External link opens a new window or tab .

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.

Remember: The storage volumes that you create must specify the appropriate reclaim policy and access modes:

accessModes: - ReadWriteMany
persistentVolumeReclaimPolicy: Retain

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 Automation Document Processing 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
Git Gateway data store	/gitgateway-datastore	gitgateway-datastore-pv gitgateway-datastore-pvc
Document Processing Designer service logs	/cds-logstore	cds-logstore-pv cds-logstore-pvc
Document Processing Repository API configuration store	/cpra-cfgstore	cdra-cfgstore-pv cdra-cfgstore-pvc
Document Processing Repository API log store	/cdra-logstore	cdra-logstore-pv cdra-logstore-pvc
Document Processing Deployment Service configuration store	/cpds-cfgstore	cpds-cfgstore-pv cpds-cfgstore-pvc
Document Processing Deployment Service log store	/cpds-logstore	cpds-logstore-pv cpds-logstore-pvc
Viewone cache store	/viewone-cachestore	viewone-cachestore-pv viewone-cachestore-pvc
Viewone doc store	/viewone-docstore	viewone-docstore-pv viewone-docstore-pvc
Viewone workstore	/viewone-workstore	viewone-workstore-pv viewone-workstore-pvc
Viewone extstore	/	viewone-extstore-pv viewone-extstore-pvc
Viewone clientlogstore	/viewone-clientlogstore	viewone-clientlogstore-pv viewoneclientlogstore-pvc
Viewone logstore	/viewone-logstore	viewone-logstore-pv viewone-logstore-pvc
Viewone fontfilestore	/viewone-fontfilestore	viewone-fontfilestore-pv viewone-fontfilestore-pvc
Document Processing log store	/sp-log	sp-log-pv sp-log-pvc
Document Processing data store	/sp-data	sp-data-pv sp-data-pvc

For each of the folders, set the ownership as follows:

chgrp -R 65534 /cdra-cfgstore

For each of the folders, set the permissions as follows:

chmod -Rf g=u /cdra-cfgstore

The following examples illustrate the YAML file contents to create a persistent volume claim for the Document Processing Repository API configuration store volume.

Persistent volume claim:

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: NAMESPACE-operator-shared-pvc
  namespace: NAMESPACE
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 5Gi
  volumeName: NAMESPACE-operator-shared-pv

What to do next

To set up a connection to a Git server for an authoring or development environment, see Preparing the Git connection.