Convoy Automatic Stock

Your Convoy package stock always matches the capacity actually free on your nodes, so you never oversell and never leave sellable capacity hidden.

What it does

Selling servers off a fixed package quantity means either overselling past what your nodes can actually hold, or leaving real capacity unsold because nobody remembered to raise the number. Convoy Automatic Stock recalculates package stock itself, every few minutes, straight from the free memory and disk your Convoy nodes are actually reporting. The moment a node fills up, the storefront stops selling that package; the moment a client cancels and frees up room, it starts selling again - with no one editing a quantity by hand.

Key features

• Stock That Keeps Itself Accurate: Package quantities are recalculated on a schedule from the capacity your Convoy nodes actually have free, so nobody has to remember to edit a quantity again.
• Counts Both Memory and Disk: Free memory and free disk are both checked, and whichever runs out first decides the number, so a package is never listed as in stock on the strength of only one dimension.
• Hold Capacity Back in Reserve: Keep a fixed number of slots, or a percentage of the calculated stock, unsold as headroom for migrations, growth and support cases.
• Cap the Advertised Stock: Set a maximum quantity so a large node fleet never advertises an implausible number of units.
• Choose Which Packages Are Managed: Restrict automatic stocking to the packages you pick, leaving hand-managed or promotional packages exactly as you set them.
• Preview Before You Commit: Dry-run mode computes and reports a run without writing anything, so a new configuration can be checked before it goes live.
• Detailed Last Run Report: The settings screen shows the last run's time, trigger, duration and updated/skipped/failed counts, with a per-package and per-node breakdown.
• Email Alerts When a Run Fails: Get an email whenever a run hits an error such as an unreachable panel or a rotated token.
• A Panel Outage Never Zeroes Your Stock: If the panel does not answer, or a package has no limit to constrain it, the existing quantity is left exactly as it is instead of being written down to zero.
• Update Stock On Demand: A Save And Update Stock button runs the whole calculation immediately, even while automatic updating is switched off.

Enhance your Convoy stock management with Convoy Automatic Stock by Blesta.Club.

Installing Convoy Automatic Stock

Before you start

• If you are on the leased (subscription) licence, the Blesta Club Subscription Manager must be installed and your subscription active. The owned and owned-source licences have no such requirement.
• You need Blesta's own Convoy module already installed and configured with at least one node - this plugin restocks packages that module already provisions, it does not connect to Convoy on its own.

1. Upload the files

Upload the extension folder into your Blesta installation so it lands under your Blesta directory at:

plugins/convoy_automatic_stock/

For example, on a typical install: /var/www/html/blesta/plugins/convoy_automatic_stock/

2. Install it in Blesta

1. Log in to your Blesta admin area with a staff account that has access to Settings > Company > Plugins.
2. Go to Settings > Company > Plugins and click the Available tab.
3. Find Convoy Automatic Stock in the list and click Install.

3. Configure it

1. Click Manage next to Convoy Automatic Stock on the Plugins page.
2. Select the Convoy module you want to stock from. A demo mode is available (tick Mock API) if you want to see a report before pointing it at a real panel.
3. Optionally set a Managed Packages list, a stock reserve, a maximum stock cap, dry-run mode, and an email address to notify on failure - all covered in the usage guide.
4. Tick Enabled and save. A cron task is registered automatically and runs every 5 minutes from then on - no separate setup is needed for it.

You're ready to go - see the usage guide for a walkthrough of day-to-day use.

Updating Convoy Automatic Stock

Upgrading works just like installing: upload the new files over the old ones, then run the upgrade from the same page you installed it on.

1. Back up your current extension files first - good practice before any upgrade.
2. Upload the new version over the existing folder, replacing the old files.
3. Log in to your Blesta admin area and go to Settings > Company > Plugins.
4. Find Convoy Automatic Stock and click Update to run the upgrade.

Version-specific notes

• v1.1.0: Fixes several stability issues in the stock calculation and adds a fixture-backed mock mode for testing; no settings are added and nothing needs reconfiguring.
• v2.0.0: Adds disk as a second stock dimension, a Last Stock Run report panel, a managed-package selector, a stock reserve and maximum-stock cap, a dry-run mode, and optional email notification on failure. Your existing settings carry over unchanged - the new options default to off (every package managed, no reserve, no cap, dry run off, notifications off) until you choose to turn them on.

Using Convoy Automatic Stock

For your staff

The settings screen (Settings > Company > Plugins > Manage)

Everything lives on one screen:

• Enabled: Turns the automatic cron-driven updates on or off. The settings can still be saved, and a manual run performed, while this is unticked.
• Convoy Module: The installed Convoy module to stock from. Choose Disabled to leave the plugin configured but inactive.
• Mock API: Runs against bundled sample data instead of your real panel - useful for seeing what a run and its report look like before you have live nodes to point at. A run made with this ticked never writes a package quantity.
• Managed Packages: Restrict automatic stocking to the packages you pick here. Leave nothing selected to manage every package on the chosen module.
• Stock Reserve: Hold back a fixed number of units, or a percentage of the calculated stock, so the advertised quantity always sits a little below what the nodes could technically fit.
• Maximum Stock: Cap the highest quantity a package will ever advertise. Leave it at 0 for no cap.
• Dry Run: Compute and report a run without writing any package quantities, so you can preview the effect of a settings change before it goes live.
• Notify On Failure / Notification Email: When ticked, an email is sent to the address you enter whenever a run reports an error, such as an unreachable panel.

Click Save to store your settings, or Save And Update Stock to save and immediately run the calculation - this works even while Enabled is unticked, so you can preview a run before switching automatic updates on.

Reading the Last Stock Run report

After any run - scheduled or manual - the same screen shows a report below the settings form: the run's time, what triggered it, how long it took, and how many packages were updated, skipped or failed. Each package lists its previous and newly calculated stock and which constraint (memory or disk) decided the number, and each node lists its capacity, allocated and free figures and whether it answered. A run made with Mock API or Dry Run is labelled as such, and a package left unchanged because nothing could be measured is reported as skipped rather than silently zeroed.

Good to know

• Stock is only ever written when something was actually measured - an unreachable panel, a package whose nodes no longer exist, or an unlimited package all leave the existing quantity untouched rather than writing it down to zero.
• A package's stock is whichever of memory or disk runs out first; both are checked on every run.
• Mock API and Dry Run are independent switches - either one on its own is enough to stop a run from writing anything.