https://github.com/lissonpsantos2/digitalocean-droplet-manager

https://github.com/lissonpsantos2/digitalocean-droplet-manager

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lissonpsantos2/digitalocean-droplet-manager
• Owner: lissonpsantos2
• Created: 2019-05-16T15:25:09.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T12:22:53.000Z (over 1 year ago)
• Last Synced: 2024-06-08T06:32:43.424Z (4 months ago)
• Language: PHP
• Size: 188 KB
• Stars: 3
• Watchers: 0
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Digital Ocean Droplet Automation

This project was made using the [Lumen PHP Framework](https://lumen.laravel.com/docs) with the objective of assisting in the automation of droplet maintenance.

## HOW-TOs

### Panel requirements

Before trying to use this application, you have to be sure that you have a load balancer on digitalocean that is associated to a specific tag.

You must also have a droplet image or snapshot that will serve as the base image for creating the new droplet.

### 1. Configure the application

First of all you must follow the [lumen docs](https://lumen.laravel.com/docs) for the application installation.

Add your custom enviroment variables on .env file:

- DO_API_KEY={YOUR DIGITAL OCEAN API KEY}

- DO_DEFAULT_IMAGE={YOUR DIGITAL OCEAN BASE IMAGE OR SNAPSHOT}

- DO_DEFAULT_REGION={YOUR DIGITAL OCEAN REGION}

- DO_DROPLET_DEFAULT_TAG={YOUR DIGITAL OCEAN DEFAULT TAG NAME}

You can also make a copy of the `schedules.json.example` to `schedules.json` and add on it your required droplet creation schedules.

Digitalocean provides a cloud-config option when creating a droplet, you must make a copy of `storage/docs/cloud-config.yaml.example` to `storage/docs/cloud-config.yaml` and put on it all the routines that you desire to be run after queue droplet instantiation

### 2. Running the application

The project provides a `docker-compose.yml` file, so you can execute it with a docker-compose command.

After that, you have to create a cron job that will execute a get request every minute to trigger the schedule:run inside the container:

```

* * * * * curl localhost:8000/schedule >/dev/null 2>&1

```

## ARE YOU CURIOUS? :D

### 1. Register the droplet creation routines

The create droplet routine is based on the create droplet command as follows:

```create:droplet {droplet_name} {droplet_size} {total_count}```

Basically this command will create `{total_count}` droplets with the size `{droplet_size}`. All the created droplets have a default format name:

{droplet_name}{droplet_size}-{random_5_digit_number}

All the created droplets will be tagged with `DO_DROPLET_DEFAULT_TAG` enviroment variables, it's important to guarantee the use with load-balancers.

To register this command as a routine you have to create a schedule for the command.

```php

$schedule

  ->command('create:droplet my-app- 3x 4')

  ->cron('0 12 * * *');

```

### 2. Register the droplet delete routines

The delete droplet routine is based on the following command:

```delete:droplet {droplet_name} {droplet_size}```

This command will search for droplets by name, applying a ```preg_match``` to match the desired droplets. For security, there is a ```$protected_droplets``` array where you can define a list of droplets to be ignored by the command.

To register this command as a routine you have to create a schedule for the command.

```php

$schedule

  ->command('delete:droplet my-app- 3x')

  ->cron('0 12 * * *');

```

## DO YOU NEED HELP?!

[Schedule documentation](https://laravel.com/docs/5.8/scheduling#scheduling-artisan-commands)

[Commands documentation](https://laravel.com/docs/5.8/artisan#writing-commands)

[Digital Ocean API docs](https://developers.digitalocean.com/documentation/v2/)

## DO YOU WANT TO HELP?

You can submmit a pull request or open an issue :) cheers