@codiac.io/codiac-cli 1.3.62 → 1.3.64

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.62",
+  "version": "1.3.64",
   "commands": {
     "branch": {
       "id": "branch",
@@ -1381,7 +1381,7 @@
           "name": "port",
           "type": "option",
           "char": "p",
-          "description": "The default port to assign the asset when deployed to a cabinet (optional).",
+          "description": "The default port number (from 0 to 65535) to assign the asset when deployed to a cabinet (optional).  To specify port forwarding (betw the service and container), use format: `<service-port>:<container-port>`, eg: `3555:80`",
           "required": false,
           "multiple": true
         },
@@ -1389,10 +1389,23 @@
           "name": "hasIngress",
           "type": "boolean",
           "char": "g",
-          "description": "Declaration that the asset service is to be externally accessible (optional: defaults to false).",
+          "description": "Declaration that the asset service is to be accessible from outside the cluster (optional: defaults to false).",
           "required": false,
           "allowNo": false
         },
+        "private": {
+          "name": "private",
+          "type": "boolean",
+          "description": "(for use when hasIngress is also set) Prevents access from the internet.  That is, declares that asset service to only be accessible through ingress on internal networks (optional: defaults to false).  Useful for enabling private \"east-west\" (cross-cluster) communications without going out to the internet.",
+          "required": false,
+          "allowNo": false,
+          "dependsOn": [
+            "hasIngress"
+          ],
+          "exclusive": [
+            "helm"
+          ]
+        },
         "routedWithoutName": {
           "name": "routedWithoutName",
           "type": "boolean",
@@ -1618,6 +1631,81 @@
         "cabinetName"
       ]
     },
+    "asset:edit": {
+      "id": "asset:edit",
+      "description": "Changes asset attributes.",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> -n my-api",
+        "<%= config.bin %> <%= command.id %> -e main -n my-api"
+      ],
+      "flags": {
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "char": "e",
+          "description": "The name of the enterprise in which this asset resides. (defaults to the current enterprise context).  NOTE: The enterprise assignment for an asset is immutable and cannot be modified; this flag is used only for identifying the asset.",
+          "required": false,
+          "multiple": false
+        },
+        "name": {
+          "name": "name",
+          "type": "option",
+          "char": "n",
+          "description": "The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified; this flag is used only for identifying the asset.",
+          "required": false,
+          "multiple": false
+        },
+        "code": {
+          "name": "code",
+          "type": "option",
+          "char": "c",
+          "description": "The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional: defaults to the asset name).",
+          "required": false,
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "dependsOn": [
+            "name"
+          ],
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        }
+      },
+      "args": {}
+    },
     "asset:list": {
       "id": "asset:list",
       "description": "Shows the list of assets in a given enterprise.",
@@ -4653,6 +4741,12 @@
             "environment"
           ]
         },
+        "private": {
+          "name": "private",
+          "type": "boolean",
+          "description": "Declares that this domain mapping is for internal use and not available from the internet.",
+          "allowNo": false
+        },
         "noninteractive": {
           "name": "noninteractive",
           "type": "boolean",
@@ -5848,6 +5942,212 @@
         }
       }
     },
+    "asset:entrypoint:delete": {
+      "id": "asset:entrypoint:delete",
+      "description": "Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Interactive",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Interactive, preset for the a specific asset.",
+          "command": "<%= config.bin %> <%= command.id %> -a my-api"
+        },
+        {
+          "description": "Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.",
+          "command": "<%= config.bin %> <%= command.id %> -e ml -a my-worker"
+        },
+        {
+          "description": "Non-interactive, removal by specifying the version range with an explicit match",
+          "command": "<%= config.bin %> <%= command.id %> -e ml -a my-worker -v '>=1.2.3' --silent"
+        }
+      ],
+      "flags": {
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "char": "e",
+          "description": "The name of the enterprise in which this asset resides (defaults to the current enterprise context).",
+          "required": false,
+          "multiple": false
+        },
+        "asset": {
+          "name": "asset",
+          "type": "option",
+          "char": "a",
+          "description": "The name of the asset to adjust.",
+          "required": false,
+          "multiple": false
+        },
+        "version-range": {
+          "name": "version-range",
+          "type": "option",
+          "char": "v",
+          "description": "(optional, defaults to the entrypoint assigned to \"any\" version) Used to identify the entrypoint.  The semantic version rule describing which versions of the asset will get this entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in quotes if it has any spaces in it.",
+          "required": false,
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "dependsOn": [
+            "asset"
+          ],
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        }
+      },
+      "args": {}
+    },
+    "asset:entrypoint:set": {
+      "id": "asset:entrypoint:set",
+      "description": "Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).",
+      "strict": true,
+      "pluginName": "@codiac.io/codiac-cli",
+      "pluginAlias": "@codiac.io/codiac-cli",
+      "pluginType": "core",
+      "aliases": [
+        "asset:entrypoint"
+      ],
+      "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Interactive",
+          "command": "<%= config.bin %> <%= command.id %>"
+        },
+        {
+          "description": "Interactive, preset for the a specific asset.",
+          "command": "<%= config.bin %> <%= command.id %> -a my-api"
+        },
+        {
+          "description": "Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.",
+          "command": "<%= config.bin %> <%= command.id %> -e ml -a my-worker"
+        },
+        {
+          "description": "Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and once complete, the image shuts down)",
+          "command": "<%= config.bin %> <%= command.id %> -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'"
+        },
+        {
+          "description": "Same as above but non-interactive (for use in scripts and pipelines)",
+          "command": "<%= config.bin %> <%= command.id %> --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'"
+        }
+      ],
+      "flags": {
+        "enterprise": {
+          "name": "enterprise",
+          "type": "option",
+          "char": "e",
+          "description": "The name of the enterprise in which this asset resides. (defaults to the current enterprise context).  NOTE: The enterprise assignment for an asset is immutable and cannot be modified; this flag is used only for identifying the asset.",
+          "required": false,
+          "multiple": false
+        },
+        "asset": {
+          "name": "asset",
+          "type": "option",
+          "char": "a",
+          "description": "The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified; this flag is used only for identifying the asset.",
+          "required": false,
+          "multiple": false
+        },
+        "workdir": {
+          "name": "workdir",
+          "type": "option",
+          "char": "d",
+          "description": "(optional) Folder path within the image from which to execute the command. Overrides the default working directory specified by the container image.",
+          "required": false,
+          "multiple": false
+        },
+        "command": {
+          "name": "command",
+          "type": "option",
+          "char": "c",
+          "description": "The command to run.  Not executed within a shell.",
+          "required": false,
+          "multiple": false
+        },
+        "arg": {
+          "name": "arg",
+          "type": "option",
+          "char": "c",
+          "description": "Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell, allowing this to be the command to run inside the shell,       eg: `--command=\"/bin/sh\" --arg=\"-c ls -a\"` which yields: `/bin/sh -c ls -a`",
+          "required": false,
+          "multiple": true
+        },
+        "version-range": {
+          "name": "version-range",
+          "type": "option",
+          "char": "v",
+          "description": "(optional) The semantic version rule describing which versions of the asset will get this entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in quotes if it has any spaces in it.",
+          "required": false,
+          "multiple": false
+        },
+        "silent": {
+          "name": "silent",
+          "type": "boolean",
+          "description": "Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "dependsOn": [
+            "asset"
+          ],
+          "exclusive": [
+            "echo",
+            "to-script"
+          ]
+        },
+        "echo": {
+          "name": "echo",
+          "type": "boolean",
+          "description": "Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        }
+      },
+      "args": {}
+    },
     "asset:probe:create": {
       "id": "asset:probe:create",
       "description": "Declares the implementation of a health or readiness probe for an asset.",
@@ -8516,6 +8816,28 @@
         "cluster:create"
       ],
       "hiddenAliases": [],
+      "examples": [
+        {
+          "description": "Create a cluster interativley.",
+          "command": "cod cluster create my-cluster"
+        },
+        {
+          "description": "Create a cluster interativley and assemble a non-interactive command string.",
+          "command": "cod cluster create my-cluster --echo"
+        },
+        {
+          "description": "Assemble a non-interactive command string WITHOUT actually creating a cluster (dry run).",
+          "command": "cod cluster create my-cluster --to-script"
+        },
+        {
+          "description": "Create a cluster silently.",
+          "command": "cod cluster create my-cluster --provider azure --providerSubscription 12345678-1234-1234-1234-123456789012 --resourceGroup my-rg --location eastus --nodeSpec Standard_DS2_v2 --nodeQty 2 --silent"
+        },
+        {
+          "description": "Create a cluster silently with all available options",
+          "command": "cod cluster create my-comprehensive-cluster --provider azure --providerSubscription 12345678-1234-1234-1234-123456789012 --resourceGroup my-resource-group --location eastus2 --nodeSpec Standard_D2s_v3 --nodeQty 3 --k8sVersion 1.21.2 --nodesMin 2 --nodesMax 5 --owner my-tenant-code --subnet /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/my-vnet-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet --identityUserName my-service-principal --identityUserId 87654321-4321-4321-4321-210987654321 --identityUserPassword mySecurePassword123! --silent"
+        }
+      ],
       "flags": {
         "help": {
           "name": "help",
@@ -8524,19 +8846,10 @@
           "description": "Show CLI help.",
           "allowNo": false
         },
-        "owner": {
-          "name": "owner",
-          "type": "option",
-          "char": "p",
-          "description": "Tenant code of the private owner of the cluster",
-          "required": false,
-          "multiple": false
-        },
         "provider": {
           "name": "provider",
           "type": "option",
-          "description": "Cloud service provider on which to provision the cluster",
-          "required": false,
+          "description": "(Required in silent mode) Cloud service provider on which to provision the cluster",
           "multiple": false,
           "options": [
             "azure",
@@ -8547,32 +8860,42 @@
           "name": "providerSubscription",
           "type": "option",
           "char": "s",
-          "description": "The Azure subscription Id under which to create the cluster.",
-          "required": false,
+          "description": "(Required in silent mode) The Azure subscription Id under which to create the cluster.",
           "multiple": false
         },
         "resourceGroup": {
           "name": "resourceGroup",
           "type": "option",
           "char": "g",
-          "description": "The Azure resource group to create for the cluster.",
-          "required": false,
+          "description": "(Required in silent mode) The Azure resource group to create for the cluster.",
           "multiple": false
         },
         "location": {
           "name": "location",
           "type": "option",
           "char": "l",
-          "description": "The short name of the azure data center in which the cliuster is to reside.",
-          "required": false,
+          "description": "(Required in silent mode) The short name of the azure data center in which the cluster is to reside.",
+          "multiple": false
+        },
+        "nodeQty": {
+          "name": "nodeQty",
+          "type": "option",
+          "char": "q",
+          "description": "(Required in silent mode) The starting node count with which to create the cluster.",
+          "multiple": false,
+          "default": 2
+        },
+        "k8sVersion": {
+          "name": "k8sVersion",
+          "type": "option",
+          "description": "(Required in silent mode) The version of Kubernetes to install on the cluster.",
           "multiple": false
         },
         "subnet": {
           "name": "subnet",
           "type": "option",
           "char": "k",
-          "description": "The resource id of the subnet in which the cluster is to be created.",
-          "required": false,
+          "description": "OPTIONAL: The resource id of the subnet in which the cluster is to be created.",
           "multiple": false
         },
         "nodeSpec": {
@@ -8580,65 +8903,93 @@
           "type": "option",
           "char": "n",
           "description": "The identifier for the type of VM to use for nodes in the cluster.",
-          "required": false,
           "multiple": false
         },
-        "nodeQty": {
-          "name": "nodeQty",
-          "type": "option",
-          "char": "q",
-          "description": "The starting node count with which to create the cluster.",
-          "required": false,
-          "multiple": false,
-          "default": 2
-        },
         "identityUserName": {
           "name": "identityUserName",
           "type": "option",
           "char": "u",
-          "description": "OPTIONAL. Name of Svc Principal or Managed Identity to execute as. To create k8s cluster, IP address, and container Pull.  If none supplied Codiac will try to create one.",
-          "required": false,
+          "description": "OPTIONAL. Name of Svc Principal or Managed Identity to execute as.",
           "multiple": false
         },
         "identityUserId": {
           "name": "identityUserId",
           "type": "option",
-          "char": "u",
-          "description": "OPTIONAL. ID of Svc Principal or Managed Identity to execute as. To create k8s cluster, IP address, and container Pull.  If none supplied Codiac will try to create one.",
-          "required": false,
+          "description": "OPTIONAL. ID of Svc Principal or Managed Identity to execute as.",
           "multiple": false
         },
         "identityUserPassword": {
           "name": "identityUserPassword",
           "type": "option",
           "char": "c",
-          "description": "OPTIONAL. Password of Svc Principal or Managed Identity to execute as. To create k8s cluster, IP address, and container Pull.  If none supplied Codiac will try to create one.",
+          "description": "OPTIONAL. Password of Svc Principal or Managed Identity to execute as.",
           "hidden": true,
-          "required": false,
+          "multiple": false
+        },
+        "nodesMin": {
+          "name": "nodesMin",
+          "type": "option",
+          "description": "OPTIONAL. The minimum number of nodes to maintain in the cluster.",
+          "multiple": false
+        },
+        "nodesMax": {
+          "name": "nodesMax",
+          "type": "option",
+          "description": "OPTIONAL. The maximum number of nodes to maintain in the cluster.",
           "multiple": false
         },
         "silent": {
           "name": "silent",
-          "type": "option",
-          "char": "y",
-          "description": "(Optional: defaults to false) Prevents confirmations of user-values. Required: providerSubscription,resourceGroup,location,nodeSpec,nodeQty",
-          "required": false,
-          "multiple": false,
-          "dependsOn": [
-            "providerSubscription",
-            "resourceGroup",
-            "location",
-            "nodeSpec",
-            "nodeQty"
+          "type": "boolean",
+          "description": "Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.",
+          "allowNo": false,
+          "relationships": [
+            {
+              "type": "all",
+              "flags": [
+                "k8sVersion",
+                "provider",
+                "providerSubscription",
+                "location",
+                "nodeSpec",
+                "nodeQty",
+                "resourceGroup"
+              ]
+            }
+          ],
+          "exclusive": [
+            "echo",
+            "to-script"
           ]
         },
-        "toScript": {
-          "name": "toScript",
+        "echo": {
+          "name": "echo",
           "type": "boolean",
-          "char": "t",
-          "description": "Outputs an assembled command string, NO execution",
-          "required": false,
-          "allowNo": false
+          "description": "Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.",
+          "allowNo": false,
+          "exclusive": [
+            "to-script",
+            "silent"
+          ]
+        },
+        "to-script": {
+          "name": "to-script",
+          "type": "boolean",
+          "description": "Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.",
+          "allowNo": false,
+          "exclusive": [
+            "echo",
+            "silent"
+          ]
+        },
+        "take-defaults": {
+          "name": "take-defaults",
+          "type": "boolean",
+          "description": "Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set to default values (Irrelevant in --silent mode).",
+          "allowNo": false,
+          "exclusive": [
+            "silent"
+          ]
         }
       },
       "args": {
@@ -8646,14 +8997,7 @@
           "name": "name",
           "description": "Proposed name of the cluster"
         }
-      },
-      "dependsOn": [
-        "providerSubscription",
-        "resourceGroup",
-        "location",
-        "nodeSpec",
-        "nodeQty"
-      ]
+      }
     },
     "noc:cluster:deinit": {
       "id": "noc:cluster:deinit",
@@ -8709,12 +9053,7 @@
           ]
         }
       },
-      "args": {
-        "name": {
-          "name": "name",
-          "description": "Name of existing cluster."
-        }
-      }
+      "args": {}
     },
     "noc:cluster:destroy": {
       "id": "noc:cluster:destroy",

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.62",
+  "description": "Local command line interface for managing enterprise assets and environments. ",
+  "version": "1.3.64",
   "author": "Codiac",
   "bin": {
     "codiac": "./bin/run",
@@ -30,7 +30,7 @@
     "@codiac.io/api-client-base": "^1.1.15",
     "@codiac.io/cli-tools": "^1.1.10",
     "@codiac.io/codiac-common": "^1.3.3",
-    "@codiac.io/codiac-domain": "^1.6.6",
+    "@codiac.io/codiac-domain": "^1.6.7",
     "@codiac.io/codiac-ops-common": "^1.2.1",
     "@codiac.io/codiac-relay-contracts": "^1.2.23",
     "@codiac.io/jwt-lib": "^1.1.6",