WHMCS module upgrades

Upgrade paths for integrations/whmcs server and addon modules alongside GameCloud API releases.

Version compatibility

Check release notes for minimum pairs:

GameCloud API	Server module	Addon module
1.0.x	1.0.x	1.0.x
1.1.x	1.1.x	1.1.0+ (SQL migrations)

Module metadata declares APIVersion in hexagamecloud_MetaData().

Upgrade order

GameCloud API — deploy new control plane (upgrades)
Database migrations — addon SQL in modules/addons/hexagamecloud/sql/upgrade-*.sql
WHMCS addon module — copy files, run upgrade hook
WHMCS server module — copy files (usually no DB change)
Verify — dashboard health, test suspend/unsuspend

Never upgrade WHMCS modules before the API when release notes specify API-first ordering.

Addon SQL migrations

WHMCS runs hexagamecloud_upgrade() on version bump. Manual apply if needed:

mysql whmcs < integrations/whmcs/modules/addons/hexagamecloud/sql/upgrade-1.1.0.sql

Back up WHMCS database before upgrade.

File deployment

# From packaging script output or git
cp -r integrations/whmcs/modules/addons/hexagamecloud /path/to/whmcs/modules/addons/
cp -r integrations/whmcs/modules/servers/hexagamecloud /path/to/whmcs/modules/servers/
cp integrations/whmcs/hooks/hexagamecloud.php /path/to/whmcs/includes/hooks/

Clear WHMCS template cache if admin UI looks stale.

Zero-downtime considerations

Running game servers unaffected by module file update
Brief API restart during GameCloud upgrade may delay WHMCS module calls — retry logic in ApiClient.php handles transient 502
Place WHMCS in maintenance mode only if API breaking change requires it

Rollback

Restore previous module files from backup
Roll back GameCloud images if API incompatible
Restore WHMCS DB if SQL migration ran

Product mappings table is forward-compatible unless release notes say otherwise.

Packaging

cd integrations/whmcs/packaging
./build-package.sh

Distribute ZIP to production WHMCS via change-controlled deploy.

2.3 KiB Raw Permalink Blame History