README

This package provides a Server Provider for Spatie's Laravel Dynamic Servers Package.

The package is under active development and not suitable for production. Please feel free to contribute.

Installation

You can install the package via composer:

composer require sidis405/laravel-dynamic-servers-digital-ocean

Afterward make sure to publish the EventServiceProvider that comes with this package:

php artisan dynamic-servers-digital-ocean:install

Usage

In your config/dynamic-servers.php register the DO provider

return [
    'providers' => [
        ...

        'digital_ocean' => [
            'class' => Sidis405\LaravelDynamicServersDigitalOcean\DigitalOcean\DigitalOceanServerProvider::class,
            'maximum_servers_in_account' => 20,
            'options' => [
                'token' => env('DIGITAL_OCEAN_TOKEN'),
                'region' => env('DIGITAL_OCEAN_REGION'),
                'size' => env('DIGITAL_OCEAN_SIZE'),
                'image' => env('DIGITAL_OCEAN_IMAGE'),
                'vpc_uuid' => env('DIGITAL_OCEAN_VPC_UUID'),
            ],
        ],
    ]
];

In your app/Providers/DynamicServersProvider.php register a new server type using the Digital Ocean provider

public function register()
{
    ....

    $doServer = ServerType::new('do')
        ->provider('digital_ocean')
        ->configuration(function(Server $server) {
            return [
                'name' => Str::slug($server->name),

                "image" => $server->option('image'),
                "vpc_uuid" => $server->option('vpc_uuid'),
                "region" => $server->option('region'),
                "size" => $server->option('size'),

                "ipv6" => false,
                "backups" => false,
                "monitoring" => true,
            ];
        });

        DynamicServers::registerServerType($doServer);
}

Events

After the base package's CreateServerJob is executed, a new job, VerifyServerStartedJob will be dispatched and will check every 20 seconds to make sure that the provider eventually marks the Droplet as running.

After it ensures it runs, no other attempt is made to fetch again the server meta.

Considering that DigitalOcean will return the ip address of a droplet only after it has been full created we need to fetch once more the droplet meta.

For this, we will use the base package's event 'ServerRunningEvent'.

This package, publishes a App\Providers\DigitalOceanEventServiceProvider in your project.

By default there is a single listener, configured and it will fetch again the Droplet's meta after the base package has ensured that it is running.

protected $listen = [
        ServerRunningEvent::class => [
            UpdateServerMeta::class,
        ],
    ];

You may customise the listener, disable it or replace it with a your own.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

sidis405 / laravel-dynamic-servers-digital-ocean

Maintainers

Details