Pool Object¶
The Pool Object defines the configuration parts of the pool for non-emphemeral usage.
The Pool contains a PoolTransitionActions data structure for when a machine
- ENTER - EnterActions
- ALLOCATE - AllocateActions
- RELEASE - Release Actions
- EXIT - ExitActions
The PoolTransitionActions has the fields:
- Workflow - string - Workflow defines the new workflow the machine should run
- AddProfiles - list of strings - AddProfiles defines a list of profiles to add to the machine
- AddParameters - object of key/value pairs - AddParameters defines a list of parameters to add to the machine
- RemoveProfiles - list of strings - RemoveProfiles defines a list of profiles to remove from the machine
- RemoveParameters - list of strings - RemoveParameters defines a list of parameters to remove from the machine
The Pool also allows for definition of the parent pool for releasing machine back into that pool.
Fields¶
| Field | Definition |
|---|---|
| AllocateActions | AllocateActions defines a set of configuration for machines allocating in the pool. |
| AllocateActions/AddParameters | AddParameters defines a list of parameters to add to the machine |
| AllocateActions/AddProfiles | AddProfiles defines a list of profiles to add to the machine |
| AllocateActions/RemoveParameters | RemoveParameters defines a list of parameters to remove from the machine |
| AllocateActions/RemoveProfiles | RemoveProfiles defines a list of profiles to remove from the machine |
| AllocateActions/Workflow | Workflow defines the new workflow the machine should run |
| AutoFill | AutoFill defines configuration to handle Pool scaling. |
| AutoFill/AcquirePool | AcquirePool is the pool to draw machines from |
| AutoFill/CreateParameters | CreateParameters are the parameters to apply to a create machine |
| AutoFill/MaxFree | MaxFree is the maximum number of machines in the pool |
| AutoFill/MinFree | MinFree is the minimum number of machines in the pool |
| AutoFill/ReturnPool | ReturnPool is the pool to return machines to |
| AutoFill/UseAutoFill | UseAutoFill turns on or off the auto fill feature - NOT IMPLEMENTED |
| Description | Description is a string for providing a simple description |
| Documentation | Documentation is a string for providing additional in depth information. |
| EnterActions | EnterActions defines a set of configuration for machines entering the pool. |
| EnterActions/AddParameters | AddParameters defines a list of parameters to add to the machine |
| EnterActions/AddProfiles | AddProfiles defines a list of profiles to add to the machine |
| EnterActions/RemoveParameters | RemoveParameters defines a list of parameters to remove from the machine |
| EnterActions/RemoveProfiles | RemoveProfiles defines a list of profiles to remove from the machine |
| EnterActions/Workflow | Workflow defines the new workflow the machine should run |
| ExitActions | ExitActions defines a set of configuration for machines exiting the pool. |
| ExitActions/AddParameters | AddParameters defines a list of parameters to add to the machine |
| ExitActions/AddProfiles | AddProfiles defines a list of profiles to add to the machine |
| ExitActions/RemoveParameters | RemoveParameters defines a list of parameters to remove from the machine |
| ExitActions/RemoveProfiles | RemoveProfiles defines a list of profiles to remove from the machine |
| ExitActions/Workflow | Workflow defines the new workflow the machine should run |
| Id | Id is the name of the pool |
| Meta | Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata |
| ParentPool | ParentPool contains the pool that machines should Enter from and Exit to. |
| ReleaseActions | ReleaseActions defines a set of configuration for machines releasing in the pool. |
| ReleaseActions/AddParameters | AddParameters defines a list of parameters to add to the machine |
| ReleaseActions/AddProfiles | AddProfiles defines a list of profiles to add to the machine |
| ReleaseActions/RemoveParameters | RemoveParameters defines a list of parameters to remove from the machine |
| ReleaseActions/RemoveProfiles | RemoveProfiles defines a list of profiles to remove from the machine |
| ReleaseActions/Workflow | Workflow defines the new workflow the machine should run |