@codiac.io/codiac-cli 1.3.187 → 1.3.189

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.187",
+  "version": "1.3.189",
   "commands": {
     "branch": {
       "id": "branch",
@@ -2986,6 +2986,562 @@
         }
       }
     },
+    "cabinet:define": {
+      "id": "cabinet:define",
+      "description": "Records the cabinet metadata without provisioning any k8s infrastructure. Use when the target cluster has no physical instance yet, or to stage a cabinet definition ahead of provisioning.",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [
+        "cab:define"
+      ],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Define a cabinet interactively.",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Define a cabinet interactively and assemble a non-interactive command string.",
+          "command": "<%= config.bin %> <%= command.id %> --echo"
+        },
+        {
+          "description": "Assemble a non-interactive command string without defining (dry run).",
+          "command": "<%= config.bin %> <%= command.id %> --to-script"
+        },
+        {
+          "description": "Define a cabinet silently (scripted).",
+          "command": "<%= config.bin %> <%= command.id %> my-cab --enterprise main --environment dev-environment --cluster my-cluster --silent"
+        }
+      ],
+      "flags": {
+        "as": {
+          "name": "as",
+          "type": "option",
+          "description": "Fires this command with an argument list that was previously remembered using the --rememberAs flag.",
+          "multiple": false
+        },
+        "remember": {
+          "name": "remember",
+          "type": "boolean",
+          "description": "Saves the arguments, so they are invoked as defaults whenever this command gets called.",
+          "allowNo": false
+        },
+        "rememberAs": {
+          "name": "rememberAs",
+          "type": "option",
+          "description": "Saves the given argument list so that it can be called by name.",
+          "multiple": false
+        },
+        "unremember": {
+          "name": "unremember",
+          "type": "option",
+          "description": "Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were previously stored under the given name (use \"--unRemember default\" to clear default argument list memorized with the --remember flag).",
+          "multiple": false
+        },
+        "withoutdefaults": {
+          "name": "withoutdefaults",
+          "type": "boolean",
+          "description": "Prevents any relevant saved defaults from being invoked for this call.",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "char": "v",
+          "description": "Renders additional logging levels (detail, trace, and debug) to the console output.",
+          "allowNo": false
+        },
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "description": "(required only if more than one enterprise exists) The enterprise under which to define the cabinet.",
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "char": "e",
+          "description": "The environment this cabinet belongs to.",
+          "multiple": false
+        },
+        "cluster": {
+          "name": "cluster",
+          "type": "option",
+          "char": "c",
+          "description": "The cluster to assign this cabinet to. Defaults to the only cluster in the environment when there is exactly one.",
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-interactive mode; executes without prompts and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command before executing.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command without executing it.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        },
+        "take-defaults": {
+          "name": "take-defaults",
+          "type": "boolean",
+          "description": "Accepts default values without confirmation prompts (irrelevant in --silent mode).",
+          "allowNo": false,
+          "exclusive": [
+            "silent"
+          ]
+        }
+      },
+      "args": {
+        "cabinet": {
+          "name": "cabinet",
+          "description": "The name of the cabinet to define.",
+          "required": false
+        }
+      }
+    },
+    "cabinet:destroy": {
+      "id": "cabinet:destroy",
+      "description": "Tears down the k8s namespace for a cabinet without deleting the cabinet metadata record. The definition is preserved so the cabinet can be restored to the same or a different cluster later.",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [
+        "cab:destroy"
+      ],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Destroy a cabinet interactively.",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Destroy a cabinet silently (scripted).",
+          "command": "<%= config.bin %> <%= command.id %> my-cab --enterprise main --environment dev --silent"
+        },
+        {
+          "description": "Move a running cabinet to a different cluster.",
+          "command": "<%= config.bin %> <%= command.id %> my-cab --enterprise main --environment dev --silent && cod cabinet detach my-cab --enterprise main --environment dev --silent && cod cabinet cluster attach my-cab --enterprise main --environment dev --cluster new-cluster --silent && cod cabinet restore --cabinet my-cab --enterprise main --environment dev --silent"
+        }
+      ],
+      "flags": {
+        "as": {
+          "name": "as",
+          "type": "option",
+          "description": "Fires this command with an argument list that was previously remembered using the --rememberAs flag.",
+          "multiple": false
+        },
+        "remember": {
+          "name": "remember",
+          "type": "boolean",
+          "description": "Saves the arguments, so they are invoked as defaults whenever this command gets called.",
+          "allowNo": false
+        },
+        "rememberAs": {
+          "name": "rememberAs",
+          "type": "option",
+          "description": "Saves the given argument list so that it can be called by name.",
+          "multiple": false
+        },
+        "unremember": {
+          "name": "unremember",
+          "type": "option",
+          "description": "Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were previously stored under the given name (use \"--unRemember default\" to clear default argument list memorized with the --remember flag).",
+          "multiple": false
+        },
+        "withoutdefaults": {
+          "name": "withoutdefaults",
+          "type": "boolean",
+          "description": "Prevents any relevant saved defaults from being invoked for this call.",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "char": "v",
+          "description": "Renders additional logging levels (detail, trace, and debug) to the console output.",
+          "allowNo": false
+        },
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "description": "The enterprise that owns the cabinet.",
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "char": "e",
+          "description": "The environment the cabinet belongs to.",
+          "multiple": false
+        },
+        "cabinet": {
+          "name": "cabinet",
+          "type": "option",
+          "char": "b",
+          "description": "The name of the cabinet to destroy.",
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-interactive mode; fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command before executing.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command without executing it.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        },
+        "take-defaults": {
+          "name": "take-defaults",
+          "type": "boolean",
+          "description": "Accepts default values without confirmation prompts.",
+          "allowNo": false,
+          "exclusive": [
+            "silent"
+          ]
+        }
+      },
+      "args": {
+        "cabinet": {
+          "name": "cabinet",
+          "description": "The name of the cabinet to destroy.",
+          "required": false
+        }
+      }
+    },
+    "cabinet:detach": {
+      "id": "cabinet:detach",
+      "description": "Clears the cluster assignment from a cabinet definition, making it available to re-attach to a different cluster. Does not touch any k8s infrastructure.",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [
+        "cab:detach"
+      ],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Detach a cabinet interactively.",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Detach a cabinet silently (scripted).",
+          "command": "<%= config.bin %> <%= command.id %> my-cab --enterprise main --environment dev --silent"
+        },
+        {
+          "description": "Move a cabinet to a different cluster.",
+          "command": "<%= config.bin %> <%= command.id %> my-cab --enterprise main --environment dev --silent && cod cabinet cluster attach my-cab --enterprise main --environment dev --cluster new-cluster && cod cabinet restore --cabinet my-cab --enterprise main --environment dev"
+        }
+      ],
+      "flags": {
+        "as": {
+          "name": "as",
+          "type": "option",
+          "description": "Fires this command with an argument list that was previously remembered using the --rememberAs flag.",
+          "multiple": false
+        },
+        "remember": {
+          "name": "remember",
+          "type": "boolean",
+          "description": "Saves the arguments, so they are invoked as defaults whenever this command gets called.",
+          "allowNo": false
+        },
+        "rememberAs": {
+          "name": "rememberAs",
+          "type": "option",
+          "description": "Saves the given argument list so that it can be called by name.",
+          "multiple": false
+        },
+        "unremember": {
+          "name": "unremember",
+          "type": "option",
+          "description": "Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were previously stored under the given name (use \"--unRemember default\" to clear default argument list memorized with the --remember flag).",
+          "multiple": false
+        },
+        "withoutdefaults": {
+          "name": "withoutdefaults",
+          "type": "boolean",
+          "description": "Prevents any relevant saved defaults from being invoked for this call.",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "char": "v",
+          "description": "Renders additional logging levels (detail, trace, and debug) to the console output.",
+          "allowNo": false
+        },
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "description": "The enterprise that owns the cabinet.",
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "char": "e",
+          "description": "The environment the cabinet belongs to.",
+          "multiple": false
+        },
+        "cabinet": {
+          "name": "cabinet",
+          "type": "option",
+          "char": "b",
+          "description": "The name of the cabinet to detach.",
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-interactive mode; fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command before executing.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command without executing it.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        },
+        "take-defaults": {
+          "name": "take-defaults",
+          "type": "boolean",
+          "description": "Accepts default values without confirmation prompts.",
+          "allowNo": false,
+          "exclusive": [
+            "silent"
+          ]
+        }
+      },
+      "args": {
+        "cabinet": {
+          "name": "cabinet",
+          "description": "The name of the cabinet to detach.",
+          "required": false
+        }
+      }
+    },
+    "cabinet:forget": {
+      "id": "cabinet:forget",
+      "description": "Removes the cabinet metadata record from Codiac without touching any k8s infrastructure. The physical namespace (if any) remains on the cluster, unaware and unaffected.",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [
+        "cab:forget"
+      ],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Forget a cabinet interactively.",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Forget a cabinet silently (scripted).",
+          "command": "<%= config.bin %> <%= command.id %> my-cab --enterprise main --environment dev --silent"
+        },
+        {
+          "description": "Renders the equivalent silent command without executing.",
+          "command": "<%= config.bin %> <%= command.id %> --to-script"
+        }
+      ],
+      "flags": {
+        "as": {
+          "name": "as",
+          "type": "option",
+          "description": "Fires this command with an argument list that was previously remembered using the --rememberAs flag.",
+          "multiple": false
+        },
+        "remember": {
+          "name": "remember",
+          "type": "boolean",
+          "description": "Saves the arguments, so they are invoked as defaults whenever this command gets called.",
+          "allowNo": false
+        },
+        "rememberAs": {
+          "name": "rememberAs",
+          "type": "option",
+          "description": "Saves the given argument list so that it can be called by name.",
+          "multiple": false
+        },
+        "unremember": {
+          "name": "unremember",
+          "type": "option",
+          "description": "Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were previously stored under the given name (use \"--unRemember default\" to clear default argument list memorized with the --remember flag).",
+          "multiple": false
+        },
+        "withoutdefaults": {
+          "name": "withoutdefaults",
+          "type": "boolean",
+          "description": "Prevents any relevant saved defaults from being invoked for this call.",
+          "allowNo": false
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "char": "v",
+          "description": "Renders additional logging levels (detail, trace, and debug) to the console output.",
+          "allowNo": false
+        },
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "description": "The enterprise that owns the cabinet.",
+          "multiple": false
+        },
+        "environment": {
+          "name": "environment",
+          "type": "option",
+          "char": "e",
+          "description": "The environment the cabinet belongs to.",
+          "multiple": false
+        },
+        "cabinet": {
+          "name": "cabinet",
+          "type": "option",
+          "char": "b",
+          "description": "The name of the cabinet to forget.",
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-interactive mode; fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command before executing.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Renders the equivalent non-interactive command without executing it.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        },
+        "take-defaults": {
+          "name": "take-defaults",
+          "type": "boolean",
+          "description": "Accepts default values without confirmation prompts.",
+          "allowNo": false,
+          "exclusive": [
+            "silent"
+          ]
+        }
+      },
+      "args": {
+        "cabinet": {
+          "name": "cabinet",
+          "description": "The name of the cabinet to forget.",
+          "required": false
+        }
+      }
+    },
     "cabinet:list": {
       "id": "cabinet:list",
       "description": "Shows the list of cabinets and environment.",
@@ -12548,6 +13104,13 @@
           "required": false,
           "allowNo": false
         },
+        "forget-cabinets": {
+          "name": "forget-cabinets",
+          "type": "boolean",
+          "description": "Permanently delete cabinet records instead of just orphaning them (clearing the cluster assignment).",
+          "required": false,
+          "allowNo": false
+        },
         "silent": {
           "name": "silent",
           "type": "boolean",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codiac.io/codiac-cli",
   "description": "Local command line interface for managing enterprise assets and environments.",
-  "version": "1.3.187",
+  "version": "1.3.189",
   "author": "Codiac",
   "bin": {
     "codiac": "./bin/run",