LATEST VERSION: 1.3.4 - RELEASE NOTES
File Integrity Monitoring Add-on for PCF v1.3.4

Updating FIM Add-on for PCF to Run with Xenial Stemcells

Page last updated:

Pivotal Cloud Foundry (PCF) products and tiles that are released after July 2018 require Ubuntu Xenial stemcells instead of Ubuntu Trusty stemcells. You might have to modify your File Integrity Monitoring Add-on for PCF (FIM Add-on) deployment if you use PCF products running on Xenial.

This topic describes how to determine if your existing deployment of FIM Add-on can monitor VMs that run on Xenial.

This topic also explains how to update your FIM Add-on if it does not support Xenial.

Follow the instructions on this page if you use FIM Add-on with any PCF products or tiles that use Xenial stemcells. See Product Tiles that Use Xenial Stemcells below.

Do I Need to Modify the FIM Add-on?

FIM Add-on v1.2.22 and later can run correctly on Xenial-based VMs if the FIM runtime config includes the ubuntu-xenial property.

Review the following table and make any required changes before you upgrade to Xenial stemcells.

If you are using this version of the FIM Add-on… do the following…
1.2.23+ Verify that your runtime config file, fim.yml, includes:
  - name: fim-trusty
    include:
      stemcell:
      - os: ubuntu-trusty

  - name: fim-xenial
    include:
      stemcell:
      - os: ubuntu-xenial
If the fim.yml file does not include the above, then follow the steps in Add the Xenial Stemcell Property to the FIM Add-on below.
v1.2.22 Follow the steps in Add the Xenial Stemcell Property to the FIM Add-on below.
v1.2.17 or earlier Install FIM Add-on v1.2.23 or later. For instructions, see Installing the FIM Add-on for PCF.

If you use FIM Add-on without adding the ubuntu-xenial property to the runtime config, the VMs running on Xenial are not being monitored for file integrity.

If you add the ubuntu-xenial property but do not upgrade the FIM Add-on to v1.2.22 or later, then the FIM processes use excessive CPU.

Product Tiles that Use Xenial Stemcells

Ensure that you have added the ubuntu-xenial property to the FIM runtime config before you install any product tiles that use Xenial stemcells.

For a list of PCF tile releases that now use Xenial, see Tiles Using Xenial Stemcells in PCF.

Add the Xenial Stemcell Property to the FIM Add-on

If you use FIM Add-on v1.2.22 or v1.2.23 without the stemcell property in the fim.yml, then you must add the stemcell properties to your existing fim.yml and redeploy. Follow these steps:

  1. SSH in to the Ops Manager VM. For how to do this, see SSH into Ops Manager.

  2. To retrieve and save FIM add-on runtime config, run the following command:

    bosh -e BOSH-ENVIRONMENT runtime-config –name fim > /tmp/fim.yml
    

    Where BOSH-ENVIRONMENT is the alias you set for the BOSH Director.

    For example:

    $ bosh -e my-env runtime-config –name fim > /tmp/fim.yml 
  3. Edit the fim.yml file:

    addons:
    - name: fim-trusty
      jobs:
      - name: fim
        release: fim
        properties: {}
      include:
        stemcell:
        - os: ubuntu-trusty
    - name: fim-xenial
      jobs:
      - name: fim
        release: fim
        properties:
          fim:
            dirs:
              # System binaries and configuration
              - /bin
              - /etc
              - /lib
              - /lib32
              - /lib64
              - /opt
              - /sbin
              - /srv
              - /usr
              - /var/lib
    
              # Bosh agent
              - /var/vcap/bosh
              - /var/vcap/monit/job
    
              # Bosh releases
              - /var/vcap/data/packages
              - /var/vcap/data/jobs
      include:
        stemcell:
        - os: ubuntu-xenial
    

    Note: If you customized your Trusty VMs configuration, you need to manually add the /lib32 directory to your fim.yml file.

  4. To update the runtime config, run the following command:

    bosh -e BOSH-ENVIRONMENT update-runtime-config --name=fim /tmp/fim.yml
    

    For example:

    bosh -e my-env update-runtime-config --name=fim /tmp/fim.yml
  5. Navigate to the Installation Dashboard in Ops Manager.

  6. If you are using Ops Manager v2.3 or later, click Review Pending Changes. For more information about this Ops Manager page, see Reviewing Pending Product Changes.

  7. Click Apply Changes.

Create a pull request or raise an issue on the source for this page in GitHub