Servers¶

URL parameters for filtering servers¶

Using an image¶

There are a few parameter requirements when creating a server using an image:

• name - needs to be a string;
• flavor - a OpenCloud\Compute\Resource\Flavor object, that is populated with the values of a real API flavor;
• image - a OpenCloud\Compute\Resource\Image object, that is populated with the values of a real API image;

Firstly we need to find our flavor and image using their UUIDs. For more information about these concepts, including how to find flavor/image UUIDs, please consult §§ 3-4 in the Getting Started guide.

$ubuntuImage = $compute->image('868a0966-0553-42fe-b8b3-5cadc0e0b3c5');
$twoGbFlavor = $compute->flavor('4');

Now we’re ready to create our instance:

use OpenCloud\Compute\Constants\Network;

$server = $compute->server();

try {
    $response = $server->create(array(
        'name'     => 'My lovely server',
        'image'    => $ubuntuImage,
        'flavor'   => $twoGbFlavor
    ));
} catch (\Guzzle\Http\Exception\BadResponseException $e) {

    // No! Something failed. Let's find out:
    $responseBody = (string) $e->getResponse()->getBody();
    $statusCode   = $e->getResponse()->getStatusCode();
    $headers      = $e->getResponse()->getHeaderLines();

    echo sprintf('Status: %s\nBody: %s\nHeaders: %s', $statusCode, $responseBody, implode(', ', $headers);
}

It’s always best to be defensive when executing functionality over HTTP; you can achieve this best by wrapping calls in a try/catch block. It allows you to debug your failed operations in a graceful and efficient manner.

Using a bootable volume¶

There are a few parameter requirements when creating a server using a bootable volume:

• name - needs to be a string;
• flavor - a OpenCloud\Compute\Resource\Flavor object, that is populated with the values of a real API flavor;
• volume - a OpenCloud\Volume\Resource\Volume object, that is populated with the values of a real API volume;

Firstly we need to find our flavor and volume using their IDs.

$volumeService = $client->volumeService();
$bootableVolume = $volumeService->volume('<ID OF A BOOTABLE VOLUME>');
$flavor = $compute->flavor('<ID OF A FLAVOR>');

Now we’re ready to create our instance:

use OpenCloud\Compute\Constants\Network;

$server = $compute->server();

try {
    $response = $server->create(array(
        'name'     => 'My lovely server',
        'volume'   => $bootableVolume,
        'flavor'   => $flavor
    ));
} catch (\Guzzle\Http\Exception\BadResponseException $e) {
    // No! Something failed. Let's find out:
    echo $e->getRequest() . PHP_EOL . PHP_EOL;
    echo $e->getResponse();
}

It’s always best to be defensive when executing functionality over HTTP; you can achieve this best by wrapping calls in a try/catch block. It allows you to debug your failed operations in a graceful and efficient manner.

Create parameters¶

Creating a server with keypairs¶

Please see the Keypair docs for more information.

Creating a server with personality files¶

Before you execute the create operation, you can add “personality” files to your OpenCloud\Compute\Resource\Server object. These files are structured as a flat array.

$server->addFile('/var/test_file', 'FILE CONTENT');

As you can see, the first parameter represents the filename, and the second is a string representation of its content. When the server is created these files will be created on its local filesystem. For more information about server personality files, please consult the official documentation.

Updatable attributes¶