Gérer les instances cloud à l'aide de l'API Digital Ocean-tutoriel php-php.cn

使用 Digital Ocean API 管理云实例

Qu’est-ce que l’Océan Numérique ?

Digital Ocean est l'un des hébergeurs Web à la croissance la plus rapide, en partie grâce à ses serveurs rapides basés sur SSD et à ses plans d'hébergement bon marché à 5 $ par mois. Lancer une instance sur Digital Ocean pour des tests ou une utilisation à long terme est rapide, simple et abordable.

Dans Création d'images d'application pour la revente chez Digital Ocean, je vous montre comment créer une instance WordPress (ou une autre application) et la cloner à plusieurs reprises pour les clients. Dans ce didacticiel, je vais vous guider dans l'utilisation de l'API Digital Ocean pour gérer par programme nos instances (également appelées droplets) et automatiser les tâches courantes. Je fournirai également un exemple de base de code pour exécuter des opérations API très basiques écrites dans Yii Framework pour PHP, vous pouvez obtenir le code sur Github ;

API Océan numérique

L'API Digital Ocean vous permet de gérer les droplets et les ressources simplement et par programmation à l'aide de requêtes HTTP. Toutes les fonctionnalités que vous connaissez dans le panneau de contrôle Digital Ocean sont également disponibles via l'API, vous permettant de scripter des opérations complexes selon votre situation.

Dans ce didacticiel, nous intégrerons la bibliothèque d'API PHP Digital Ocean V2 du développeur Antoine Corcy dans une application console basée sur Yii. Vous n'avez pas besoin de connaître Yii pour utiliser cette application, mais vous pouvez en savoir plus ici : Introduction au framework Yii.

L'API Digital Ocean authentifie votre compte via OAuth et se compose de près d'une douzaine de zones premium :

Compte : fournissez des informations de base sur votre compte Digital Ocean.
Opérations : journal de l'historique des opérations des gouttelettes dans votre compte.
Noms de domaine et enregistrements de domaine : vous permet de gérer les noms de domaine utilisés sur les droplets de votre compte et les enregistrements DNS qui leur sont associés.
Droplets et actions Droplet : vous permet de créer, d'arrêter, de redémarrer, de prendre un instantané, etc. pour les Droplets.
Images et actions sur les images : vous permet d'énumérer et de gérer les images instantanées prises pour les Droplets dans votre compte.
Clés SSH : vous permet d'enregistrer une clé SSH pour l'installation lors de la création d'un droplet, la sécurité par mot de passe n'est donc pas requise.
Région : Énumère les zones géographiques dans lesquelles des gouttes océaniques numériques peuvent être créées.
Tailles : Énumérez les tailles de gouttelettes qui peuvent être utilisées lors de la création de gouttelettes.

Maintenant que vous connaissez une partie de l’API, plongeons-nous dans notre propre application.

Définir la clé d'accès

Pour utiliser l'API, vous devez activer un jeton d'accès personnel pour votre compte. Connectez-vous à votre compte et visitez la page Paramètres Applications : https://cloud.digitalocean.com/settings/applications. Cliquez sur pour générer un nouveau jeton , comme indiqué ci-dessous :

使用 Digital Ocean API 管理云实例

Notez votre jeton d'accès ci-dessous - Digital Ocean ne vous le montrera qu'une seule fois :

使用 Digital Ocean API 管理云实例

Maintenant, passons à l’exemple d’application console.

Notre application console

Dans ce didacticiel, nous explorerons une petite application console que j'ai créée et qui effectue certaines tâches liées à la gestion des Droplets. Vous pouvez installer l'application vous-même à partir du référentiel Tuts+ GitHub et la personnaliser ou l'étendre pour implémenter les fonctionnalités API supplémentaires de votre choix. J'ai publié un guide d'installation détaillé de l'application console sur mon site Web. Vous pouvez également consulter mon guide général d'installation de l'application Digital Ocean.

Configurer l'accès à l'API

Nous utilisons à nouveau la bibliothèque API PHP Digital Ocean V2 d'Antoine Corcy pour accéder à l'API.

Nous avons construit un composant appelé Ocean.php qui sert de modèle pour l'utilisation de sa bibliothèque. Il est situé au /app/protected/components/Ocean.php.

Yii charge votre jeton d'accès à partir du fichier Ocean.ini (comme décrit dans le guide d'installation de l'application Digital Ocean Console) et instancie l'objet API digitalOcean.

<?php

use DigitalOceanV2\Adapter\BuzzAdapter;
use DigitalOceanV2\DigitalOceanV2;

class Ocean extends CComponent
{
  private $adapter;
  private $digitalOcean;
  
   function __construct() {     
     // create an adapter with your access token which can be
     // generated at https://cloud.digitalocean.com/settings/applications
     $this->adapter = new BuzzAdapter(Yii::app()->params['ocean']['access_key']);
     // create a digital ocean object with the previous adapter
     $this->digitalOcean = new DigitalOceanV2($this->adapter);
  }

Copier après la connexion

Obtenez une gouttelette

使用 Digital Ocean API 管理云实例

Maintenant, obtenons la liste des gouttelettes actives. Appelez le composant Ocean dans la méthode /app/protected/models/Droplet.php 中，我们的 sync et récupérez le Droplet :

    public function sync() {
    $ocean = new Ocean();
    $droplets = $ocean->getDroplets();
    foreach ($droplets as $d) {
      $droplet_id = $this->add($d);
    }	      
  }

Copier après la connexion

Océan getDroplets La méthode est la suivante :

  public function getDroplets() {
    // return the action api
    $action  = $this->digitalOcean->droplet();
    // return a collection of Action entity
    $actions = $action->getAll();    
    return $actions;
  }

Copier après la connexion

Remarque : L'application console de base effectue uniquement une synchronisation de téléchargement unidirectionnelle de notre liste de droplets. Vous pouvez implémenter davantage de fonctions vous-même, notamment la suppression des gouttes supprimées dans le cloud.

C'est la add fonction de notre modèle Droplet. Si le droplet existe déjà, on met simplement à jour l'enregistrement :

public function add($droplet) {
     $d = Droplet::model()->findByAttributes(array('droplet_id'=>$droplet->id));
    if (empty($d)) {
      $d = new Droplet;
    }
    $d->user_id = Yii::app()->user->id;
      $d->droplet_id = $droplet->id;
      $d->name = $droplet->name;
      $d->vcpus = $droplet->vcpus;
      $d->memory = $droplet->memory;
      $d->disk = $droplet->disk;
      $d->status = $droplet->status;
      $d->active =1;
     $d->created_at = $d->created_at;
     $d->modified_at =new CDbExpression('NOW()');          
     $d->save();
    return $d->id;
   }

Copier après la connexion

如果您希望扩展模型的功能，Digital Ocean 提供了各种 Droplet API 操作，Corcy 在此列出了清晰的示例。

获取图像

接下来，我们将使用 API 来获取当前图像的列表。映像是快照，本质上是备份，是在给定时间点从服务器实例获取的。

使用 Digital Ocean API 管理云实例

我们的 Snapshot.php 模型有一个 sync 操作，它会请求图像列表并添加将它们分别写入数据库：

   public function sync() {
     $ocean = new Ocean();
     $snapshots = $ocean->getSnapshots();
     foreach ($snapshots as $i) {
       $image_id = $this->add($i);
       if ($image_id!==false) {
         echo $image_id;lb();
         pp($i);        
       }
     }          
   }

Copier après la connexion

这是海洋组件 getSnapshots 代码：

  public function getSnapshots() {
    // return the action api
    $action  = $this->digitalOcean->image();
    // return a collection of Action entity
    $actions = $action->getAll();    
    return $actions;
  }

Copier après la connexion

这是快照模型 add 代码 - 我们忽略 Digital Ocean 的库存应用程序映像，这些映像被区分为公共：

   public function add($snapshot) {
      $i = Snapshot::model()->findByAttributes(array('image_id'=>$snapshot->id));
     if (empty($i)) {
       $i = new Snapshot;
       $i->created_at =new CDbExpression('NOW()');          
     }
     if (isset($snapshot->public) and $snapshot->public ==1) {
       return false; // no need to save public images right now
     } else 
       $i->user_id = Yii::app()->user->id;       
       $i->image_id = $snapshot->id;
       $i->name = $snapshot->name;
       $i->region = $snapshot->regions[0];
       $i->active =1;
       $i->modified_at =new CDbExpression('NOW()');          
      $i->save();
    return $i->id;
    }

Copier après la connexion

自动化快照

正如我们在构建要在 Digital Ocean 进行转售的应用映像中所讨论的那样，自动创建可传输给客户和顾客的快照非常有用。遗憾的是，目前无法通过引用克隆或传输图像；每次您将快照转移到另一个帐户时，它就会消失。

由于 Digital Ocean 要求您将图像实例化为 Droplet，并在拍摄新快照之前将其关闭，因此重复创建快照是一个耗时的手动过程。 Digital Ocean 在拍摄快照后再次启动水滴并没有什么帮助，这只会减慢进程。

由于 API 在其他操作挂起时不接受请求，因此我们必须构建一个表来跟踪后台操作并使用 cron 作业来重复断电、快照操作。其工作原理如下：

访问图像页面，然后单击您想要克隆的快照的查看。然后，单击右侧的复制菜单选项。

使用 Digital Ocean API 管理云实例

这将创建一个 Droplet 并使用此 image_id 和droplet_id。 end_stage 是一个常量，您可以设置它来指示要创建的重复项的数量。

使用 Digital Ocean API 管理云实例

这是 Snapshot 模型的 replicate() 方法：

    public function replicate($id) {
        // look up image_id
      $snapshot = Snapshot::model()->findByAttributes(array('id'=>$id));
  	  // create the droplet 
      $ocean = new Ocean();
      $droplet_id = $ocean->launch_droplet($snapshot->name,$snapshot->region,$snapshot->image_id);
  	  // add command to action table with droplet_id and image_id
      $a = new Action();
      $a->droplet_id = $droplet_id;
      $a->snapshot_id = $snapshot->image_id;
      $a->action = Action::ACTION_SNAPSHOT;
      $a->status = Action::STATUS_ACTIVE;
      $a->stage = 0;
    // user settable constant for number of replications to make
      $a->end_stage = Snapshot::NUMBER_REPLICATIONS;
      $a->last_checked = 0;
      $a->modified_at =new CDbExpression('NOW()');          
      $a->created_at =new CDbExpression('NOW()');          
      $a->save(); 
    }

Copier après la connexion

cron 任务将 ping http://ocean.yourdomain.com/daemon/index 以定期处理操作表。任何未完成的逾期项目都将请求另一个快照。

这是 Action 模型的 process() 方法：

    public function process() {
	  set_time_limit(0);
	  // look for overdue actions	  
	  $todo = Action::model()->overdue()->findAllByAttributes(array('status'=>self::STATUS_ACTIVE));
	  foreach ($todo as $item) {
	    if ($item->action == self::ACTION_SNAPSHOT) {
          $result = Snapshot::model()->take($item->id);          
	    }
	  }
	}

Copier après la connexion

快照过程将关闭 Droplet，暂停 20 秒等待 Droplet 关闭，并请求快照。

使用 Digital Ocean API 管理云实例

这是 Snapshot 模型的 take() 方法：

 public function take($action_id) {
    $result = false;
      $a = Action::model()->findByPk($action_id);
    $snapshot = Snapshot::model()->findByAttributes(array('image_id'=>$a->snapshot_id));
    $ocean = new Ocean();
    // attempt shutdown
    // take snapshot
    $result = $ocean->snapshot($a->stage,$a->droplet_id,$snapshot->name,$snapshot->region,$snapshot->image_id);
    // if snapshot was successful
    if ($result) {
      // increment stage
      $a->stage+=1;
      // if last snapshot replication complete, end action
      if ($a->stage >= $a->end_stage)  
        $a->status = Action::STATUS_COMPLETE;
    } 
	  // either way, update last_checked
    $a->last_checked = time();
    $a->save();              
	  return $result;
  }

Copier après la connexion

以下是 Ocean 组件中用于实际进行 API 调用的代码：

public function snapshot($stage,$droplet_id,$name,$region,$image_id,$begin=1,$count=3,$size='512mb') {
    $no_sleep = false;
    $name = str_replace("_","-",$name);
    $droplet  = $this->digitalOcean->droplet();
      try {
        echo 'Shutting down '.$droplet_id;lb();
        $shutdown = $droplet->shutdown($droplet_id);
      } catch (Exception $e) {
          $err = $e->getMessage();
          echo 'Caught exception: ',  $e->getMessage(), "\n";
          if (stristr ( $err , 'already powered off')===false)
            return false;
          else
            $no_sleep = true;
      }
    if (!$no_sleep) {
      echo 'Sleep 20 seconds for power off...';lb();
      sleep(20);              
    }
    echo 'Take snapshot of '.$droplet_id.' named '.$name.'-copy-'.$stage;lb();
    try {
      $snapshot = $droplet->snapshot($droplet_id, $name.'-copy-'.$stage); 
    } catch (Exception $e) {
        echo 'Caught exception: ',  $e->getMessage(), "\n";
        return false;
    }
    // shutdown and snapshot successful
    return true;
  }

Copier après la connexion

如果您访问 Digital Ocean 网站查看 Droplet，您将看到正在进行的操作：

使用 Digital Ocean API 管理云实例