Loading...

FlexFrame - Prerequisites

Before you install the Commvault agent software, create a directory structure and add symbolic links on the Flexframe mount point so that the software can be installed successfully. You must perform this configuration in Maintenance Mode.

Note: All application specific user IDs that are configured in the Commvault software must have the umask002 in the .profile file.

Commvault Software Directories

The Commvault files such as the executable files, the configuration files and the registry files are located in the add-on volume and must be mounted on the application nodes. From this location, create the following directory structure for every FlexFrame pool and database (indicated by the database SID). FlexFrame provides the physical node for these directories.

  • commvault_pool - contains application-specific Commvault outputs. Mount this directory as /addon/commvault_pool.
    • IndexCache - contains the MediaAgent index of all the applications that belong to the FlexFrame pool.
      • db<sid> - contains the application-specific index cache information. Must be empty before installing the Commvault software.

        If you have several pools, add the Commvault client name to the directory name. Example, db<sid>_clientname.

      • <pool>-db<sid>-se - contains the application-specific index cache information.
    • job_results - contains the Commvault job results of all the applications that belong to the Flexframe pool.
      • db<sid> - contains the application-specific job results information. Must be empty before installing the Commvault software.

        If you have several pools, add the Commvault client name to the directory name. Example, db<sid>_clientname.

      • <pool>-db<sid>-se - contains the application-specific job results information.
    • scripts - contains the Commvault Pre/Post Process scripts for all the applications that belong to the Flexframe pool.
      • db<sid>- contains the application-specific Pre/Post Process scripts.
    • db2dirs – Required only if you plan to install the Commvault DB2 Agent. Contains the following directories that are created during the installation.
      • Db2Archive – contains the SID directory and sub structures that includes the Archive Log cache information.
      • Db2AuditError – contains the Audit error information.
      • Db2Retrieve – used for retrieval purposes.
    • config – contains the application-specific configuration and parameter files. Required only if you plan to install the Commvault SAP Agent for MaxDB or HANA.
  • commvault_ host_<pool>/<host> - contains the directories that have the Commvault software on the host. Mount this directory as /addon/commvault_host.
    • opt - contains the configuration details of the Commvault software on the host. Must be empty before installing the Commvault software.
    • local - contains the local binaries that are linked from the /usr/local/bin path. Example, db2ls binary for the DB2 Agent.
    • etc/CommVaultRegistry - contains Commvault configurations. Must be empty before installing the Commvault software.
    • etc/init.d- must contain an empty file named Galaxy before the installation. To create the file, use the command, Touch Galaxy.

    The binary (/opt) and the registry (/etc/CommVaultRegistry) directories cannot contain a symbolic link.

Note: To allow root access on the FlexFrame nodes, modify the FlexFrame default export option for these two parts of the addon volume from anon=0.

Naming Conventions

The following naming conventions are used in this document:

  • NetApp volume - volume on the Vserver. Example: fas04
  • client_name - The name of the host where you perform the operation. Example, vm014.
  • commvault_volume - the NetApp volume that you create. Example: fas04 node
  • commvault_pool - The FlexFrame pool that you use for the Commvault software. Example: p21
  • grp_id - The Commvault group id. Example: 4711
  • Controller node -The central node. Example: cn1

Before You Begin

Use the following NetApp command to create a volume:

volume create addon -vserver vserver_name -policy policy_name -l C.UTF-8 aggr2 -size volume_size -state online -unix-permissions ---rwxr-xr-x -type RW -junction-path /vol/addon

Where:

vserver_name: The name of the Vserver.

storage_policy_name: The FlexFrame policy.

volume_size: The size of the volume, such as 100GB.

Example

The following example creates a volume on the Vserver that is named svm1 that is 100GB and uses the fo_rw_CN_ro_all standard policy. In this example, the parameters are listed on the command line:

volume create addon -vserver svm1 -policy ffo_rw_CN_ro_all -l C.UTF-8 aggr2 -size 100GB -state online -unix-permissions ---rwxr-xr-x -type RW -junction-path /vol/addon

Procedure

  1. Have a FlexFrame professional modify the automount of the commvault pool by using the ff_custom_mnt_adm.pl script that is available in the Toolbox of FlexFrame Service DVD.
    1. Create the addon commvault_<pool> and qtrees commvault_host directories on the NetApp volume that you created. On the command line, enter the following command:

      # ff_custom_mnt_adm.pl --op add --pool pool_name --name addon --entry commvault_host --volume volume_name:/vol/addon/commvault_host --description "Host-specific part for commvault" --expandpath HOST

      Where:

      pool_name: The name of the FlexFrame pool.

      volume_name: The name of the NetApp volume that you created.

      Example

      The following example modifies the commvault pool that is called p21 that is on the fas04t node. In this example, the parameters are listed on the command line:

      :~ # ff_custom_mnt_adm.pl --op add --pool p21 --name addon --entry commvault_host --volume fas04:/vol/addon/commvault_host --description "Host-specific part for Commvault" --expandpath HOST

    2. Create the volume addon and the qtrees commvault_<pool>_<hostname> and commvault_<pool> and entries for them in the automounter.
  2. Prepare the directories and links on the volume. You must place the system in Maintenance Mode. On the command line, enter the following commands:

    Note: The /opt directory must be empty and must not contain a subdirectory that is called commvault. The directories that start with "db2" are only required in DB2 configurations. The /opt/commvault entry must be a dangling link.

    client_name:/ # rcautofs stop
    client_name:/ # mkdir /addon
    client_name:/ # rcautofs start
    client_name:/addon/commvault_host # mkdir -m 770 job_results IndexCache db2dirs scripts
    client_name:/addon/commvault_host # chgrp grp_id IndexCache
    client_name:/addon/commvault_host # chgrp grp_id job_results
    client_name:/addon/commvault_host # chgrp grp_id db2dirs
    client_name:/addon/commvault_host # chgrp grp_id scripts
    client_name:/ # ln -s /addon/commvault_host/etc/init.d/Galaxy /etc/init.d/Galaxy
    client_name:/ # ln -s /addon/commvault_host/etc/CommVaultRegistry /etc/CommVaultRegistry
    client_name:/ # ln -s /addon/commvault_host/opt/commvault /opt/commvault
    client_name:/ # chgrp -h commvault /etc/CommVaultRegistry
    client_name:/ # chgrp -h commvault /opt/commvault
    client_name:/ # cd /usr/bin
    client_name:/usr/bin # ln -s /opt/commvault/installer/detect detect
    client_name:/usr/bin # ln -s /opt/commvault/installer/support support
    client_name:/usr/bin # ln -s /opt/commvault/Base64/cvpkgchg cvpkgchg
    client_name:/usr/bin # ln -s /opt/commvault/Base64/cvpkgcheck cvpkgcheck
    client_name:/usr/bin # chgrp -h commvault cvpkgcheck cvpkgchg support detect
    client_name:/usr/bin # ls -l cvpkgcheck cvpkgchg support detect
    lrwxrwxrwx 1 root commvault 32 Jun 30 12:26 cvpkgcheck -> /opt/commvault/Base64/cvpkgcheck
    lrwxrwxrwx 1 root commvault 30 Jun 30 12:25 cvpkgchg -> /opt/commvault/Base64/cvpkgchg
    lrwxrwxrwx 1 root commvault 31 Jun 30 12:25 detect -> /opt/commvault/installer/detect
    lrwxrwxrwx 1 root commvault 32 Jun 30 12:25 support -> /opt/commvault/installer/support
    client_name:/ # ln -s /addon/commvault_host/local/db2ls /usr/local/bin/db2ls

    Where:

    • client_name: The name of the host where you perform the operation.
    • commvault_volume: the NetApp volume that you created.
    • commvault_pool: The FlexFrame pool that you use for the Commvault software.
    • grp_id: The Commvault group id.

    Example

    The following example is for host vm014 and the commvault pool is p21 on the fas04 node and the group id is 4711. In this example, the parameters are listed on the command line:

    vm014:/addon/fas04 # mkdir -m 770 job_results IndexCache db2dirs scripts
    vm014:/addon/fas04 # chgrp 4711 IndexCache
    vm014:/addon/fas04 # chgrp 4711 job_results
    vm014:/addon/fas04 # chgrp 4711 db2dirs
    vm014:/addon/fas04 # chgrp 4711 scripts
    vm014:/ # ln -s /addon/commvault_host/etc/init.d/Galaxy /etc/init.d/Galaxy
    vm014:/ # ln -s /addon/commvault_host/etc/CommVaultRegistry /etc/CommVaultRegistry
    vm014:/ # ln -s /addon/commvault_host/opt/commvault /opt/commvault
    vm014:/ # chgrp -h CommVault /etc/CommVaultRegistry
    vm014:/ # chgrp -h CommVault /opt/commvault
    vm014:/ # cd /usr/bin
    vm014:/usr/bin # ln -s /opt/commvault/installer/detect detect
    vm014:/usr/bin # ln -s /opt/commvault/installer/support support
    vm014:/usr/bin # ln -s /opt/commvault/Base64/cvpkgchg cvpkgchg
    vm014:/usr/bin # ln -s /opt/commvault/Base64/cvpkgcheck cvpkgcheck
    vm014:/usr/bin # chgrp -h CommVault cvpkgcheck cvpkgchg support detect
    vm014:/usr/bin # ls -l cvpkgcheck cvpkgchg support detect
    lrwxrwxrwx 1 root CommVault 32 Jun 30 12:26 cvpkgcheck -> /opt/commvault/Base64/cvpkgcheck
    lrwxrwxrwx 1 root CommVault 30 Jun 30 12:25 cvpkgchg -> /opt/commvault/Base64/cvpkgchg
    lrwxrwxrwx 1 root CommVault 31 Jun 30 12:25 detect -> /opt/commvault/installer/detect
    lrwxrwxrwx 1 root CommVault 32 Jun 30 12:25 support -> /opt/commvault/installer/support
    vm014:/ # ln -s /addon/commvault_host/local/db2ls /usr/local/bin/db2ls

  3. Best Practice: If you use the Commvault Oracle Agent or SAP for Oracle Agent, then modify the Commvault log files directory. On the command line, enter the following command:

    # chmod g+s /var/log/commvault/Log_Files

  4. On the central node, create and adapt the file system structure for each Application node belonging to the pool <pool>. On the command line, enter the following commands:

    cn1:/FlexFrame/commvault_volume/addon/commvault_host # mkdir -p commvalut_host/etc/init.d
    cn1:/FlexFrame/commvault_volume/addon/commvault_host # mkdir –m 775 -p vm014/etc/CommVaultRegistry
    cn1:/FlexFrame/commvault_volume/addon/commvault_host # mkdir –m 770 -p vm014/opt

    cn1:/FlexFrame/commvault_volume/addon/commvault_host # chgrp grp_id vm014/etc/CommVaultRegistry
    cn1:/FlexFrame/commvault_volume/addon/commvault_host # chgrp grp_id vm014/opt

    cn1:/FlexFrame/commvault_volume/addon/commvault_host # touch client_name/etc/init.d/Galaxy

    cn1:/FlexFrame/commvault_volume/addon/commvault_host # mkdir –m 770 job_results IndexCache
    cn1:/FlexFrame/commvault_volume/addon/commvault_host # chgrp 4711 job_results
    cn1:/FlexFrame/commvault_volume/addon/commvault_host # chgrp 4711 IndexCache

    Where:

    • client_name: The name of the host where you perform the operation.
    • commvault_volume: the NetApp volume that you created.
    • commvault_pool: The FlexFrame pool that you use for the Commvault software.
    • grp_id: The Commvault group id.

    Example

    The following example is for host vm014 and the Commvault pool is p21 and the fas04 node and the group id is 4711. In this example, the parameters are listed on the command line:

    cn1:/FlexFrame/fas04/addon/commvault_host # mkdir -p vm014/etc/init.d
    cn1:/FlexFrame/fas04/addon/commvault_host # mkdir –m 775 -p vm014/etc/CommVaultRegistry
    cn1:/FlexFrame/fas04/addon/commvault_host # mkdir –m 770 -p vm014/opt

    cn1:/FlexFrame/fas04/addon/commvault_host # chgrp 4711 vm014/etc/CommVaultRegistry
    cn1:/FlexFrame/fas04/addon/commvault_host # chgrp 4711 vm014/opt

    cn1:/FlexFrame/fas04/addon/commvault_host # touch vm014/etc/init.d/Galaxy

    cn1:/FlexFrame/fas04/addon/commvault_host # mkdir –m 770 job_results IndexCache
    cn1:/FlexFrame/fas04/addon/commvault_host # chgrp 4711 job_results
    cn1:/FlexFrame/fas04/addon/commvault_host # chgrp 4711 IndexCache

    The symbolic links are created and made available when the system comes out of the maintenance mode.

  5. Create additional links to enable the automatic start of the Commvault software when the system boots.

    To resolve the dangling links, on the control node, run the insserv command and use the ff_new_an.custom script that is available in the Toolbox of FlexFrame Service DVD

    cn1:~ # vi /FlexFrame/volFF/os/Linux/<OSIMAGE>/ff_new_an.custom
    []
    # Enable Galaxy-Service for Commvault
    ln -s ../Galaxy $ROOT_IMG/etc/init.d/rc3.d/K01Galaxy
    ln -s ../Galaxy $ROOT_IMG/etc/init.d/rc5.d/K01Galaxy

    where, KO1Galaxy is the SID ID.

  6. Bring the system out of the Maintenance Mode.

What to Do Next

Boot the Application Node and verify that the following conditions are met:

  • /opt/commvault is a dangling link
  • /etc/init.d/Galaxy is not a dangling link
  • The job_results directory and the IndexCache directory of the pool-specific director (/addon/commvault_pool belong to the CommVault group and have 770 permissions.
  • If you use the DB2 database application, then you must have the /var/db2 directory with permissions 777.
  • If you use the SAP HANA database application, then you need to create an empty directory that is called /tmp/hanaexe.
  • If you use the SAP Oracle database application, then you need to create the /tmp/sapexe directory with 777 permissions.

Last modified: 9/24/2019 6:37:05 PM