Pool
Pool Overview#
This page is used to list all sandbox pools that are accessible in the KYPO portal. In the following table, each row represents one pool:
Instructors can click on the title of each pool to see a more detailed view of the given pool. The last column of this table contains actions that can be executed on the given pool:
Delete
Click the button, the following confirmation window will be opened:
After confirming, the given pool will be deleted from the KYPO portal.
Warning
Pools that are locked or not empty cannot be deleted.
Allocate all
Click the button to start allocating all missing sandboxes.
Info
More about allocation in the pool detail section.
Allocate one
Click the button to start allocating one new sandbox.
Info
More about allocation in the pool detail.
Clear
Click the button to delete all allocation requests and sandboxes from the given pool.
Warning
All sandboxes must be unlocked, and all allocation requests must be finished/stopped.
Download
Click the button to display a pop-up window to download the ZIP archive. The archive contains configuration with the SSH access to a respective sandbox. More about SSH access can be found here.
Lock
Click the button to change the state of the given pool from unlocked to locked. The lock symbolizes that pool is in use with some training instance.
Unlock
Click the button to change the state of the given pool from locked to unlocked. Unlock symbolizes that pool is not in use with any training instance.
Note
Actions 3. - 6. can be accessed in the menu shown after clicking on the more options button.
To create a new pool, click on the 
button. The instructor will be redirected to the page Create Pool.
Create Pool#
This page contains a short form that needs to be filled out before creating a new pool. The field Sandbox Pool Size specifies the maximal number of sandboxes that can be created inside the pool. The instructor must also select one of the available sandbox definitions created by the instructor. Sandbox definitions define the topology of sandboxes and user configuration of virtual machines created in a sandbox. After filling out all the fields, confirm the creation of a new pool by clicking on the button.
The sandboxes built in the pool are always created from the same definition and the same revision. When the pool is created, it is tied to the current revision of the definition. If the definition revision has changed, e.g., new commit has been added to the specific branch, and you want to build sandboxes from a new revision, you need to make a new pool.
Pool Detail#
When the instructor clicks the title of a given pool in Pool Overview they will be redirected to the Pool Detail page, which contains panels addressing sandbox instances, allocation units, allocation requests, and cleanup requests.
In the top right corner, there is the 
button that can be used to start the allocation of all missing sandboxes in the pool.
1. Sandbox Instances#
The instructor can see all of the allocated sandboxes in the Sandbox Instances table. The last column of this table contains actions that can be executed on the given sandbox:
Delete
Click the button, the following confirmation window will be opened:
After the confirmation, a new cleanup request for a given sandbox instance will be created.
Info
Only unlocked sandboxes can be deleted.
Display topology
Click the button to redirect to the page with the virtual network topology of the given sandbox.
Lock
Click the button to change the state of the sandbox instance from unlocked to locked. Lock symbolizes that the sandbox instance is connected to a training run.
Unlock
Click the button to change the state of sandbox instance from locked to unlocked. Unlock symbolizes that the sandbox instance can be connected to a training run.
Note
Actions lock and unlock can be accessed in the menu shown after clicking on the more options button and only one of these actions is always available, depending on the current state of the sandbox.
2. Allocation Units#
Each sandbox that is allocating or has been allocated is tied with the allocation unit. It is the object which manages allocation requests and cleanup requests. Allocation is composed of three stages. If one of these stages fails, the sandbox cannot be used. The last column of the table contains the create cleanup request button
. In case that all stages of the allocation request are successfully finished, the button works the same as the delete button in the Sandbox Instances table. Otherwise, the respective allocation request must be canceled (to invalidate other stages), and then create a cleanup request button can be used.
3. Allocation Requests#
In the Allocation Requests table, the instructor can see all allocation requests. Click on the title of the request will redirect to the request detail page. The last column of the table contains cancel button . If the instructor clicks the button, the ongoing allocation will be canceled and a given sandbox will not be allocated.
Warning
Canceling a finished allocation request will cause an error.
4. Cleanup Requests#
In the Cleanup Requests table, the instructor can see all cleanup requests. With the completion of cleanup requests the associated sandbox instance, allocation request and, allocation unit are deleted from the KYPO portal. There can be only one cleanup request per sandbox. The last column of the table contains actions :
Cancel request
Click the button to cancel the ongoing cleanup request. The respective sandbox won’t be removed.
Delete request
Click the button to delete the cleanup request. Only canceled cleanup requests can be deleted.
Allocation Request Stages#
The page consists of three panels. Each represents one stage of allocation (allocation of a sandbox in the cloud, sandbox networking, sandbox provisioning) and can be in one of the following states:
- In Queue: Stage is waiting to start.
- Running: Stage in progress.
- Finished: Stage was successfully executed.
- Failed: An error occurred during the stage execution.
To see details of stage execution click the Stage detail button of the given stage. In case that stage will fail, the error message should be available there.
