Feature: Additional Allocations #2

snags141 · 2022-01-04T16:47:14Z

Changed:

Modified the server creation logic (wisp_CreateAccount) to check if the additional allocations field has been set. If it has, fetches all allocations from each applicable node.
Updated Readme instructions, in particular the FAQ section regarding additional allocations and the API permissions image to include read access to allocations.

Added:

Comments to code to help improve readability for someone picking it up for the first time
Log messages that are optionally turned on in your WHMCS settings. This should help troubleshoot issues when starting to use this module.
additional_ports parameter (optional) -> Allows specifying additional allocations based on an offset of the first available allocation. Allocation assignment logic explained below
additional_port_fail_mode (optional) -> Specifies what action the module should take if it fails to find nodes with allocations available (e.g. allocations are either full or so full and fragmented such that it can't facilitate the required offsets). Continue = Create the server anyways, but only with one allocation, whatever is available. Stop = Raise an exception and stop the server from being created.

Allocation Assignment Logic

(Assuming the optional additional allocations parameter has been set, otherwise continues as normal)

Pull a list of nodes based on the location ID
For each node, pull all allocations
Filter available allocations into an array of ports by each IP address
Check for a port that matches base port and base port+ [each additional allocation offset]
If found available allocations that meet requirements, return and create the server as normal (If any environment parameters are mapped to an allocation like RCON_PORT we assign those before creating the server)
If not, continue based on fail mode

Other Notes

The only minor thing to be aware of is the logic I've implemented pays no attention to the optional field "port_range".
If "additional_ports" is set, it'll just find any ports available that meet your requirements, ignoring any specified port range in the "port_range" parameter.
It's possible to change this in future, but I didn't see this as being an issue and using both parameters together seems to be a rare use-case.

More than happy to hear any feedback or suggestions to improve this before merge 👍
Cheers all!

… screenshot and cleaned up code

…nor readme update.

snags141 · 2022-01-04T17:53:39Z

One thing for me to change before merge, based on feedback from kubi: change activity log calls to module log

snags141 · 2022-01-05T03:31:15Z

Temporarily converted to draft while I add support to use the additional allocations in the startup string parameter.

…Added support for setting environment parameters

Feature: Assign allocations to environment variables

Updated the description for additional_ports config option

snags141 · 2022-01-05T15:24:35Z

New commits added:
✅ Action Kubi feedback: Convert logActivity functions to logModuleCall.
✅ Add support to assign "auto allocation" ports to egg variables such as RCON_PORT.
This Required changing the additional_ports field in whmcs to expect a json string. Readme has been updated explaining how to use.

TrixterTheTux

Thanks for the PR! From a quick glance, I'd recommend the following changes. I'll try to play around with this locally during the next week.

README.md

wisp/wisp.php

… regarding allocations

…backwards compatibility

snags141 · 2022-01-05T17:28:55Z

Thanks for the review Trixter - I've gone through and fixed the issues you mentioned, happy to make any further changes as necessary. Look forward to hearing back whenever you or the team get a chance to play around with it 👍
Cheers!

IIPoliII · 2022-04-06T19:58:32Z

Will this be merged?

HerrSammyDE · 2022-09-18T07:41:28Z

Update?

krenny

All the bugs I found at snags141#6

krenny · 2022-09-20T10:11:22Z

wisp/wisp.php

+        Fetches and returns all nodes with a specific location_id
+    */
+    $filteredNodes = Array();
+    $nodes = wisp_API($params, 'nodes/');


The nodes/ endpoint should be changed to nodes since wispv2 returns an error when using nodes/

krenny · 2022-09-20T10:13:21Z

README.md

+| ------------ | ------------ | ------------ | ------------ |
+| Rust | Game port and RCON port | `{1:"RCON_PORT"}`  | Game Port: 1000, RCON_PORT: 1001|
+| Arma 3 | Game port, Game port +1 for Steam Query, Game port + 2 for Steam Port, and Game port +4 for BattleEye |  `{1:"NONE", 2:"NONE", 4:"NONE"}` | Game Port: 1000, Additional Ports: 1001, 1002, 1004 |
+| Unturned | Game port, Game port +1 and Game port +2 | `{1:"NONE", 2:"NONE"}` | Game Port: 1000, Additional Ports: 1001, 1002 |
+| Project Zomboid | Game Port, Steam port and an additional port for every player. Let's say we want 10 additional ports for 10 players. | `{1:"STEAM_PORT", 2:"NONE", 3:"NONE", 4:"NONE", 5:"NONE", 6:"NONE", 7:"NONE", 8:"NONE", 9:"NONE", 10:"NONE", 11:"NONE"}` | Game Port: 1000, Steam Port: 1001, Additional Ports: 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011|
+
+**What does "NONE" mean?**
+"NONE" means you want to assign the additional port to the server, but it doesn't need to be assigned to a server parameter. If instead you want to add a +1 port and assign it to the parameter "RCON_PORT" then you'd use `{1:"RCON_PORT"}` for example.


That json isn't valid.

keys should be strings
for example:
{"1":"RCON_PORT"}

krenny · 2022-09-20T10:15:07Z

README.md

+
+(If they're available)
+
+Note: I this option is set, it will override anything specified under "port_range" - Use one or the other, not both.


krenny · 2022-09-20T10:18:42Z

README.md

+
+(If they're available)
+
+Note: I this option is set, it will override anything specified under "port_range" - Use one or the other, not both.


It will not only override port_range but also every under deploy.
That should be dedicated IP, location and port_range

krenny · 2022-09-20T10:19:43Z

wisp/wisp.php

+            $main_allocation_id = $portDetails['id'];
+            $main_allocation_port = $port;
+            $found_all = true;
+            foreach($port_offsets_array as $key => $port_offset) {


Foreach key and value are swapped
There the key (which you use as port offset) is used as parameter name and the value (which you use as parameter name) is used as port offset.

krenny · 2022-09-20T10:21:49Z

wisp/wisp.php

+        // Failed to find available set of ports based on requirements
+        logModuleCall("WISP-WHMCS", "Failed to find available ports!", "", "");
+        return false;


that shouldn't be in the for loop

mason-rogers · 2025-01-11T23:40:23Z

Thank you so much for laying the foundation for this - I've made a new PR within wisp-gg/whmcs which carries on your work, since I can't edit your repo/pr obviously.

Closing in favour of #8

snags141 and others added 11 commits December 9, 2021 15:51

Added the base code multi-port allocations.

36d9832

Updated readme FAQ for multiple port allocations

8109275

Added the patch call to add additional allocations

d2faa67

Fixed missing ; and added additional call to get server ID

07b08a8

Mostly finished general implementation and tested in dev

4663e7a

Updated to new method - assigns additional allocs at server create

8632739

Updated readme FAQ section for multi-allocations, updated permissions…

490b7cb

… screenshot and cleaned up code

Removed unecessary log and comments

fd5f942

Final readme update

fd8447b

Fixed a logic issue when multiple nodes are present at a location. Mi…

f5622b0

…nor readme update.

Minor wording change to reduce confusion

e5bb7b4

mason-rogers requested a review from TrixterTheTux January 5, 2022 01:04

snags141 marked this pull request as draft January 5, 2022 03:29

snags141 and others added 6 commits January 5, 2022 11:33

initial

98cde61

changed logActivity calls to module log and added port array

f98eec8

Updated logic to use new json method of additional port assignments. …

21e4c52

…Added support for setting environment parameters

Merge pull request #2 from snags141/feature/allocationsInStartParams

16a79b3

Feature: Assign allocations to environment variables

Updated the description for additional_ports config option

e167824

Merge pull request #3 from snags141/feature/allocationsInStartParams

45e32d6

Updated the description for additional_ports config option

snags141 marked this pull request as ready for review January 5, 2022 15:24

TrixterTheTux suggested changes Jan 5, 2022

View reviewed changes

snags141 added 4 commits January 6, 2022 01:00

Updated json format and added links to readme in whmcs config options…

1a42e04

… regarding allocations

Moved new whmcs config options to the bottom of the list to maintain …

7750750

…backwards compatibility

Removed two duplicate lines of API error handling

e039d02

Removed redundant test from getNodes()

ef75fb2

Updated readme with new json format.

58bdf25

krenny suggested changes Sep 20, 2022

View reviewed changes

mason-rogers closed this Jan 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Additional Allocations #2

Feature: Additional Allocations #2

snags141 commented Jan 4, 2022 •

edited

Loading

snags141 commented Jan 4, 2022

snags141 commented Jan 5, 2022

snags141 commented Jan 5, 2022

TrixterTheTux left a comment

snags141 commented Jan 5, 2022

IIPoliII commented Apr 6, 2022

HerrSammyDE commented Sep 18, 2022

krenny left a comment

krenny Sep 20, 2022

krenny Sep 20, 2022 •

edited

Loading

krenny Sep 20, 2022

krenny Sep 20, 2022

krenny Sep 20, 2022

krenny Sep 20, 2022

mason-rogers commented Jan 11, 2025


		(If they're available)

		Note: I this option is set, it will override anything specified under "port_range" - Use one or the other, not both.

Feature: Additional Allocations #2

Feature: Additional Allocations #2

Conversation

snags141 commented Jan 4, 2022 • edited Loading

Changed:

Added:

Allocation Assignment Logic

Other Notes

snags141 commented Jan 4, 2022

snags141 commented Jan 5, 2022

snags141 commented Jan 5, 2022

TrixterTheTux left a comment

Choose a reason for hiding this comment

snags141 commented Jan 5, 2022

IIPoliII commented Apr 6, 2022

HerrSammyDE commented Sep 18, 2022

krenny left a comment

Choose a reason for hiding this comment

krenny Sep 20, 2022

Choose a reason for hiding this comment

krenny Sep 20, 2022 • edited Loading

Choose a reason for hiding this comment

krenny Sep 20, 2022

Choose a reason for hiding this comment

krenny Sep 20, 2022

Choose a reason for hiding this comment

krenny Sep 20, 2022

Choose a reason for hiding this comment

krenny Sep 20, 2022

Choose a reason for hiding this comment

mason-rogers commented Jan 11, 2025

snags141 commented Jan 4, 2022 •

edited

Loading

krenny Sep 20, 2022 •

edited

Loading