• v5.0
    • Versions
    • master

 

  • Install Akeneo PIM
    • Install Akeneo PIM for development with Docker
    • Install Akeneo PIM manually
      • System Requirements
      • System installation on Debian 10 (Buster)
      • System installation on Ubuntu 18.04 (Bionic Beaver)
      • System installation on Ubuntu 20.04 (Focal Fossa)
      • Installing Akeneo PIM Community Edition (CE)
      • Installing Akeneo PIM Enterprise Edition (EE) with the Archive
      • Setting up the job queue daemon
      • Setting up the Events API
    • How to customize the Dataset
    • How to Add Translation Packs
  • Upgrade Akeneo PIM projects
    • How to apply a patch?
      • How to apply a patch - Community Edition
      • How to apply a patch - Enterprise Edition - Flexibility Cloud offer
      • How to apply a patch - Enterprise Edition - On Premise offer
    • Where is the Changelog?
    • How to upgrade to a minor version?
    • How to upgrade to a major version?
      • Upgrade from 3.2 to 4.0
      • Upgrade from 4.0 to 5.0
  • Import and Export data
    • How import works
    • Understanding the Product Import
    • Understanding the Product Export
    • Formats
      • Localized labels
      • Scopable labels
      • Association types data structure
      • Attribute data structure
      • Category data structure
      • Family data structure
      • Family variant data structure
      • Group data structure
      • Options data structure
      • Product data structure
      • Product model data structure
    • Akeneo Connectors
    • How to Customize Import / Export
      • How to create a new Connector
      • How to import Products from a XML file
      • How to clean a CSV file during a Product import
      • How to automate imports/exports
  • Manipulate the Akeneo PIM data
    • How to Customize Mass Edit Operations
      • How to register a new bulk action
      • How to Register a New Mass Edit Action on Products
    • How to Manipulate Products
      • How to Query Products
      • How to Create Products
      • How to Update Products
      • How to Validate Products
      • How to Save Products
      • How to Remove Products
    • How to Manipulate Non-Product Objects
      • How to Query Non-Product Objects
      • How to Create Non-Product Objects
      • How to Update Non-Product Objects
      • How to Validate Non-Product Objects
      • How to Save Non-Product Objects
      • How to Remove Non-Product Objects
    • How to add a custom action rule
      • General information about rule format
      • How to add a custom action in the rule engine
    • How to Define Access Control List
    • How to Customize the Catalog Structure
      • How to Create a Reference Data
    • How To Customize Teamwork Assistant (Enterprise Edition)
      • Customize notifications
      • Add a calculation step
      • How to log calculation step
      • Remove projects impacted by a custom catalog update
    • How to store assets externally
    • How to Configure Measurement Limits
  • Maintain Akeneo PIM projects
    • First aid kit
    • Bug qualification
    • Common issues
    • Scalability Guide
      • Audit with 3 Representative Catalogs
      • More than 10k attributes?
      • More than 10k families?
      • More than 10k categories?
      • More than 500 attributes usable in the product grids?
      • More than 100k products to export?
      • More than 1GB of product media to export?
    • How to purge history
      • How to Purge jobs executions
      • How to adapt the version purger to your needs
  • Contribute to Akeneo PIM
    • How to report an issue?
    • How to translate the user interface?
    • How to enhance the documentation?
    • How to contribute to a Connector?
    • How to submit a patch to the PIM?
    • How to contribute to the frontend part of the application
    • How behavior tests are architectured in the PIM?
      • Establishing Decorator Pattern
      • Using Spin In Behat
  • Use SSO authentication locally
  • Reference Entities
    • Configure Entity Limits
    • Create a new Reference Entity Attribute type
    • Enrich Records with a new Reference Entity Attribute type
    • Add a Custom Property to Your Custom Attribute Type
    • Refresh records completeness
  • Troubleshooting guide
  • Technical overview
    • Product Information
    • Teamwork Assistant (Enterprise Edition)
      • Project creation
      • Project completeness
      • Project Completeness widget
      • Catalog update impact
      • Scalability guide
      • Users permission summary for Behat tests
    • Collaborative workflow
      • Simple workflow
      • Partial workflow
  • Technical architecture
    • Best Practices
      • Create a project
      • Create a reusable bundle
      • Code Conventions
      • Coding Standards
    • How to implement your business logic using the event system
    • Events
      • Storage events
      • Workflow events (Enterprise Edition only)
    • How to Localize your data
      • How to change the PIM locale
      • How to Use Localizers
      • How to use Presenters
    • How to Add a Notification
    • Performances Guide
      • Memory usage of rules execution (Enterprise Edition)
      • Memory leak fix in Rules Engine (ORM)
      • More than 100 WYSIWYG editors in a page
      • PHP7 and HHVM Compatibility?
      • Job product batch size
    • How to Use the Web REST API
    • Standard format
      • Products
      • Other entities
      • Usage
    • Application Technical Information
      • Application Technical Dependencies
      • Server side set up for hosting
      • System Requirements
      • Recommended configuration
      • Client side configuration and compatibilities
      • Operation processes
      • Flow Matrix
  • Akeneo Cloud Edition
    • Flexibility
      • Environment accesses
      • System Administration & Services Management
      • Periodic tasks & Crontab configuration
      • Composer settings
      • Queue Management & Workers
      • Disk Usage Management
    • Serenity
  • Akeneo Onboarder
    • Prerequisites
    • How to install the Onboarder bundle
    • Synchronization
    • How to update a minor version or to apply a patch
      • How to update the Onboarder bundle - Enterprise Edition - Flexibility Cloud offer
      • How to update the Onboarder bundle - Enterprise Edition - On Premise offer
    • How to upgrade to a major version
    • Troubleshooting
    • How to uninstall the Onboarder bundle
    • Environment variables
      • Using the DotEnv file
      • Using environment variables

Disk Usage Management¶

A disk is dedicated to a single instance. As a consequence, a disk cannot be shared between production and sandbox instances.

Usages Impacting Disk Usage¶

The disk usage will increase following the lifecycle of the instance. For example, each time:

  • a new product / family / … is created

    • entries are created in database

  • a product / family / … is modified

    • previous version is stored in versioning table

    • by default, old versions are kept forever (as of v3.2.7)

  • an asset is uploaded

    • it is stored on the file system

    • if the asset is replaced with a new one, the old version stays on disk

  • an import / export runs

    • it creates an archive

    • by default, those archives are retained during 180 days

  • a file is uploaded using SFTP / scp / …

Impact of Disk Usage on the PIM¶

When the disk is full, the PIM cannot work anymore: it cannot save modifications in database, upload new assets, …

It can even prevent ElasticSearch from updating its indexes, resulting in desynchronization with the database. To avoid those issues, ensuring a healthy disk usage is necessary.

Check Disk Space Usage¶

The following command can help you to check the disk space usage expressed both in GB and as a percentage:

echo "Report disk space usage for my instance"
df -h /data
  Filesystem      Size  Used Avail Use% Mounted on
  /dev/sdb        344G  133G  196G  41% /data

As explained in the previous paragraph, the disk mounted on “/data” must not be full.

Please notice that size difference between df command and your purchased disk space is caused by the metadata storage usage.

Investigate Disk Space Usage Issues¶

Improving Disk Usage¶

To reduce disk usage, some temporary files are deleted automatically on a regular basis. For example:

  • old temporary import/export files

  • old temporary file storage

  • akeneo_batch directories

  • ansible temporary directories

Moreover, the integrator can:

  • activate the purge of old versions of products

  • remove assets that are not linked to any product anymore

Investigate Disk Usage Distribution¶

The following command can help you to identify potential issues regarding the disk usage of your instance, by listing the largest directories:

echo "Report the 20 largest directories"
du -hx /home/akeneo/*/ | sort -rh | head -20

Database purges¶

Assets¶

echo "Remove all orphan files not linked to any assets"
php bin/console akeneo:asset-manager:purge-orphans-file-info

This command will not remove thumbnails generated for preview, if you also want to delete those file:

php bin/console akeneo:asset-manager:thumbnail-cache:clear --all

Warning

The thumbnails will be regenerated on the first display in the PIM

Versioning¶

echo "Cleaning versions older than 90 days. Please note that this is executed every Sunday by default"
nohup php bin/console pim:versioning:purge --more-than-days 90 --force -n &

Daily purge of versioning will ensure that the versioning table size does not grow indefinitely.

If the table has grown too much, running the purge won’t return the physical space on the disk as it only frees space in the table. In that case, use the following procedure to free the associated disk space:

screen # create a dedicated session you can reconnect to if the connection is lost

mkdir -p /home/akeneo/purge
cd /home/akeneo/purge

mysqldump akeneo_pim pim_versioning_version --add-drop-table |
gzip -9 > pim_versioning_version.sql.gz

gunzip < pim_versioning_version.sql.gz | mysql

# if the connection is lost in the process, re-connect using SSH and run
screen -r

Moreover, the customer and the integrator can:

  • open a ticket to ask the Cloud Team to set the duration of retention of archives of import / export

  • contact the Customer Success Manager to upscale the disk

Configure the PIM to save disk space¶

  • For product exports, you can disable files and media export (Export Profile > Edit > Global Settings)

  • Files generated for exports are archived and can increase disk usage rapidly if executed too many times without a purge.


Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!