Add deployment lifecycle commands

Author: stevebauman

README.md

@@ -174,36 +174,66 @@ $deployment->writeIndexes(); // ['posts_search']
 Once the candidate has been inspected, begin backfilling before importing historical documents. This enables concurrent writes and deletions to the candidate:
 
 ```php
-$deployment = $deployer->beginBackfill('posts');
+$deployment = $deployer->backfill('posts');
 
 $deployment->writeIndexes();
 ```
 
+The same transition is available from the command line:
+
+```bash
+php artisan opensearch:deploy:backfill posts
+```
+
 After application-specific validation succeeds, mark the candidate ready and atomically move the alias:
 
 ```php
 $deployer->markReady('posts');
 $deployer->cutover('posts');
 ```
 
+```bash
+php artisan opensearch:deploy:ready posts
+php artisan opensearch:deploy:cutover posts
+```
+
 Cancel and delete a candidate that should not be promoted:
 
 ```php
 $deployer->cancel('posts');
 ```
 
+```bash
+php artisan opensearch:deploy:cancel posts
+```
+
 The previous index remains in the deployment's write indexes during the rollback window:
 
 ```php
 $deployer->rollback('posts');
 ```
 
+```bash
+php artisan opensearch:deploy:rollback posts
+```
+
 Once the new index is verified in production, delete the previous physical index and complete the deployment:
 
 ```php
 $deployer->retire('posts');
 ```
 
+```bash
+php artisan opensearch:deploy:retire posts
+```
+
+Inspect one or every deployment at any point in the lifecycle:
+
+```bash
+php artisan opensearch:deploy:status
+php artisan opensearch:deploy:status posts
+```
+
 `opensearch:migrate:fresh` deletes all deployment records because it drops all physical indexes. Migration reset and refresh commands refuse to run while managed deployments exist.
 
 ## Credits

src/Console/DeploymentBackfillCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace DirectoryTree\OpenSearchMigrations\Console;
+
+use DirectoryTree\OpenSearchMigrations\Deployer;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+/**
+ * Begin backfilling an OpenSearch deployment.
+ */
+class DeploymentBackfillCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'opensearch:deploy:backfill
+        {name : The logical index name}
+        {--force : Force the operation to run when in production}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Enable candidate writes before backfilling an index';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Deployer $deployer): int
+    {
+        if (! $this->confirmToProceed()) {
+            return static::FAILURE;
+        }
+
+        $deployer->backfill($this->argument('name'));
+
+        $this->components->info("Deployment [{$this->argument('name')}] is ready to be backfilled.");
+
+        return static::SUCCESS;
+    }
+}

src/Console/DeploymentCancelCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace DirectoryTree\OpenSearchMigrations\Console;
+
+use DirectoryTree\OpenSearchMigrations\Deployer;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+/**
+ * Cancel an OpenSearch deployment.
+ */
+class DeploymentCancelCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'opensearch:deploy:cancel
+        {name : The logical index name}
+        {--force : Force the operation to run when in production}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Cancel an index deployment and delete its candidate';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Deployer $deployer): int
+    {
+        if (! $this->confirmToProceed()) {
+            return static::FAILURE;
+        }
+
+        $deployer->cancel($this->argument('name'));
+
+        $this->components->info("Deployment [{$this->argument('name')}] was cancelled.");
+
+        return static::SUCCESS;
+    }
+}

src/Console/DeploymentCutoverCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace DirectoryTree\OpenSearchMigrations\Console;
+
+use DirectoryTree\OpenSearchMigrations\Deployer;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+/**
+ * Cut over an OpenSearch deployment.
+ */
+class DeploymentCutoverCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'opensearch:deploy:cutover
+        {name : The logical index name}
+        {--force : Force the operation to run when in production}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Switch an index alias to its ready candidate';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Deployer $deployer): int
+    {
+        if (! $this->confirmToProceed()) {
+            return static::FAILURE;
+        }
+
+        $deployer->cutover($this->argument('name'));
+
+        $this->components->info("Deployment [{$this->argument('name')}] was cut over.");
+
+        return static::SUCCESS;
+    }
+}

src/Console/DeploymentReadyCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace DirectoryTree\OpenSearchMigrations\Console;
+
+use DirectoryTree\OpenSearchMigrations\Deployer;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+/**
+ * Mark an OpenSearch deployment as ready.
+ */
+class DeploymentReadyCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'opensearch:deploy:ready
+        {name : The logical index name}
+        {--force : Force the operation to run when in production}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Mark an index deployment as ready for cutover';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Deployer $deployer): int
+    {
+        if (! $this->confirmToProceed()) {
+            return static::FAILURE;
+        }
+
+        $deployer->markReady($this->argument('name'));
+
+        $this->components->info("Deployment [{$this->argument('name')}] is ready for cutover.");
+
+        return static::SUCCESS;
+    }
+}

src/Console/DeploymentRetireCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace DirectoryTree\OpenSearchMigrations\Console;
+
+use DirectoryTree\OpenSearchMigrations\Deployer;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+/**
+ * Retire an OpenSearch deployment.
+ */
+class DeploymentRetireCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'opensearch:deploy:retire
+        {name : The logical index name}
+        {--force : Force the operation to run when in production}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Delete the previous index and complete a deployment';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Deployer $deployer): int
+    {
+        if (! $this->confirmToProceed()) {
+            return static::FAILURE;
+        }
+
+        $deployer->retire($this->argument('name'));
+
+        $this->components->info("Deployment [{$this->argument('name')}] was retired.");
+
+        return static::SUCCESS;
+    }
+}

src/Console/DeploymentRollbackCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace DirectoryTree\OpenSearchMigrations\Console;
+
+use DirectoryTree\OpenSearchMigrations\Deployer;
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+
+/**
+ * Roll back an OpenSearch deployment.
+ */
+class DeploymentRollbackCommand extends Command
+{
+    use ConfirmableTrait;
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'opensearch:deploy:rollback
+        {name : The logical index name}
+        {--force : Force the operation to run when in production}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Restore the previous index behind an alias';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(Deployer $deployer): int
+    {
+        if (! $this->confirmToProceed()) {
+            return static::FAILURE;
+        }
+
+        $deployer->rollback($this->argument('name'));
+
+        $this->components->info("Deployment [{$this->argument('name')}] was rolled back.");
+
+        return static::SUCCESS;
+    }
+}