@codiac.io/codiac-cli 1.3.202 → 1.3.204
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +569 -164
- package/dist/apis/codiac-api/gen/contracts/types.gen.d.ts +2 -0
- package/dist/apis/codiac-relay/gen/client.d.ts +8 -6
- package/dist/apis/codiac-relay/gen/client.js +14 -8
- package/dist/apis/codiac-relay/gen/client.js.map +1 -1
- package/dist/apis/codiac-relay/gen/contracts/types.gen.d.ts +17 -13
- package/dist/apis/codiac-relay/gen/contracts/types.gen.js.map +1 -1
- package/dist/apis/codiac-relay/i-client.d.ts +6 -0
- package/dist/apis/codiac-relay-nats/gen/client.d.ts +6 -4
- package/dist/apis/codiac-relay-nats/gen/client.js +18 -11
- package/dist/apis/codiac-relay-nats/gen/client.js.map +1 -1
- package/dist/apis/codiac-relay-nats/gen/contracts/types.gen.d.ts +17 -13
- package/dist/apis/codiac-relay-nats/gen/contracts/types.gen.js.map +1 -1
- package/dist/commands/asset/deploy.js +3 -3
- package/dist/commands/asset/deploy.js.map +1 -1
- package/dist/commands/cabinet/cluster/attach.d.ts +2 -0
- package/dist/commands/cabinet/cluster/attach.js +36 -29
- package/dist/commands/cabinet/cluster/attach.js.map +1 -1
- package/dist/commands/cabinet/destroy.js +1 -1
- package/dist/commands/cabinet/destroy.js.map +1 -1
- package/dist/commands/cabinet/detach.js +1 -1
- package/dist/commands/cabinet/detach.js.map +1 -1
- package/dist/commands/cabinet/forget.js +1 -1
- package/dist/commands/cabinet/forget.js.map +1 -1
- package/dist/commands/cabinet/restore.js +2 -12
- package/dist/commands/cabinet/restore.js.map +1 -1
- package/dist/commands/cluster/agent/configure.d.ts +3 -3
- package/dist/commands/cluster/agent/configure.js +3 -3
- package/dist/commands/cluster/agent/configure.js.map +1 -1
- package/dist/commands/cluster/agent/install.d.ts +2 -1
- package/dist/commands/cluster/agent/install.js +35 -6
- package/dist/commands/cluster/agent/install.js.map +1 -1
- package/dist/commands/cluster/agent/uninstall.d.ts +1 -1
- package/dist/commands/cluster/agent/uninstall.js +2 -2
- package/dist/commands/cluster/agent/uninstall.js.map +1 -1
- package/dist/commands/config/add.js +3 -0
- package/dist/commands/config/add.js.map +1 -1
- package/dist/commands/host/map.js +1 -0
- package/dist/commands/host/map.js.map +1 -1
- package/dist/commands/noc/cluster/define.js +5 -1
- package/dist/commands/noc/cluster/define.js.map +1 -1
- package/dist/relay/relay-container.js +1 -1
- package/dist/uilogic/rootmap-ui-utils.d.ts +3 -1
- package/dist/uilogic/rootmap-ui-utils.js +23 -3
- package/dist/uilogic/rootmap-ui-utils.js.map +1 -1
- package/oclif.manifest.json +45 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ $ npm install -g @codiac.io/codiac-cli
|
|
|
21
21
|
$ codiac COMMAND
|
|
22
22
|
running command...
|
|
23
23
|
$ codiac (--version|-v)
|
|
24
|
-
@codiac.io/codiac-cli/1.3.
|
|
24
|
+
@codiac.io/codiac-cli/1.3.204 linux-x64 node-v22.15.1
|
|
25
25
|
$ codiac --help [COMMAND]
|
|
26
26
|
USAGE
|
|
27
27
|
$ codiac COMMAND
|
|
@@ -256,6 +256,7 @@ USAGE
|
|
|
256
256
|
* [`codiac branches current`](#codiac-branches-current)
|
|
257
257
|
* [`codiac branches list`](#codiac-branches-list)
|
|
258
258
|
* [`codiac build`](#codiac-build)
|
|
259
|
+
* [`codiac cab attach`](#codiac-cab-attach)
|
|
259
260
|
* [`codiac cab cluster attach`](#codiac-cab-cluster-attach)
|
|
260
261
|
* [`codiac cab contents`](#codiac-cab-contents)
|
|
261
262
|
* [`codiac cab create [CABINET]`](#codiac-cab-create-cabinet)
|
|
@@ -266,6 +267,7 @@ USAGE
|
|
|
266
267
|
* [`codiac cab list`](#codiac-cab-list)
|
|
267
268
|
* [`codiac cab obliterate [CABINET]`](#codiac-cab-obliterate-cabinet)
|
|
268
269
|
* [`codiac cab restore`](#codiac-cab-restore)
|
|
270
|
+
* [`codiac cabinet attach`](#codiac-cabinet-attach)
|
|
269
271
|
* [`codiac cabinet cluster attach`](#codiac-cabinet-cluster-attach)
|
|
270
272
|
* [`codiac cabinet contents`](#codiac-cabinet-contents)
|
|
271
273
|
* [`codiac cabinet create [CABINET]`](#codiac-cabinet-create-cabinet)
|
|
@@ -292,6 +294,9 @@ USAGE
|
|
|
292
294
|
* [`codiac cluster define [NAME]`](#codiac-cluster-define-name)
|
|
293
295
|
* [`codiac cluster deinit`](#codiac-cluster-deinit)
|
|
294
296
|
* [`codiac cluster destroy [NAME]`](#codiac-cluster-destroy-name)
|
|
297
|
+
* [`codiac cluster envoy configure [CLUSTER]`](#codiac-cluster-envoy-configure-cluster)
|
|
298
|
+
* [`codiac cluster envoy install [CLUSTER]`](#codiac-cluster-envoy-install-cluster)
|
|
299
|
+
* [`codiac cluster envoy uninstall [CLUSTER]`](#codiac-cluster-envoy-uninstall-cluster)
|
|
295
300
|
* [`codiac cluster forget`](#codiac-cluster-forget)
|
|
296
301
|
* [`codiac cluster grant`](#codiac-cluster-grant)
|
|
297
302
|
* [`codiac cluster init`](#codiac-cluster-init)
|
|
@@ -575,7 +580,7 @@ EXAMPLES
|
|
|
575
580
|
$ codiac asset create -e myEnterprise -n my-api --deploy-condition "environment.name = 'production'"
|
|
576
581
|
```
|
|
577
582
|
|
|
578
|
-
_See code: [src/commands/asset/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
583
|
+
_See code: [src/commands/asset/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/create.ts)_
|
|
579
584
|
|
|
580
585
|
## `codiac asset edit`
|
|
581
586
|
|
|
@@ -633,7 +638,7 @@ EXAMPLES
|
|
|
633
638
|
$ codiac asset edit -e myEnterprise -n my-api --remove-deploy-condition --silent
|
|
634
639
|
```
|
|
635
640
|
|
|
636
|
-
_See code: [src/commands/asset/edit.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
641
|
+
_See code: [src/commands/asset/edit.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/edit.ts)_
|
|
637
642
|
|
|
638
643
|
## `codiac asset entrypoint`
|
|
639
644
|
|
|
@@ -754,7 +759,7 @@ EXAMPLES
|
|
|
754
759
|
$ codiac asset entrypoint delete -e ml -a my-worker -v '>=1.2.3' --silent
|
|
755
760
|
```
|
|
756
761
|
|
|
757
|
-
_See code: [src/commands/asset/entrypoint/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
762
|
+
_See code: [src/commands/asset/entrypoint/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/entrypoint/delete.ts)_
|
|
758
763
|
|
|
759
764
|
## `codiac asset entrypoint set`
|
|
760
765
|
|
|
@@ -823,7 +828,7 @@ EXAMPLES
|
|
|
823
828
|
--input=/backup/workflows'
|
|
824
829
|
```
|
|
825
830
|
|
|
826
|
-
_See code: [src/commands/asset/entrypoint/set.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
831
|
+
_See code: [src/commands/asset/entrypoint/set.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/entrypoint/set.ts)_
|
|
827
832
|
|
|
828
833
|
## `codiac asset get [CMD]`
|
|
829
834
|
|
|
@@ -930,7 +935,7 @@ EXAMPLES
|
|
|
930
935
|
$ codiac asset list -e myEnterprise --to-script
|
|
931
936
|
```
|
|
932
937
|
|
|
933
|
-
_See code: [src/commands/asset/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
938
|
+
_See code: [src/commands/asset/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/list.ts)_
|
|
934
939
|
|
|
935
940
|
## `codiac asset mon [CMD]`
|
|
936
941
|
|
|
@@ -1177,7 +1182,7 @@ EXAMPLES
|
|
|
1177
1182
|
$ codiac asset obliterate -e main -n my-api
|
|
1178
1183
|
```
|
|
1179
1184
|
|
|
1180
|
-
_See code: [src/commands/asset/obliterate.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1185
|
+
_See code: [src/commands/asset/obliterate.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/obliterate.ts)_
|
|
1181
1186
|
|
|
1182
1187
|
## `codiac asset probe create [CMD]`
|
|
1183
1188
|
|
|
@@ -1267,7 +1272,7 @@ EXAMPLES
|
|
|
1267
1272
|
$ codiac asset probe create -n acme -a myapi --predefined builtin-heartbeat-file-exists --to-script
|
|
1268
1273
|
```
|
|
1269
1274
|
|
|
1270
|
-
_See code: [src/commands/asset/probe/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1275
|
+
_See code: [src/commands/asset/probe/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/probe/create.ts)_
|
|
1271
1276
|
|
|
1272
1277
|
## `codiac asset probe delete`
|
|
1273
1278
|
|
|
@@ -1322,7 +1327,7 @@ EXAMPLES
|
|
|
1322
1327
|
$ codiac asset probe delete
|
|
1323
1328
|
```
|
|
1324
1329
|
|
|
1325
|
-
_See code: [src/commands/asset/probe/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1330
|
+
_See code: [src/commands/asset/probe/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/probe/delete.ts)_
|
|
1326
1331
|
|
|
1327
1332
|
## `codiac asset probe list`
|
|
1328
1333
|
|
|
@@ -1374,7 +1379,7 @@ EXAMPLES
|
|
|
1374
1379
|
$ codiac asset probe list
|
|
1375
1380
|
```
|
|
1376
1381
|
|
|
1377
|
-
_See code: [src/commands/asset/probe/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1382
|
+
_See code: [src/commands/asset/probe/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/probe/list.ts)_
|
|
1378
1383
|
|
|
1379
1384
|
## `codiac asset recycle`
|
|
1380
1385
|
|
|
@@ -1414,7 +1419,7 @@ DESCRIPTION
|
|
|
1414
1419
|
Deploys a given asset to a given cabinet. Defaults to current version.
|
|
1415
1420
|
```
|
|
1416
1421
|
|
|
1417
|
-
_See code: [src/commands/asset/recycle.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1422
|
+
_See code: [src/commands/asset/recycle.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/recycle.ts)_
|
|
1418
1423
|
|
|
1419
1424
|
## `codiac asset undeploy`
|
|
1420
1425
|
|
|
@@ -1458,7 +1463,7 @@ EXAMPLES
|
|
|
1458
1463
|
$ codiac asset undeploy -e myEnterprise -a myApi -c dev --to-script
|
|
1459
1464
|
```
|
|
1460
1465
|
|
|
1461
|
-
_See code: [src/commands/asset/undeploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1466
|
+
_See code: [src/commands/asset/undeploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/undeploy.ts)_
|
|
1462
1467
|
|
|
1463
1468
|
## `codiac asset view [CMD]`
|
|
1464
1469
|
|
|
@@ -1513,7 +1518,7 @@ ALIASES
|
|
|
1513
1518
|
$ codiac asset get
|
|
1514
1519
|
```
|
|
1515
1520
|
|
|
1516
|
-
_See code: [src/commands/asset/view.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1521
|
+
_See code: [src/commands/asset/view.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/view.ts)_
|
|
1517
1522
|
|
|
1518
1523
|
## `codiac asset vol add [MOUNTPATH]`
|
|
1519
1524
|
|
|
@@ -1784,7 +1789,7 @@ ALIASES
|
|
|
1784
1789
|
$ codiac asset volume add
|
|
1785
1790
|
```
|
|
1786
1791
|
|
|
1787
|
-
_See code: [src/commands/asset/volume/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1792
|
+
_See code: [src/commands/asset/volume/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/volume/create.ts)_
|
|
1788
1793
|
|
|
1789
1794
|
## `codiac asset volume del`
|
|
1790
1795
|
|
|
@@ -1872,7 +1877,7 @@ EXAMPLES
|
|
|
1872
1877
|
$ codiac asset volume delete -e myEnterprise -n myMount --to-script
|
|
1873
1878
|
```
|
|
1874
1879
|
|
|
1875
|
-
_See code: [src/commands/asset/volume/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1880
|
+
_See code: [src/commands/asset/volume/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/volume/delete.ts)_
|
|
1876
1881
|
|
|
1877
1882
|
## `codiac asset volume list`
|
|
1878
1883
|
|
|
@@ -1921,7 +1926,7 @@ EXAMPLES
|
|
|
1921
1926
|
$ codiac asset volume list -e myEnterprise --silent
|
|
1922
1927
|
```
|
|
1923
1928
|
|
|
1924
|
-
_See code: [src/commands/asset/volume/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
1929
|
+
_See code: [src/commands/asset/volume/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/volume/list.ts)_
|
|
1925
1930
|
|
|
1926
1931
|
## `codiac asset volumes del`
|
|
1927
1932
|
|
|
@@ -2088,7 +2093,7 @@ EXAMPLES
|
|
|
2088
2093
|
$ codiac asset where -e main -a my-api --silent
|
|
2089
2094
|
```
|
|
2090
2095
|
|
|
2091
|
-
_See code: [src/commands/asset/where.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2096
|
+
_See code: [src/commands/asset/where.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/asset/where.ts)_
|
|
2092
2097
|
|
|
2093
2098
|
## `codiac auth cab allow`
|
|
2094
2099
|
|
|
@@ -2250,7 +2255,7 @@ EXAMPLES
|
|
|
2250
2255
|
$ codiac auth cabinet allow -e qa -c shasta -r productmanager -p read
|
|
2251
2256
|
```
|
|
2252
2257
|
|
|
2253
|
-
_See code: [src/commands/auth/cabinet/allow.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2258
|
+
_See code: [src/commands/auth/cabinet/allow.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/cabinet/allow.ts)_
|
|
2254
2259
|
|
|
2255
2260
|
## `codiac auth cabinet allowed`
|
|
2256
2261
|
|
|
@@ -2298,7 +2303,7 @@ EXAMPLES
|
|
|
2298
2303
|
$ codiac auth cabinet allowed --enterprise modeling -e qa -c sprint5
|
|
2299
2304
|
```
|
|
2300
2305
|
|
|
2301
|
-
_See code: [src/commands/auth/cabinet/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2306
|
+
_See code: [src/commands/auth/cabinet/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/cabinet/allowed.ts)_
|
|
2302
2307
|
|
|
2303
2308
|
## `codiac auth ent allow`
|
|
2304
2309
|
|
|
@@ -2489,7 +2494,7 @@ EXAMPLES
|
|
|
2489
2494
|
$ codiac auth enterprise allow -r deployer -p none
|
|
2490
2495
|
```
|
|
2491
2496
|
|
|
2492
|
-
_See code: [src/commands/auth/enterprise/allow.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2497
|
+
_See code: [src/commands/auth/enterprise/allow.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/enterprise/allow.ts)_
|
|
2493
2498
|
|
|
2494
2499
|
## `codiac auth enterprise allow onEnvironments`
|
|
2495
2500
|
|
|
@@ -2543,7 +2548,7 @@ EXAMPLES
|
|
|
2543
2548
|
$ codiac auth enterprise allow onEnvironments --enterprise dyno -r productmanager -p read
|
|
2544
2549
|
```
|
|
2545
2550
|
|
|
2546
|
-
_See code: [src/commands/auth/enterprise/allow/onEnvironments.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2551
|
+
_See code: [src/commands/auth/enterprise/allow/onEnvironments.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/enterprise/allow/onEnvironments.ts)_
|
|
2547
2552
|
|
|
2548
2553
|
## `codiac auth enterprise allowed`
|
|
2549
2554
|
|
|
@@ -2584,7 +2589,7 @@ EXAMPLES
|
|
|
2584
2589
|
$ codiac auth enterprise allowed --enterprise modeling
|
|
2585
2590
|
```
|
|
2586
2591
|
|
|
2587
|
-
_See code: [src/commands/auth/enterprise/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2592
|
+
_See code: [src/commands/auth/enterprise/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/enterprise/allowed.ts)_
|
|
2588
2593
|
|
|
2589
2594
|
## `codiac auth env allowed`
|
|
2590
2595
|
|
|
@@ -2791,7 +2796,7 @@ EXAMPLES
|
|
|
2791
2796
|
$ codiac auth environment allow -e qa -r productmanager -p read
|
|
2792
2797
|
```
|
|
2793
2798
|
|
|
2794
|
-
_See code: [src/commands/auth/environment/allow.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2799
|
+
_See code: [src/commands/auth/environment/allow.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/environment/allow.ts)_
|
|
2795
2800
|
|
|
2796
2801
|
## `codiac auth environment allow onCabinets`
|
|
2797
2802
|
|
|
@@ -2848,7 +2853,7 @@ EXAMPLES
|
|
|
2848
2853
|
$ codiac auth environment allow onCabinets -e qa -r productmanager -p read
|
|
2849
2854
|
```
|
|
2850
2855
|
|
|
2851
|
-
_See code: [src/commands/auth/environment/allow/onCabinets.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2856
|
+
_See code: [src/commands/auth/environment/allow/onCabinets.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/environment/allow/onCabinets.ts)_
|
|
2852
2857
|
|
|
2853
2858
|
## `codiac auth environment allowed`
|
|
2854
2859
|
|
|
@@ -2893,7 +2898,7 @@ EXAMPLES
|
|
|
2893
2898
|
$ codiac auth environment allowed --enterprise modeling -e dev
|
|
2894
2899
|
```
|
|
2895
2900
|
|
|
2896
|
-
_See code: [src/commands/auth/environment/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2901
|
+
_See code: [src/commands/auth/environment/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/environment/allowed.ts)_
|
|
2897
2902
|
|
|
2898
2903
|
## `codiac auth register`
|
|
2899
2904
|
|
|
@@ -2939,7 +2944,7 @@ EXAMPLES
|
|
|
2939
2944
|
$ codiac auth register
|
|
2940
2945
|
```
|
|
2941
2946
|
|
|
2942
|
-
_See code: [src/commands/auth/register.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2947
|
+
_See code: [src/commands/auth/register.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/register.ts)_
|
|
2943
2948
|
|
|
2944
2949
|
## `codiac auth role allowed [NAME]`
|
|
2945
2950
|
|
|
@@ -2986,7 +2991,7 @@ EXAMPLES
|
|
|
2986
2991
|
$ codiac auth role allowed -n deployer -e main
|
|
2987
2992
|
```
|
|
2988
2993
|
|
|
2989
|
-
_See code: [src/commands/auth/role/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
2994
|
+
_See code: [src/commands/auth/role/allowed.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/role/allowed.ts)_
|
|
2990
2995
|
|
|
2991
2996
|
## `codiac auth role assign`
|
|
2992
2997
|
|
|
@@ -3018,7 +3023,7 @@ EXAMPLES
|
|
|
3018
3023
|
$ codiac auth role assign -r deployer -u joe.cool@yourdomain.com
|
|
3019
3024
|
```
|
|
3020
3025
|
|
|
3021
|
-
_See code: [src/commands/auth/role/assign.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3026
|
+
_See code: [src/commands/auth/role/assign.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/role/assign.ts)_
|
|
3022
3027
|
|
|
3023
3028
|
## `codiac auth role create [NAME]`
|
|
3024
3029
|
|
|
@@ -3051,7 +3056,7 @@ EXAMPLES
|
|
|
3051
3056
|
$ codiac auth role create -n deployer
|
|
3052
3057
|
```
|
|
3053
3058
|
|
|
3054
|
-
_See code: [src/commands/auth/role/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3059
|
+
_See code: [src/commands/auth/role/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/role/create.ts)_
|
|
3055
3060
|
|
|
3056
3061
|
## `codiac auth role delete [NAME]`
|
|
3057
3062
|
|
|
@@ -3087,7 +3092,7 @@ EXAMPLES
|
|
|
3087
3092
|
$ codiac auth role delete --id abc123def456
|
|
3088
3093
|
```
|
|
3089
3094
|
|
|
3090
|
-
_See code: [src/commands/auth/role/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3095
|
+
_See code: [src/commands/auth/role/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/role/delete.ts)_
|
|
3091
3096
|
|
|
3092
3097
|
## `codiac auth role list`
|
|
3093
3098
|
|
|
@@ -3123,7 +3128,7 @@ EXAMPLES
|
|
|
3123
3128
|
$ codiac auth role list -o yaml > roles.yaml
|
|
3124
3129
|
```
|
|
3125
3130
|
|
|
3126
|
-
_See code: [src/commands/auth/role/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3131
|
+
_See code: [src/commands/auth/role/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/role/list.ts)_
|
|
3127
3132
|
|
|
3128
3133
|
## `codiac auth role unassign`
|
|
3129
3134
|
|
|
@@ -3155,7 +3160,7 @@ EXAMPLES
|
|
|
3155
3160
|
$ codiac auth role unassign -r deployer -u joe.cool@yourdomain.com
|
|
3156
3161
|
```
|
|
3157
3162
|
|
|
3158
|
-
_See code: [src/commands/auth/role/unassign.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3163
|
+
_See code: [src/commands/auth/role/unassign.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/role/unassign.ts)_
|
|
3159
3164
|
|
|
3160
3165
|
## `codiac auth user invite`
|
|
3161
3166
|
|
|
@@ -3195,7 +3200,7 @@ EXAMPLES
|
|
|
3195
3200
|
$ codiac auth user invite
|
|
3196
3201
|
```
|
|
3197
3202
|
|
|
3198
|
-
_See code: [src/commands/auth/user/invite.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3203
|
+
_See code: [src/commands/auth/user/invite.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/user/invite.ts)_
|
|
3199
3204
|
|
|
3200
3205
|
## `codiac auth user list`
|
|
3201
3206
|
|
|
@@ -3231,7 +3236,7 @@ EXAMPLES
|
|
|
3231
3236
|
$ codiac auth user list -o yaml > users.yaml
|
|
3232
3237
|
```
|
|
3233
3238
|
|
|
3234
|
-
_See code: [src/commands/auth/user/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3239
|
+
_See code: [src/commands/auth/user/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/auth/user/list.ts)_
|
|
3235
3240
|
|
|
3236
3241
|
## `codiac autocomplete [SHELL]`
|
|
3237
3242
|
|
|
@@ -3281,7 +3286,7 @@ DESCRIPTION
|
|
|
3281
3286
|
Creates a new branch for the parent project and any sourced dependencies.
|
|
3282
3287
|
```
|
|
3283
3288
|
|
|
3284
|
-
_See code: [src/commands/branch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3289
|
+
_See code: [src/commands/branch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/branch.ts)_
|
|
3285
3290
|
|
|
3286
3291
|
## `codiac branch current`
|
|
3287
3292
|
|
|
@@ -3301,7 +3306,7 @@ ALIASES
|
|
|
3301
3306
|
$ codiac branches current
|
|
3302
3307
|
```
|
|
3303
3308
|
|
|
3304
|
-
_See code: [src/commands/branch/current.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3309
|
+
_See code: [src/commands/branch/current.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/branch/current.ts)_
|
|
3305
3310
|
|
|
3306
3311
|
## `codiac branch list`
|
|
3307
3312
|
|
|
@@ -3323,7 +3328,7 @@ ALIASES
|
|
|
3323
3328
|
$ codiac branches list
|
|
3324
3329
|
```
|
|
3325
3330
|
|
|
3326
|
-
_See code: [src/commands/branch/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3331
|
+
_See code: [src/commands/branch/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/branch/list.ts)_
|
|
3327
3332
|
|
|
3328
3333
|
## `codiac branches current`
|
|
3329
3334
|
|
|
@@ -3413,7 +3418,70 @@ DESCRIPTION
|
|
|
3413
3418
|
Builds the project and the docker container
|
|
3414
3419
|
```
|
|
3415
3420
|
|
|
3416
|
-
_See code: [src/commands/build.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
3421
|
+
_See code: [src/commands/build.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/build.ts)_
|
|
3422
|
+
|
|
3423
|
+
## `codiac cab attach`
|
|
3424
|
+
|
|
3425
|
+
Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and deploy operations know where to target the cabinet. No infrastructure is created or modified.
|
|
3426
|
+
|
|
3427
|
+
```
|
|
3428
|
+
USAGE
|
|
3429
|
+
$ codiac cab attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--force] [--take-defaults | [--silent
|
|
3430
|
+
| --echo | --to-script]]
|
|
3431
|
+
|
|
3432
|
+
FLAGS
|
|
3433
|
+
-b, --cabinet=<value> Name of the cabinet to attach.
|
|
3434
|
+
-c, --cluster=<value> Name of the cluster to attach the cabinet to.
|
|
3435
|
+
-e, --enterprise=<value> The name of the enterprise in which the cabinet resides. NOTE: You can leave this blank if
|
|
3436
|
+
there is only one.
|
|
3437
|
+
-n, --environment=<value> Name of the environment the cabinet belongs to.
|
|
3438
|
+
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use
|
|
3439
|
+
before final execution.
|
|
3440
|
+
--force Automatically attaches the cluster to the cabinet's environment first if it isn't already
|
|
3441
|
+
attached there.
|
|
3442
|
+
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or
|
|
3443
|
+
invalid arguments.
|
|
3444
|
+
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically
|
|
3445
|
+
set to default values (Irrelevant in --silent mode).
|
|
3446
|
+
--to-script Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
|
|
3447
|
+
execution.
|
|
3448
|
+
|
|
3449
|
+
DESCRIPTION
|
|
3450
|
+
Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and
|
|
3451
|
+
deploy operations know where to target the cabinet. No infrastructure is created or modified.
|
|
3452
|
+
|
|
3453
|
+
ALIASES
|
|
3454
|
+
$ codiac cab cluster attach
|
|
3455
|
+
$ codiac cabinet attach
|
|
3456
|
+
$ codiac cab attach
|
|
3457
|
+
|
|
3458
|
+
EXAMPLES
|
|
3459
|
+
Attach a cabinet to a cluster interactively.
|
|
3460
|
+
|
|
3461
|
+
$ codiac cab attach
|
|
3462
|
+
|
|
3463
|
+
Attach a specific cabinet to a cluster (prompts for missing values).
|
|
3464
|
+
|
|
3465
|
+
$ codiac cab attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1
|
|
3466
|
+
|
|
3467
|
+
Non-interactive (scripted) invocation — fails fast on any missing argument.
|
|
3468
|
+
|
|
3469
|
+
$ codiac cab attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 --silent
|
|
3470
|
+
|
|
3471
|
+
Attach a cabinet to a cluster that is not yet in its environment, attaching the cluster to the environment
|
|
3472
|
+
automatically.
|
|
3473
|
+
|
|
3474
|
+
$ codiac cab attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 --force
|
|
3475
|
+
|
|
3476
|
+
Renders the equivalent silent command and then executes (useful for building scripts).
|
|
3477
|
+
|
|
3478
|
+
$ codiac cab attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 --echo
|
|
3479
|
+
|
|
3480
|
+
Renders the equivalent silent command without executing (dry run).
|
|
3481
|
+
|
|
3482
|
+
$ codiac cab attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
3483
|
+
--to-script
|
|
3484
|
+
```
|
|
3417
3485
|
|
|
3418
3486
|
## `codiac cab cluster attach`
|
|
3419
3487
|
|
|
@@ -3421,8 +3489,8 @@ Declares which cluster a cabinet is intended to run on. Records the association
|
|
|
3421
3489
|
|
|
3422
3490
|
```
|
|
3423
3491
|
USAGE
|
|
3424
|
-
$ codiac cab cluster attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent
|
|
3425
|
-
| --to-script]]
|
|
3492
|
+
$ codiac cab cluster attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--force] [--take-defaults | [--silent
|
|
3493
|
+
| --echo | --to-script]]
|
|
3426
3494
|
|
|
3427
3495
|
FLAGS
|
|
3428
3496
|
-b, --cabinet=<value> Name of the cabinet to attach.
|
|
@@ -3432,6 +3500,8 @@ FLAGS
|
|
|
3432
3500
|
-n, --environment=<value> Name of the environment the cabinet belongs to.
|
|
3433
3501
|
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use
|
|
3434
3502
|
before final execution.
|
|
3503
|
+
--force Automatically attaches the cluster to the cabinet's environment first if it isn't already
|
|
3504
|
+
attached there.
|
|
3435
3505
|
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or
|
|
3436
3506
|
invalid arguments.
|
|
3437
3507
|
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically
|
|
@@ -3445,6 +3515,8 @@ DESCRIPTION
|
|
|
3445
3515
|
|
|
3446
3516
|
ALIASES
|
|
3447
3517
|
$ codiac cab cluster attach
|
|
3518
|
+
$ codiac cabinet attach
|
|
3519
|
+
$ codiac cab attach
|
|
3448
3520
|
|
|
3449
3521
|
EXAMPLES
|
|
3450
3522
|
Attach a cabinet to a cluster interactively.
|
|
@@ -3460,6 +3532,12 @@ EXAMPLES
|
|
|
3460
3532
|
$ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
3461
3533
|
--silent
|
|
3462
3534
|
|
|
3535
|
+
Attach a cabinet to a cluster that is not yet in its environment, attaching the cluster to the environment
|
|
3536
|
+
automatically.
|
|
3537
|
+
|
|
3538
|
+
$ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
3539
|
+
--force
|
|
3540
|
+
|
|
3463
3541
|
Renders the equivalent silent command and then executes (useful for building scripts).
|
|
3464
3542
|
|
|
3465
3543
|
$ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
@@ -3956,14 +4034,80 @@ EXAMPLES
|
|
|
3956
4034
|
$ codiac cab restore --cluster prod-cluster-1 --to-script
|
|
3957
4035
|
```
|
|
3958
4036
|
|
|
4037
|
+
## `codiac cabinet attach`
|
|
4038
|
+
|
|
4039
|
+
Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and deploy operations know where to target the cabinet. No infrastructure is created or modified.
|
|
4040
|
+
|
|
4041
|
+
```
|
|
4042
|
+
USAGE
|
|
4043
|
+
$ codiac cabinet attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--force] [--take-defaults | [--silent
|
|
4044
|
+
| --echo | --to-script]]
|
|
4045
|
+
|
|
4046
|
+
FLAGS
|
|
4047
|
+
-b, --cabinet=<value> Name of the cabinet to attach.
|
|
4048
|
+
-c, --cluster=<value> Name of the cluster to attach the cabinet to.
|
|
4049
|
+
-e, --enterprise=<value> The name of the enterprise in which the cabinet resides. NOTE: You can leave this blank if
|
|
4050
|
+
there is only one.
|
|
4051
|
+
-n, --environment=<value> Name of the environment the cabinet belongs to.
|
|
4052
|
+
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use
|
|
4053
|
+
before final execution.
|
|
4054
|
+
--force Automatically attaches the cluster to the cabinet's environment first if it isn't already
|
|
4055
|
+
attached there.
|
|
4056
|
+
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or
|
|
4057
|
+
invalid arguments.
|
|
4058
|
+
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically
|
|
4059
|
+
set to default values (Irrelevant in --silent mode).
|
|
4060
|
+
--to-script Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
|
|
4061
|
+
execution.
|
|
4062
|
+
|
|
4063
|
+
DESCRIPTION
|
|
4064
|
+
Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and
|
|
4065
|
+
deploy operations know where to target the cabinet. No infrastructure is created or modified.
|
|
4066
|
+
|
|
4067
|
+
ALIASES
|
|
4068
|
+
$ codiac cab cluster attach
|
|
4069
|
+
$ codiac cabinet attach
|
|
4070
|
+
$ codiac cab attach
|
|
4071
|
+
|
|
4072
|
+
EXAMPLES
|
|
4073
|
+
Attach a cabinet to a cluster interactively.
|
|
4074
|
+
|
|
4075
|
+
$ codiac cabinet attach
|
|
4076
|
+
|
|
4077
|
+
Attach a specific cabinet to a cluster (prompts for missing values).
|
|
4078
|
+
|
|
4079
|
+
$ codiac cabinet attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1
|
|
4080
|
+
|
|
4081
|
+
Non-interactive (scripted) invocation — fails fast on any missing argument.
|
|
4082
|
+
|
|
4083
|
+
$ codiac cabinet attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
4084
|
+
--silent
|
|
4085
|
+
|
|
4086
|
+
Attach a cabinet to a cluster that is not yet in its environment, attaching the cluster to the environment
|
|
4087
|
+
automatically.
|
|
4088
|
+
|
|
4089
|
+
$ codiac cabinet attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
4090
|
+
--force
|
|
4091
|
+
|
|
4092
|
+
Renders the equivalent silent command and then executes (useful for building scripts).
|
|
4093
|
+
|
|
4094
|
+
$ codiac cabinet attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
4095
|
+
--echo
|
|
4096
|
+
|
|
4097
|
+
Renders the equivalent silent command without executing (dry run).
|
|
4098
|
+
|
|
4099
|
+
$ codiac cabinet attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 \
|
|
4100
|
+
--to-script
|
|
4101
|
+
```
|
|
4102
|
+
|
|
3959
4103
|
## `codiac cabinet cluster attach`
|
|
3960
4104
|
|
|
3961
4105
|
Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and deploy operations know where to target the cabinet. No infrastructure is created or modified.
|
|
3962
4106
|
|
|
3963
4107
|
```
|
|
3964
4108
|
USAGE
|
|
3965
|
-
$ codiac cabinet cluster attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent
|
|
3966
|
-
| --to-script]]
|
|
4109
|
+
$ codiac cabinet cluster attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--force] [--take-defaults | [--silent
|
|
4110
|
+
| --echo | --to-script]]
|
|
3967
4111
|
|
|
3968
4112
|
FLAGS
|
|
3969
4113
|
-b, --cabinet=<value> Name of the cabinet to attach.
|
|
@@ -3973,6 +4117,8 @@ FLAGS
|
|
|
3973
4117
|
-n, --environment=<value> Name of the environment the cabinet belongs to.
|
|
3974
4118
|
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use
|
|
3975
4119
|
before final execution.
|
|
4120
|
+
--force Automatically attaches the cluster to the cabinet's environment first if it isn't already
|
|
4121
|
+
attached there.
|
|
3976
4122
|
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or
|
|
3977
4123
|
invalid arguments.
|
|
3978
4124
|
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically
|
|
@@ -3986,6 +4132,8 @@ DESCRIPTION
|
|
|
3986
4132
|
|
|
3987
4133
|
ALIASES
|
|
3988
4134
|
$ codiac cab cluster attach
|
|
4135
|
+
$ codiac cabinet attach
|
|
4136
|
+
$ codiac cab attach
|
|
3989
4137
|
|
|
3990
4138
|
EXAMPLES
|
|
3991
4139
|
Attach a cabinet to a cluster interactively.
|
|
@@ -4002,6 +4150,12 @@ EXAMPLES
|
|
|
4002
4150
|
$ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster \
|
|
4003
4151
|
prod-cluster-1 --silent
|
|
4004
4152
|
|
|
4153
|
+
Attach a cabinet to a cluster that is not yet in its environment, attaching the cluster to the environment
|
|
4154
|
+
automatically.
|
|
4155
|
+
|
|
4156
|
+
$ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster \
|
|
4157
|
+
prod-cluster-1 --force
|
|
4158
|
+
|
|
4005
4159
|
Renders the equivalent silent command and then executes (useful for building scripts).
|
|
4006
4160
|
|
|
4007
4161
|
$ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster \
|
|
@@ -4013,7 +4167,7 @@ EXAMPLES
|
|
|
4013
4167
|
prod-cluster-1 --to-script
|
|
4014
4168
|
```
|
|
4015
4169
|
|
|
4016
|
-
_See code: [src/commands/cabinet/cluster/attach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4170
|
+
_See code: [src/commands/cabinet/cluster/attach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/cluster/attach.ts)_
|
|
4017
4171
|
|
|
4018
4172
|
## `codiac cabinet contents`
|
|
4019
4173
|
|
|
@@ -4057,7 +4211,7 @@ EXAMPLES
|
|
|
4057
4211
|
$ codiac cabinet contents -e main -c my-spike --to-script > show-contents.sh
|
|
4058
4212
|
```
|
|
4059
4213
|
|
|
4060
|
-
_See code: [src/commands/cabinet/contents.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4214
|
+
_See code: [src/commands/cabinet/contents.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/contents.ts)_
|
|
4061
4215
|
|
|
4062
4216
|
## `codiac cabinet create [CABINET]`
|
|
4063
4217
|
|
|
@@ -4124,7 +4278,7 @@ EXAMPLES
|
|
|
4124
4278
|
cod cabinet create my-cab-name --enterprise main -e dev-environemt -c my-cluster --silent
|
|
4125
4279
|
```
|
|
4126
4280
|
|
|
4127
|
-
_See code: [src/commands/cabinet/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4281
|
+
_See code: [src/commands/cabinet/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/create.ts)_
|
|
4128
4282
|
|
|
4129
4283
|
## `codiac cabinet define [CABINET]`
|
|
4130
4284
|
|
|
@@ -4186,7 +4340,7 @@ EXAMPLES
|
|
|
4186
4340
|
$ codiac cabinet define my-cab --enterprise main --environment dev-environment --cluster my-cluster --silent
|
|
4187
4341
|
```
|
|
4188
4342
|
|
|
4189
|
-
_See code: [src/commands/cabinet/define.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4343
|
+
_See code: [src/commands/cabinet/define.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/define.ts)_
|
|
4190
4344
|
|
|
4191
4345
|
## `codiac cabinet destroy [CABINET]`
|
|
4192
4346
|
|
|
@@ -4244,7 +4398,7 @@ EXAMPLES
|
|
|
4244
4398
|
--environment dev --silent
|
|
4245
4399
|
```
|
|
4246
4400
|
|
|
4247
|
-
_See code: [src/commands/cabinet/destroy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4401
|
+
_See code: [src/commands/cabinet/destroy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/destroy.ts)_
|
|
4248
4402
|
|
|
4249
4403
|
## `codiac cabinet detach [CABINET]`
|
|
4250
4404
|
|
|
@@ -4301,7 +4455,7 @@ EXAMPLES
|
|
|
4301
4455
|
main --environment dev
|
|
4302
4456
|
```
|
|
4303
4457
|
|
|
4304
|
-
_See code: [src/commands/cabinet/detach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4458
|
+
_See code: [src/commands/cabinet/detach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/detach.ts)_
|
|
4305
4459
|
|
|
4306
4460
|
## `codiac cabinet forget [CABINET]`
|
|
4307
4461
|
|
|
@@ -4356,7 +4510,7 @@ EXAMPLES
|
|
|
4356
4510
|
$ codiac cabinet forget --to-script
|
|
4357
4511
|
```
|
|
4358
4512
|
|
|
4359
|
-
_See code: [src/commands/cabinet/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4513
|
+
_See code: [src/commands/cabinet/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/forget.ts)_
|
|
4360
4514
|
|
|
4361
4515
|
## `codiac cabinet list`
|
|
4362
4516
|
|
|
@@ -4407,7 +4561,7 @@ EXAMPLES
|
|
|
4407
4561
|
$ codiac cabinet list -e myEnterprise --silent
|
|
4408
4562
|
```
|
|
4409
4563
|
|
|
4410
|
-
_See code: [src/commands/cabinet/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4564
|
+
_See code: [src/commands/cabinet/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/list.ts)_
|
|
4411
4565
|
|
|
4412
4566
|
## `codiac cabinet obliterate [CABINET]`
|
|
4413
4567
|
|
|
@@ -4449,7 +4603,7 @@ ALIASES
|
|
|
4449
4603
|
$ codiac infrx cab obliterate
|
|
4450
4604
|
```
|
|
4451
4605
|
|
|
4452
|
-
_See code: [src/commands/cabinet/obliterate.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4606
|
+
_See code: [src/commands/cabinet/obliterate.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/obliterate.ts)_
|
|
4453
4607
|
|
|
4454
4608
|
## `codiac cabinet restore`
|
|
4455
4609
|
|
|
@@ -4516,7 +4670,7 @@ EXAMPLES
|
|
|
4516
4670
|
$ codiac cabinet restore --cluster prod-cluster-1 --to-script
|
|
4517
4671
|
```
|
|
4518
4672
|
|
|
4519
|
-
_See code: [src/commands/cabinet/restore.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4673
|
+
_See code: [src/commands/cabinet/restore.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cabinet/restore.ts)_
|
|
4520
4674
|
|
|
4521
4675
|
## `codiac cfg add`
|
|
4522
4676
|
|
|
@@ -4624,6 +4778,24 @@ EXAMPLES
|
|
|
4624
4778
|
|
|
4625
4779
|
cod config set -a api -c dev -f '/some-managed-service.pem' --entire-file --value \
|
|
4626
4780
|
'#REF|azKeyVault|our-secret-store|some-managed-svc-cert'
|
|
4781
|
+
|
|
4782
|
+
Reference a dynamic variable. Available names: asset, cabinet, cluster, enterprise, environment, tenant, version.
|
|
4783
|
+
Resolved at deploy time per cabinet.
|
|
4784
|
+
|
|
4785
|
+
cod config set -a api -c dev -t env --setting API_URL --value 'https://${asset}.${cabinet}.mydomain.com'
|
|
4786
|
+
|
|
4787
|
+
Resolve the hostname for an existing `cod host map` entry via the ${hostmap(strategy, domain)} dynamic variable.
|
|
4788
|
+
Useful when a helm chart owns its own Ingress and needs the Codiac-resolved host. Run `cod host list` to see
|
|
4789
|
+
strategies/domains mapped to your cabinet.
|
|
4790
|
+
|
|
4791
|
+
cod config set -a my-asset -c develop -t helm --setting ingress.host --value \
|
|
4792
|
+
'${hostmap("svc_dot_cab_dot_domain", "internal.primeroedge.co")}'
|
|
4793
|
+
|
|
4794
|
+
Sibling ${hostmap_path(...)} returns the path component for path-form strategies (cab_dot_domain_slash_service,
|
|
4795
|
+
domain_slash_service). Returns empty string for host-only strategies.
|
|
4796
|
+
|
|
4797
|
+
cod config set -a my-asset -c develop -t helm --setting ingress.path --value \
|
|
4798
|
+
'${hostmap_path("cab_dot_domain_slash_service", "my-company.com")}'
|
|
4627
4799
|
```
|
|
4628
4800
|
|
|
4629
4801
|
## `codiac cfg delete [SETTING]`
|
|
@@ -4773,7 +4945,7 @@ DESCRIPTION
|
|
|
4773
4945
|
Applies settings to the Codiac CLI itself (scoped to the local machine).
|
|
4774
4946
|
```
|
|
4775
4947
|
|
|
4776
|
-
_See code: [src/commands/cli.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
4948
|
+
_See code: [src/commands/cli.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cli.ts)_
|
|
4777
4949
|
|
|
4778
4950
|
## `codiac cluster agent configure [CLUSTER]`
|
|
4779
4951
|
|
|
@@ -4810,6 +4982,9 @@ DESCRIPTION
|
|
|
4810
4982
|
can be provided as a JSON or YAML string via --settings, piped in via stdin, or entered interactively as a single
|
|
4811
4983
|
key-value pair.
|
|
4812
4984
|
|
|
4985
|
+
ALIASES
|
|
4986
|
+
$ codiac cluster envoy configure
|
|
4987
|
+
|
|
4813
4988
|
EXAMPLES
|
|
4814
4989
|
Patch inline JSON settings into the existing agent configuration.
|
|
4815
4990
|
|
|
@@ -4838,7 +5013,7 @@ EXAMPLES
|
|
|
4838
5013
|
$ codiac cluster agent configure my-cluster --to-script
|
|
4839
5014
|
```
|
|
4840
5015
|
|
|
4841
|
-
_See code: [src/commands/cluster/agent/configure.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
5016
|
+
_See code: [src/commands/cluster/agent/configure.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/agent/configure.ts)_
|
|
4842
5017
|
|
|
4843
5018
|
## `codiac cluster agent install [CLUSTER]`
|
|
4844
5019
|
|
|
@@ -4869,6 +5044,9 @@ FLAGS
|
|
|
4869
5044
|
DESCRIPTION
|
|
4870
5045
|
Installs the Codiac agent on the given cluster, enabling Codiac to manage workloads and configurations on the cluster.
|
|
4871
5046
|
|
|
5047
|
+
ALIASES
|
|
5048
|
+
$ codiac cluster envoy install
|
|
5049
|
+
|
|
4872
5050
|
EXAMPLES
|
|
4873
5051
|
Install the Codiac agent on a cluster.
|
|
4874
5052
|
|
|
@@ -4891,7 +5069,7 @@ EXAMPLES
|
|
|
4891
5069
|
$ codiac cluster agent install my-cluster --to-script
|
|
4892
5070
|
```
|
|
4893
5071
|
|
|
4894
|
-
_See code: [src/commands/cluster/agent/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
5072
|
+
_See code: [src/commands/cluster/agent/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/agent/install.ts)_
|
|
4895
5073
|
|
|
4896
5074
|
## `codiac cluster agent uninstall [CLUSTER]`
|
|
4897
5075
|
|
|
@@ -4918,6 +5096,9 @@ FLAGS
|
|
|
4918
5096
|
DESCRIPTION
|
|
4919
5097
|
Uninstalls the Codiac agent from the given cluster.
|
|
4920
5098
|
|
|
5099
|
+
ALIASES
|
|
5100
|
+
$ codiac cluster envoy uninstall
|
|
5101
|
+
|
|
4921
5102
|
EXAMPLES
|
|
4922
5103
|
Uninstall the Codiac agent from a cluster.
|
|
4923
5104
|
|
|
@@ -4936,7 +5117,7 @@ EXAMPLES
|
|
|
4936
5117
|
$ codiac cluster agent uninstall my-cluster --to-script
|
|
4937
5118
|
```
|
|
4938
5119
|
|
|
4939
|
-
_See code: [src/commands/cluster/agent/uninstall.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
5120
|
+
_See code: [src/commands/cluster/agent/uninstall.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/agent/uninstall.ts)_
|
|
4940
5121
|
|
|
4941
5122
|
## `codiac cluster bootstrap [NAME]`
|
|
4942
5123
|
|
|
@@ -4999,7 +5180,7 @@ EXAMPLES
|
|
|
4999
5180
|
$ codiac cluster bootstrap my-cluster --to-script
|
|
5000
5181
|
```
|
|
5001
5182
|
|
|
5002
|
-
_See code: [src/commands/cluster/bootstrap.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
5183
|
+
_See code: [src/commands/cluster/bootstrap.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/bootstrap.ts)_
|
|
5003
5184
|
|
|
5004
5185
|
## `codiac cluster capture`
|
|
5005
5186
|
|
|
@@ -5084,7 +5265,7 @@ EXAMPLES
|
|
|
5084
5265
|
$ codiac cluster connect my-fav-cluster
|
|
5085
5266
|
```
|
|
5086
5267
|
|
|
5087
|
-
_See code: [src/commands/cluster/connect.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
5268
|
+
_See code: [src/commands/cluster/connect.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/connect.ts)_
|
|
5088
5269
|
|
|
5089
5270
|
## `codiac cluster contents`
|
|
5090
5271
|
|
|
@@ -5281,7 +5462,8 @@ USAGE
|
|
|
5281
5462
|
--to-script]]
|
|
5282
5463
|
|
|
5283
5464
|
ARGUMENTS
|
|
5284
|
-
NAME Name of the cluster to define
|
|
5465
|
+
NAME Name of the cluster to define. If a definition already exists with this name, it is loaded and opened for
|
|
5466
|
+
editing.
|
|
5285
5467
|
|
|
5286
5468
|
FLAGS
|
|
5287
5469
|
-g, --resourceGroup=<value> (Azure only, required) The resource group associated with the cluster.
|
|
@@ -5322,6 +5504,10 @@ EXAMPLES
|
|
|
5322
5504
|
|
|
5323
5505
|
$ codiac cluster define
|
|
5324
5506
|
|
|
5507
|
+
Load and edit an existing cluster definition interactively by name.
|
|
5508
|
+
|
|
5509
|
+
$ codiac cluster define my-cluster
|
|
5510
|
+
|
|
5325
5511
|
Define an Azure cluster non-interactively.
|
|
5326
5512
|
|
|
5327
5513
|
$ codiac cluster define my-cluster --provider azure --providerSubscription <sub-id> --resourceGroup my-rg \
|
|
@@ -5406,6 +5592,172 @@ ALIASES
|
|
|
5406
5592
|
$ codiac cluster destroy
|
|
5407
5593
|
```
|
|
5408
5594
|
|
|
5595
|
+
## `codiac cluster envoy configure [CLUSTER]`
|
|
5596
|
+
|
|
5597
|
+
Applies configuration settings to the Codiac agent on the given cluster. Use "overlay" mode (default) to merge settings on top of the existing configuration, or "replace" mode to overwrite the configuration entirely. Settings can be provided as a JSON or YAML string via --settings, piped in via stdin, or entered interactively as a single key-value pair.
|
|
5598
|
+
|
|
5599
|
+
```
|
|
5600
|
+
USAGE
|
|
5601
|
+
$ codiac cluster envoy configure [CLUSTER] [-m overlay|replace] [--settings <value>] [--take-defaults | [--silent | --echo
|
|
5602
|
+
| --to-script]]
|
|
5603
|
+
|
|
5604
|
+
ARGUMENTS
|
|
5605
|
+
CLUSTER Name of the cluster in Codiac on which to configure the Codiac agent. You can use `cod cluster list` to see
|
|
5606
|
+
available cluster names.
|
|
5607
|
+
|
|
5608
|
+
FLAGS
|
|
5609
|
+
-m, --mode=<option> How to apply the provided settings: "overlay" (default) merges the settings on top of the
|
|
5610
|
+
existing configuration; "replace" overwrites the configuration entirely.
|
|
5611
|
+
<options: overlay|replace>
|
|
5612
|
+
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use before
|
|
5613
|
+
final execution.
|
|
5614
|
+
--settings=<value> JSON or YAML string of settings to apply to the agent configuration. Alternatively, pipe
|
|
5615
|
+
settings content via stdin.
|
|
5616
|
+
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
|
|
5617
|
+
arguments.
|
|
5618
|
+
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically set
|
|
5619
|
+
to default values (Irrelevant in --silent mode). This behavior does NOT apply to scenarios where
|
|
5620
|
+
the command needs to override invalid user input; such cases will always prompt for confirmation.
|
|
5621
|
+
--to-script Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
|
|
5622
|
+
execution.
|
|
5623
|
+
|
|
5624
|
+
DESCRIPTION
|
|
5625
|
+
Applies configuration settings to the Codiac agent on the given cluster. Use "overlay" mode (default) to merge
|
|
5626
|
+
settings on top of the existing configuration, or "replace" mode to overwrite the configuration entirely. Settings
|
|
5627
|
+
can be provided as a JSON or YAML string via --settings, piped in via stdin, or entered interactively as a single
|
|
5628
|
+
key-value pair.
|
|
5629
|
+
|
|
5630
|
+
ALIASES
|
|
5631
|
+
$ codiac cluster envoy configure
|
|
5632
|
+
|
|
5633
|
+
EXAMPLES
|
|
5634
|
+
Patch inline JSON settings into the existing agent configuration.
|
|
5635
|
+
|
|
5636
|
+
$ codiac cluster envoy configure my-cluster --settings '{"keel": {"image": {"repository": "my-repo", "tag": \
|
|
5637
|
+
"latest", "pullPolicy": "Always"}}}'
|
|
5638
|
+
|
|
5639
|
+
Replace the entire agent configuration with inline JSON settings.
|
|
5640
|
+
|
|
5641
|
+
$ codiac cluster envoy configure my-cluster --mode replace --settings '{"keel": {"image": {"repository": \
|
|
5642
|
+
"my-repo", "tag": "latest", "pullPolicy": "Always"}}}'
|
|
5643
|
+
|
|
5644
|
+
Pipe a YAML settings file into the command.
|
|
5645
|
+
|
|
5646
|
+
cat mysettings.yaml | codiac cluster envoy configure my-cluster
|
|
5647
|
+
|
|
5648
|
+
Non-interactive (scripted) invocation.
|
|
5649
|
+
|
|
5650
|
+
$ codiac cluster envoy configure my-cluster --settings '{"keel": {"image": {"tag": "v1.2.3"}}}' --silent
|
|
5651
|
+
|
|
5652
|
+
Renders the equivalent silent command and then executes.
|
|
5653
|
+
|
|
5654
|
+
$ codiac cluster envoy configure my-cluster --echo
|
|
5655
|
+
|
|
5656
|
+
Renders the equivalent silent command without executing.
|
|
5657
|
+
|
|
5658
|
+
$ codiac cluster envoy configure my-cluster --to-script
|
|
5659
|
+
```
|
|
5660
|
+
|
|
5661
|
+
## `codiac cluster envoy install [CLUSTER]`
|
|
5662
|
+
|
|
5663
|
+
Installs the Codiac agent on the given cluster, enabling Codiac to manage workloads and configurations on the cluster.
|
|
5664
|
+
|
|
5665
|
+
```
|
|
5666
|
+
USAGE
|
|
5667
|
+
$ codiac cluster envoy install [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]] [-v <value>]
|
|
5668
|
+
|
|
5669
|
+
ARGUMENTS
|
|
5670
|
+
CLUSTER Name of the cluster in Codiac on which to install the Codiac agent. You can use `cod cluster list` to see
|
|
5671
|
+
available cluster names.
|
|
5672
|
+
|
|
5673
|
+
FLAGS
|
|
5674
|
+
-v, --version=<value> Version of the Codiac agent helm chart to install. Omit to install the latest available
|
|
5675
|
+
version.
|
|
5676
|
+
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use before
|
|
5677
|
+
final execution.
|
|
5678
|
+
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
|
|
5679
|
+
arguments.
|
|
5680
|
+
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically set
|
|
5681
|
+
to default values (Irrelevant in --silent mode). This behavior does NOT apply to scenarios
|
|
5682
|
+
where the command needs to override invalid user input; such cases will always prompt for
|
|
5683
|
+
confirmation.
|
|
5684
|
+
--to-script Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
|
|
5685
|
+
execution.
|
|
5686
|
+
|
|
5687
|
+
DESCRIPTION
|
|
5688
|
+
Installs the Codiac agent on the given cluster, enabling Codiac to manage workloads and configurations on the cluster.
|
|
5689
|
+
|
|
5690
|
+
ALIASES
|
|
5691
|
+
$ codiac cluster envoy install
|
|
5692
|
+
|
|
5693
|
+
EXAMPLES
|
|
5694
|
+
Install the Codiac agent on a cluster.
|
|
5695
|
+
|
|
5696
|
+
$ codiac cluster envoy install my-cluster
|
|
5697
|
+
|
|
5698
|
+
Install a specific version of the Codiac agent.
|
|
5699
|
+
|
|
5700
|
+
$ codiac cluster envoy install my-cluster --version 1.2.3
|
|
5701
|
+
|
|
5702
|
+
Non-interactive (scripted) invocation.
|
|
5703
|
+
|
|
5704
|
+
$ codiac cluster envoy install my-cluster --silent
|
|
5705
|
+
|
|
5706
|
+
Renders the equivalent silent command and then executes.
|
|
5707
|
+
|
|
5708
|
+
$ codiac cluster envoy install my-cluster --echo
|
|
5709
|
+
|
|
5710
|
+
Render the equivalent silent command without executing.
|
|
5711
|
+
|
|
5712
|
+
$ codiac cluster envoy install my-cluster --to-script
|
|
5713
|
+
```
|
|
5714
|
+
|
|
5715
|
+
## `codiac cluster envoy uninstall [CLUSTER]`
|
|
5716
|
+
|
|
5717
|
+
Uninstalls the Codiac agent from the given cluster.
|
|
5718
|
+
|
|
5719
|
+
```
|
|
5720
|
+
USAGE
|
|
5721
|
+
$ codiac cluster envoy uninstall [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]]
|
|
5722
|
+
|
|
5723
|
+
ARGUMENTS
|
|
5724
|
+
CLUSTER Name of the cluster in Codiac from which to uninstall the Codiac agent. You can use `cod cluster list` to
|
|
5725
|
+
see available cluster names.
|
|
5726
|
+
|
|
5727
|
+
FLAGS
|
|
5728
|
+
--echo Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
|
|
5729
|
+
execution.
|
|
5730
|
+
--silent Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
|
|
5731
|
+
arguments.
|
|
5732
|
+
--take-defaults Prevents prompting for confirmation on parameters that were passed in or were automatically set to
|
|
5733
|
+
default values (Irrelevant in --silent mode). This behavior does NOT apply to scenarios where the
|
|
5734
|
+
command needs to override invalid user input; such cases will always prompt for confirmation.
|
|
5735
|
+
--to-script Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.
|
|
5736
|
+
|
|
5737
|
+
DESCRIPTION
|
|
5738
|
+
Uninstalls the Codiac agent from the given cluster.
|
|
5739
|
+
|
|
5740
|
+
ALIASES
|
|
5741
|
+
$ codiac cluster envoy uninstall
|
|
5742
|
+
|
|
5743
|
+
EXAMPLES
|
|
5744
|
+
Uninstall the Codiac agent from a cluster.
|
|
5745
|
+
|
|
5746
|
+
$ codiac cluster envoy uninstall my-cluster
|
|
5747
|
+
|
|
5748
|
+
Non-interactive (scripted) invocation.
|
|
5749
|
+
|
|
5750
|
+
$ codiac cluster envoy uninstall my-cluster --silent
|
|
5751
|
+
|
|
5752
|
+
Renders the equivalent silent command and then executes.
|
|
5753
|
+
|
|
5754
|
+
$ codiac cluster envoy uninstall my-cluster --echo
|
|
5755
|
+
|
|
5756
|
+
Render the equivalent silent command without executing.
|
|
5757
|
+
|
|
5758
|
+
$ codiac cluster envoy uninstall my-cluster --to-script
|
|
5759
|
+
```
|
|
5760
|
+
|
|
5409
5761
|
## `codiac cluster forget`
|
|
5410
5762
|
|
|
5411
5763
|
Permanently removes the record of a cluster. This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness. You must remove all cabinets and environments in a cluster before forgetting it.
|
|
@@ -5578,7 +5930,7 @@ EXAMPLES
|
|
|
5578
5930
|
$ codiac cluster install my-cluster -a my-chart -u 1.2.3 --silent
|
|
5579
5931
|
```
|
|
5580
5932
|
|
|
5581
|
-
_See code: [src/commands/cluster/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
5933
|
+
_See code: [src/commands/cluster/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/install.ts)_
|
|
5582
5934
|
|
|
5583
5935
|
## `codiac cluster journal [CLUSTER]`
|
|
5584
5936
|
|
|
@@ -5867,7 +6219,7 @@ EXAMPLES
|
|
|
5867
6219
|
$ codiac cluster stack capture my-fav-cluster
|
|
5868
6220
|
```
|
|
5869
6221
|
|
|
5870
|
-
_See code: [src/commands/cluster/stack/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6222
|
+
_See code: [src/commands/cluster/stack/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/stack/capture.ts)_
|
|
5871
6223
|
|
|
5872
6224
|
## `codiac cluster stack install [CLUSTER]`
|
|
5873
6225
|
|
|
@@ -5919,7 +6271,7 @@ EXAMPLES
|
|
|
5919
6271
|
$ codiac cluster stack install my-cluster --to-script
|
|
5920
6272
|
```
|
|
5921
6273
|
|
|
5922
|
-
_See code: [src/commands/cluster/stack/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6274
|
+
_See code: [src/commands/cluster/stack/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/stack/install.ts)_
|
|
5923
6275
|
|
|
5924
6276
|
## `codiac cluster stack list`
|
|
5925
6277
|
|
|
@@ -6085,7 +6437,7 @@ EXAMPLES
|
|
|
6085
6437
|
$ codiac cluster start my-fav-cluster
|
|
6086
6438
|
```
|
|
6087
6439
|
|
|
6088
|
-
_See code: [src/commands/cluster/start.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6440
|
+
_See code: [src/commands/cluster/start.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/start.ts)_
|
|
6089
6441
|
|
|
6090
6442
|
## `codiac cluster stop [CLUSTER]`
|
|
6091
6443
|
|
|
@@ -6122,7 +6474,7 @@ EXAMPLES
|
|
|
6122
6474
|
$ codiac cluster start my-fav-cluster
|
|
6123
6475
|
```
|
|
6124
6476
|
|
|
6125
|
-
_See code: [src/commands/cluster/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6477
|
+
_See code: [src/commands/cluster/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/cluster/stop.ts)_
|
|
6126
6478
|
|
|
6127
6479
|
## `codiac cluster uninstall`
|
|
6128
6480
|
|
|
@@ -6184,7 +6536,7 @@ DESCRIPTION
|
|
|
6184
6536
|
Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.
|
|
6185
6537
|
```
|
|
6186
6538
|
|
|
6187
|
-
_See code: [src/commands/commit.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6539
|
+
_See code: [src/commands/commit.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/commit.ts)_
|
|
6188
6540
|
|
|
6189
6541
|
## `codiac config add`
|
|
6190
6542
|
|
|
@@ -6292,9 +6644,27 @@ EXAMPLES
|
|
|
6292
6644
|
|
|
6293
6645
|
cod config set -a api -c dev -f '/some-managed-service.pem' --entire-file --value \
|
|
6294
6646
|
'#REF|azKeyVault|our-secret-store|some-managed-svc-cert'
|
|
6647
|
+
|
|
6648
|
+
Reference a dynamic variable. Available names: asset, cabinet, cluster, enterprise, environment, tenant, version.
|
|
6649
|
+
Resolved at deploy time per cabinet.
|
|
6650
|
+
|
|
6651
|
+
cod config set -a api -c dev -t env --setting API_URL --value 'https://${asset}.${cabinet}.mydomain.com'
|
|
6652
|
+
|
|
6653
|
+
Resolve the hostname for an existing `cod host map` entry via the ${hostmap(strategy, domain)} dynamic variable.
|
|
6654
|
+
Useful when a helm chart owns its own Ingress and needs the Codiac-resolved host. Run `cod host list` to see
|
|
6655
|
+
strategies/domains mapped to your cabinet.
|
|
6656
|
+
|
|
6657
|
+
cod config set -a my-asset -c develop -t helm --setting ingress.host --value \
|
|
6658
|
+
'${hostmap("svc_dot_cab_dot_domain", "internal.primeroedge.co")}'
|
|
6659
|
+
|
|
6660
|
+
Sibling ${hostmap_path(...)} returns the path component for path-form strategies (cab_dot_domain_slash_service,
|
|
6661
|
+
domain_slash_service). Returns empty string for host-only strategies.
|
|
6662
|
+
|
|
6663
|
+
cod config set -a my-asset -c develop -t helm --setting ingress.path --value \
|
|
6664
|
+
'${hostmap_path("cab_dot_domain_slash_service", "my-company.com")}'
|
|
6295
6665
|
```
|
|
6296
6666
|
|
|
6297
|
-
_See code: [src/commands/config/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6667
|
+
_See code: [src/commands/config/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/config/add.ts)_
|
|
6298
6668
|
|
|
6299
6669
|
## `codiac config delete [SETTING]`
|
|
6300
6670
|
|
|
@@ -6363,7 +6733,7 @@ ALIASES
|
|
|
6363
6733
|
$ codiac cfg delete
|
|
6364
6734
|
```
|
|
6365
6735
|
|
|
6366
|
-
_See code: [src/commands/config/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6736
|
+
_See code: [src/commands/config/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/config/delete.ts)_
|
|
6367
6737
|
|
|
6368
6738
|
## `codiac config deploy`
|
|
6369
6739
|
|
|
@@ -6404,7 +6774,7 @@ EXAMPLES
|
|
|
6404
6774
|
$ codiac config deploy -e myEnterprise -a myApi -c dev --to-script
|
|
6405
6775
|
```
|
|
6406
6776
|
|
|
6407
|
-
_See code: [src/commands/config/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6777
|
+
_See code: [src/commands/config/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/config/deploy.ts)_
|
|
6408
6778
|
|
|
6409
6779
|
## `codiac config import`
|
|
6410
6780
|
|
|
@@ -6457,7 +6827,7 @@ EXAMPLES
|
|
|
6457
6827
|
$ codiac config import -a myApi -s ./dist/app-config.json -n myEnterprise --to-script
|
|
6458
6828
|
```
|
|
6459
6829
|
|
|
6460
|
-
_See code: [src/commands/config/import.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
6830
|
+
_See code: [src/commands/config/import.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/config/import.ts)_
|
|
6461
6831
|
|
|
6462
6832
|
## `codiac config preview [SETTING]`
|
|
6463
6833
|
|
|
@@ -6628,6 +6998,24 @@ EXAMPLES
|
|
|
6628
6998
|
|
|
6629
6999
|
cod config set -a api -c dev -f '/some-managed-service.pem' --entire-file --value \
|
|
6630
7000
|
'#REF|azKeyVault|our-secret-store|some-managed-svc-cert'
|
|
7001
|
+
|
|
7002
|
+
Reference a dynamic variable. Available names: asset, cabinet, cluster, enterprise, environment, tenant, version.
|
|
7003
|
+
Resolved at deploy time per cabinet.
|
|
7004
|
+
|
|
7005
|
+
cod config set -a api -c dev -t env --setting API_URL --value 'https://${asset}.${cabinet}.mydomain.com'
|
|
7006
|
+
|
|
7007
|
+
Resolve the hostname for an existing `cod host map` entry via the ${hostmap(strategy, domain)} dynamic variable.
|
|
7008
|
+
Useful when a helm chart owns its own Ingress and needs the Codiac-resolved host. Run `cod host list` to see
|
|
7009
|
+
strategies/domains mapped to your cabinet.
|
|
7010
|
+
|
|
7011
|
+
cod config set -a my-asset -c develop -t helm --setting ingress.host --value \
|
|
7012
|
+
'${hostmap("svc_dot_cab_dot_domain", "internal.primeroedge.co")}'
|
|
7013
|
+
|
|
7014
|
+
Sibling ${hostmap_path(...)} returns the path component for path-form strategies (cab_dot_domain_slash_service,
|
|
7015
|
+
domain_slash_service). Returns empty string for host-only strategies.
|
|
7016
|
+
|
|
7017
|
+
cod config set -a my-asset -c develop -t helm --setting ingress.path --value \
|
|
7018
|
+
'${hostmap_path("cab_dot_domain_slash_service", "my-company.com")}'
|
|
6631
7019
|
```
|
|
6632
7020
|
|
|
6633
7021
|
## `codiac config settings get`
|
|
@@ -6698,7 +7086,7 @@ DESCRIPTION
|
|
|
6698
7086
|
Shows the list of clusters.
|
|
6699
7087
|
```
|
|
6700
7088
|
|
|
6701
|
-
_See code: [src/commands/config/settings/get.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7089
|
+
_See code: [src/commands/config/settings/get.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/config/settings/get.ts)_
|
|
6702
7090
|
|
|
6703
7091
|
## `codiac config view [SETTING]`
|
|
6704
7092
|
|
|
@@ -6763,7 +7151,7 @@ EXAMPLES
|
|
|
6763
7151
|
$ codiac config view -e myEnterprise -a myApi -c dev --to-script
|
|
6764
7152
|
```
|
|
6765
7153
|
|
|
6766
|
-
_See code: [src/commands/config/view.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7154
|
+
_See code: [src/commands/config/view.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/config/view.ts)_
|
|
6767
7155
|
|
|
6768
7156
|
## `codiac csp creds list`
|
|
6769
7157
|
|
|
@@ -6811,7 +7199,7 @@ EXAMPLES
|
|
|
6811
7199
|
$ codiac csp creds list
|
|
6812
7200
|
```
|
|
6813
7201
|
|
|
6814
|
-
_See code: [src/commands/csp/creds/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7202
|
+
_See code: [src/commands/csp/creds/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/csp/creds/list.ts)_
|
|
6815
7203
|
|
|
6816
7204
|
## `codiac csp login [PROVIDER]`
|
|
6817
7205
|
|
|
@@ -6889,7 +7277,7 @@ EXAMPLES
|
|
|
6889
7277
|
cod csp login -u ASIAZ3XYZPDQ123 -p $(cat my-aws-secret-key.txt) --aws-session-token $(cat my-aws-sesh.txt) aws
|
|
6890
7278
|
```
|
|
6891
7279
|
|
|
6892
|
-
_See code: [src/commands/csp/login.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7280
|
+
_See code: [src/commands/csp/login.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/csp/login.ts)_
|
|
6893
7281
|
|
|
6894
7282
|
## `codiac csp logout [PROVIDER]`
|
|
6895
7283
|
|
|
@@ -6936,7 +7324,7 @@ EXAMPLES
|
|
|
6936
7324
|
$ codiac csp logout azure --to-script
|
|
6937
7325
|
```
|
|
6938
7326
|
|
|
6939
|
-
_See code: [src/commands/csp/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7327
|
+
_See code: [src/commands/csp/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/csp/logout.ts)_
|
|
6940
7328
|
|
|
6941
7329
|
## `codiac dep [NAME]`
|
|
6942
7330
|
|
|
@@ -6957,7 +7345,7 @@ DESCRIPTION
|
|
|
6957
7345
|
Installs a package into current project.
|
|
6958
7346
|
```
|
|
6959
7347
|
|
|
6960
|
-
_See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7348
|
+
_See code: [src/commands/dep.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep.ts)_
|
|
6961
7349
|
|
|
6962
7350
|
## `codiac dep create [URL]`
|
|
6963
7351
|
|
|
@@ -6981,7 +7369,7 @@ DESCRIPTION
|
|
|
6981
7369
|
package version is used.
|
|
6982
7370
|
```
|
|
6983
7371
|
|
|
6984
|
-
_See code: [src/commands/dep/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7372
|
+
_See code: [src/commands/dep/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/create.ts)_
|
|
6985
7373
|
|
|
6986
7374
|
## `codiac dep install`
|
|
6987
7375
|
|
|
@@ -6998,7 +7386,7 @@ DESCRIPTION
|
|
|
6998
7386
|
installs any missing dependency packages into the local project folder.
|
|
6999
7387
|
```
|
|
7000
7388
|
|
|
7001
|
-
_See code: [src/commands/dep/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7389
|
+
_See code: [src/commands/dep/install.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/install.ts)_
|
|
7002
7390
|
|
|
7003
7391
|
## `codiac dep list`
|
|
7004
7392
|
|
|
@@ -7015,7 +7403,7 @@ DESCRIPTION
|
|
|
7015
7403
|
Shows the dependencies for the project.
|
|
7016
7404
|
```
|
|
7017
7405
|
|
|
7018
|
-
_See code: [src/commands/dep/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7406
|
+
_See code: [src/commands/dep/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/list.ts)_
|
|
7019
7407
|
|
|
7020
7408
|
## `codiac dep remove [NAME]`
|
|
7021
7409
|
|
|
@@ -7038,7 +7426,7 @@ DESCRIPTION
|
|
|
7038
7426
|
Removes a dependency from the project.
|
|
7039
7427
|
```
|
|
7040
7428
|
|
|
7041
|
-
_See code: [src/commands/dep/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7429
|
+
_See code: [src/commands/dep/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/remove.ts)_
|
|
7042
7430
|
|
|
7043
7431
|
## `codiac dep source [NAME]`
|
|
7044
7432
|
|
|
@@ -7064,7 +7452,7 @@ ALIASES
|
|
|
7064
7452
|
$ codiac dep src
|
|
7065
7453
|
```
|
|
7066
7454
|
|
|
7067
|
-
_See code: [src/commands/dep/source.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7455
|
+
_See code: [src/commands/dep/source.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/source.ts)_
|
|
7068
7456
|
|
|
7069
7457
|
## `codiac dep src [NAME]`
|
|
7070
7458
|
|
|
@@ -7108,7 +7496,7 @@ DESCRIPTION
|
|
|
7108
7496
|
Publishes the dependency in its current state and upgrades to it in the main project.
|
|
7109
7497
|
```
|
|
7110
7498
|
|
|
7111
|
-
_See code: [src/commands/dep/syncup.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7499
|
+
_See code: [src/commands/dep/syncup.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/syncup.ts)_
|
|
7112
7500
|
|
|
7113
7501
|
## `codiac dep unsource [NAME]`
|
|
7114
7502
|
|
|
@@ -7136,7 +7524,7 @@ ALIASES
|
|
|
7136
7524
|
$ codiac dep unsrc
|
|
7137
7525
|
```
|
|
7138
7526
|
|
|
7139
|
-
_See code: [src/commands/dep/unsource.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7527
|
+
_See code: [src/commands/dep/unsource.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/unsource.ts)_
|
|
7140
7528
|
|
|
7141
7529
|
## `codiac dep unsrc [NAME]`
|
|
7142
7530
|
|
|
@@ -7183,7 +7571,7 @@ DESCRIPTION
|
|
|
7183
7571
|
describe the command here
|
|
7184
7572
|
```
|
|
7185
7573
|
|
|
7186
|
-
_See code: [src/commands/dep/upgrade.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7574
|
+
_See code: [src/commands/dep/upgrade.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/dep/upgrade.ts)_
|
|
7187
7575
|
|
|
7188
7576
|
## `codiac deploy`
|
|
7189
7577
|
|
|
@@ -7236,7 +7624,7 @@ EXAMPLES
|
|
|
7236
7624
|
$ codiac deploy -e myEnterprise -a myApi -u 1.2.3 -c dev --to-script
|
|
7237
7625
|
```
|
|
7238
7626
|
|
|
7239
|
-
_See code: [src/commands/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7627
|
+
_See code: [src/commands/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/deploy.ts)_
|
|
7240
7628
|
|
|
7241
7629
|
## `codiac domain map [DOMAIN]`
|
|
7242
7630
|
|
|
@@ -7282,6 +7670,12 @@ EXAMPLES
|
|
|
7282
7670
|
Renders the equivalent silent command without executing.
|
|
7283
7671
|
|
|
7284
7672
|
$ codiac domain map my-company.com -e myEnterprise --to-script
|
|
7673
|
+
|
|
7674
|
+
Consume a mapping from a helm chart's own ingress spec: after mapping the domain here, reference it from any scoped
|
|
7675
|
+
setting via the ${hostmap(strategy, domain)} dynamic variable. See `cod config set --help` for setting-side
|
|
7676
|
+
examples.
|
|
7677
|
+
|
|
7678
|
+
$ codiac domain map internal.primeroedge.co -e main -v primero-dev -n svc_dot_cab_dot_domain --silent
|
|
7285
7679
|
```
|
|
7286
7680
|
|
|
7287
7681
|
## `codiac ent list`
|
|
@@ -7386,7 +7780,7 @@ EXAMPLES
|
|
|
7386
7780
|
cod enterprise create my-enterprise-code --silent
|
|
7387
7781
|
```
|
|
7388
7782
|
|
|
7389
|
-
_See code: [src/commands/enterprise/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7783
|
+
_See code: [src/commands/enterprise/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/enterprise/create.ts)_
|
|
7390
7784
|
|
|
7391
7785
|
## `codiac enterprise list`
|
|
7392
7786
|
|
|
@@ -7441,7 +7835,7 @@ EXAMPLES
|
|
|
7441
7835
|
$ codiac enterprise list --to-script
|
|
7442
7836
|
```
|
|
7443
7837
|
|
|
7444
|
-
_See code: [src/commands/enterprise/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7838
|
+
_See code: [src/commands/enterprise/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/enterprise/list.ts)_
|
|
7445
7839
|
|
|
7446
7840
|
## `codiac env add [SETTING]`
|
|
7447
7841
|
|
|
@@ -7491,7 +7885,7 @@ EXAMPLES
|
|
|
7491
7885
|
$ codiac env add -s MY_VAR -v myValue -n myEnterprise --to-script
|
|
7492
7886
|
```
|
|
7493
7887
|
|
|
7494
|
-
_See code: [src/commands/env/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
7888
|
+
_See code: [src/commands/env/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/env/add.ts)_
|
|
7495
7889
|
|
|
7496
7890
|
## `codiac enviro cluster attach`
|
|
7497
7891
|
|
|
@@ -7794,7 +8188,7 @@ ALIASES
|
|
|
7794
8188
|
$ codiac infrx enviro cluster attach
|
|
7795
8189
|
```
|
|
7796
8190
|
|
|
7797
|
-
_See code: [src/commands/environment/cluster/attach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8191
|
+
_See code: [src/commands/environment/cluster/attach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/environment/cluster/attach.ts)_
|
|
7798
8192
|
|
|
7799
8193
|
## `codiac environment cluster detach`
|
|
7800
8194
|
|
|
@@ -7840,7 +8234,7 @@ ALIASES
|
|
|
7840
8234
|
$ codiac infrx enviro cluster detach
|
|
7841
8235
|
```
|
|
7842
8236
|
|
|
7843
|
-
_See code: [src/commands/environment/cluster/detach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8237
|
+
_See code: [src/commands/environment/cluster/detach.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/environment/cluster/detach.ts)_
|
|
7844
8238
|
|
|
7845
8239
|
## `codiac environment create [NAME]`
|
|
7846
8240
|
|
|
@@ -7903,7 +8297,7 @@ EXAMPLES
|
|
|
7903
8297
|
cod environment create dev --enterprise main --cluster my-cluster-1 --cluster my-cluster-2 --silent
|
|
7904
8298
|
```
|
|
7905
8299
|
|
|
7906
|
-
_See code: [src/commands/environment/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8300
|
+
_See code: [src/commands/environment/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/environment/create.ts)_
|
|
7907
8301
|
|
|
7908
8302
|
## `codiac environment delete [NAME]`
|
|
7909
8303
|
|
|
@@ -7964,7 +8358,7 @@ EXAMPLES
|
|
|
7964
8358
|
$ codiac environment delete dev --enterprise main --to-script
|
|
7965
8359
|
```
|
|
7966
8360
|
|
|
7967
|
-
_See code: [src/commands/environment/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8361
|
+
_See code: [src/commands/environment/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/environment/delete.ts)_
|
|
7968
8362
|
|
|
7969
8363
|
## `codiac environment list`
|
|
7970
8364
|
|
|
@@ -8015,7 +8409,7 @@ EXAMPLES
|
|
|
8015
8409
|
$ codiac environment list -e myEnterprise --silent
|
|
8016
8410
|
```
|
|
8017
8411
|
|
|
8018
|
-
_See code: [src/commands/environment/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8412
|
+
_See code: [src/commands/environment/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/environment/list.ts)_
|
|
8019
8413
|
|
|
8020
8414
|
## `codiac fileshare capture`
|
|
8021
8415
|
|
|
@@ -8099,7 +8493,7 @@ ALIASES
|
|
|
8099
8493
|
$ codiac fileshare capture
|
|
8100
8494
|
```
|
|
8101
8495
|
|
|
8102
|
-
_See code: [src/commands/filestore/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8496
|
+
_See code: [src/commands/filestore/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/filestore/capture.ts)_
|
|
8103
8497
|
|
|
8104
8498
|
## `codiac filestore forget`
|
|
8105
8499
|
|
|
@@ -8146,7 +8540,7 @@ EXAMPLES
|
|
|
8146
8540
|
$ codiac filestore forget
|
|
8147
8541
|
```
|
|
8148
8542
|
|
|
8149
|
-
_See code: [src/commands/filestore/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8543
|
+
_See code: [src/commands/filestore/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/filestore/forget.ts)_
|
|
8150
8544
|
|
|
8151
8545
|
## `codiac filestore list`
|
|
8152
8546
|
|
|
@@ -8192,7 +8586,7 @@ EXAMPLES
|
|
|
8192
8586
|
$ codiac filestore list
|
|
8193
8587
|
```
|
|
8194
8588
|
|
|
8195
|
-
_See code: [src/commands/filestore/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8589
|
+
_See code: [src/commands/filestore/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/filestore/list.ts)_
|
|
8196
8590
|
|
|
8197
8591
|
## `codiac help [COMMANDS]`
|
|
8198
8592
|
|
|
@@ -8278,7 +8672,7 @@ EXAMPLES
|
|
|
8278
8672
|
$ codiac host delete
|
|
8279
8673
|
```
|
|
8280
8674
|
|
|
8281
|
-
_See code: [src/commands/host/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8675
|
+
_See code: [src/commands/host/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/host/delete.ts)_
|
|
8282
8676
|
|
|
8283
8677
|
## `codiac host list [DOMAIN]`
|
|
8284
8678
|
|
|
@@ -8322,7 +8716,7 @@ EXAMPLES
|
|
|
8322
8716
|
$ codiac host list
|
|
8323
8717
|
```
|
|
8324
8718
|
|
|
8325
|
-
_See code: [src/commands/host/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8719
|
+
_See code: [src/commands/host/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/host/list.ts)_
|
|
8326
8720
|
|
|
8327
8721
|
## `codiac host map [DOMAIN]`
|
|
8328
8722
|
|
|
@@ -8368,9 +8762,15 @@ EXAMPLES
|
|
|
8368
8762
|
Renders the equivalent silent command without executing.
|
|
8369
8763
|
|
|
8370
8764
|
$ codiac host map my-company.com -e myEnterprise --to-script
|
|
8765
|
+
|
|
8766
|
+
Consume a mapping from a helm chart's own ingress spec: after mapping the domain here, reference it from any scoped
|
|
8767
|
+
setting via the ${hostmap(strategy, domain)} dynamic variable. See `cod config set --help` for setting-side
|
|
8768
|
+
examples.
|
|
8769
|
+
|
|
8770
|
+
$ codiac host map internal.primeroedge.co -e main -v primero-dev -n svc_dot_cab_dot_domain --silent
|
|
8371
8771
|
```
|
|
8372
8772
|
|
|
8373
|
-
_See code: [src/commands/host/map.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8773
|
+
_See code: [src/commands/host/map.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/host/map.ts)_
|
|
8374
8774
|
|
|
8375
8775
|
## `codiac host view [DOMAIN]`
|
|
8376
8776
|
|
|
@@ -8415,7 +8815,7 @@ EXAMPLES
|
|
|
8415
8815
|
$ codiac host view
|
|
8416
8816
|
```
|
|
8417
8817
|
|
|
8418
|
-
_See code: [src/commands/host/view.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8818
|
+
_See code: [src/commands/host/view.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/host/view.ts)_
|
|
8419
8819
|
|
|
8420
8820
|
## `codiac identify [TOKENNAME]`
|
|
8421
8821
|
|
|
@@ -8487,7 +8887,7 @@ ALIASES
|
|
|
8487
8887
|
$ codiac token
|
|
8488
8888
|
```
|
|
8489
8889
|
|
|
8490
|
-
_See code: [src/commands/identity.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8890
|
+
_See code: [src/commands/identity.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/identity.ts)_
|
|
8491
8891
|
|
|
8492
8892
|
## `codiac identity delete [NAME]`
|
|
8493
8893
|
|
|
@@ -8512,7 +8912,7 @@ ALIASES
|
|
|
8512
8912
|
$ codiac token remove
|
|
8513
8913
|
```
|
|
8514
8914
|
|
|
8515
|
-
_See code: [src/commands/identity/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8915
|
+
_See code: [src/commands/identity/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/identity/delete.ts)_
|
|
8516
8916
|
|
|
8517
8917
|
## `codiac identity list`
|
|
8518
8918
|
|
|
@@ -8534,7 +8934,7 @@ ALIASES
|
|
|
8534
8934
|
$ codiac token list
|
|
8535
8935
|
```
|
|
8536
8936
|
|
|
8537
|
-
_See code: [src/commands/identity/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
8937
|
+
_See code: [src/commands/identity/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/identity/list.ts)_
|
|
8538
8938
|
|
|
8539
8939
|
## `codiac identity remove [NAME]`
|
|
8540
8940
|
|
|
@@ -8855,7 +9255,7 @@ DESCRIPTION
|
|
|
8855
9255
|
Saves a reference to an existing container registry.
|
|
8856
9256
|
```
|
|
8857
9257
|
|
|
8858
|
-
_See code: [src/commands/imageRegistry/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9258
|
+
_See code: [src/commands/imageRegistry/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/imageRegistry/capture.ts)_
|
|
8859
9259
|
|
|
8860
9260
|
## `codiac imageRegistry forget`
|
|
8861
9261
|
|
|
@@ -8876,7 +9276,7 @@ DESCRIPTION
|
|
|
8876
9276
|
Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.
|
|
8877
9277
|
```
|
|
8878
9278
|
|
|
8879
|
-
_See code: [src/commands/imageRegistry/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9279
|
+
_See code: [src/commands/imageRegistry/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/imageRegistry/forget.ts)_
|
|
8880
9280
|
|
|
8881
9281
|
## `codiac imageRegistry list`
|
|
8882
9282
|
|
|
@@ -8918,7 +9318,7 @@ EXAMPLES
|
|
|
8918
9318
|
$ codiac imageRegistry list -o yaml > registries.yaml
|
|
8919
9319
|
```
|
|
8920
9320
|
|
|
8921
|
-
_See code: [src/commands/imageRegistry/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9321
|
+
_See code: [src/commands/imageRegistry/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/imageRegistry/list.ts)_
|
|
8922
9322
|
|
|
8923
9323
|
## `codiac imageRegistry pullSecret set`
|
|
8924
9324
|
|
|
@@ -8954,7 +9354,7 @@ ALIASES
|
|
|
8954
9354
|
$ codiac pullsecret
|
|
8955
9355
|
```
|
|
8956
9356
|
|
|
8957
|
-
_See code: [src/commands/imageRegistry/pullSecret/set.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9357
|
+
_See code: [src/commands/imageRegistry/pullSecret/set.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/imageRegistry/pullSecret/set.ts)_
|
|
8958
9358
|
|
|
8959
9359
|
## `codiac imageRegistry pullSecret unset`
|
|
8960
9360
|
|
|
@@ -8981,7 +9381,7 @@ ALIASES
|
|
|
8981
9381
|
$ codiac pullsecret unset
|
|
8982
9382
|
```
|
|
8983
9383
|
|
|
8984
|
-
_See code: [src/commands/imageRegistry/pullSecret/unset.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9384
|
+
_See code: [src/commands/imageRegistry/pullSecret/unset.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/imageRegistry/pullSecret/unset.ts)_
|
|
8985
9385
|
|
|
8986
9386
|
## `codiac images add [IMAGENAME]`
|
|
8987
9387
|
|
|
@@ -9042,7 +9442,7 @@ EXAMPLES
|
|
|
9042
9442
|
$ codiac images add your-company/your-image --to-script
|
|
9043
9443
|
```
|
|
9044
9444
|
|
|
9045
|
-
_See code: [src/commands/images/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9445
|
+
_See code: [src/commands/images/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/images/add.ts)_
|
|
9046
9446
|
|
|
9047
9447
|
## `codiac images list`
|
|
9048
9448
|
|
|
@@ -9065,7 +9465,7 @@ ALIASES
|
|
|
9065
9465
|
$ codiac img list
|
|
9066
9466
|
```
|
|
9067
9467
|
|
|
9068
|
-
_See code: [src/commands/images/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9468
|
+
_See code: [src/commands/images/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/images/list.ts)_
|
|
9069
9469
|
|
|
9070
9470
|
## `codiac images patch IMAGENAME`
|
|
9071
9471
|
|
|
@@ -9095,7 +9495,7 @@ ALIASES
|
|
|
9095
9495
|
$ codiac img patch
|
|
9096
9496
|
```
|
|
9097
9497
|
|
|
9098
|
-
_See code: [src/commands/images/patch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9498
|
+
_See code: [src/commands/images/patch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/images/patch.ts)_
|
|
9099
9499
|
|
|
9100
9500
|
## `codiac images remove IMAGENAME`
|
|
9101
9501
|
|
|
@@ -9121,7 +9521,7 @@ ALIASES
|
|
|
9121
9521
|
$ codiac img delete
|
|
9122
9522
|
```
|
|
9123
9523
|
|
|
9124
|
-
_See code: [src/commands/images/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9524
|
+
_See code: [src/commands/images/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/images/remove.ts)_
|
|
9125
9525
|
|
|
9126
9526
|
## `codiac images version NAME`
|
|
9127
9527
|
|
|
@@ -9147,7 +9547,7 @@ ALIASES
|
|
|
9147
9547
|
$ codiac img version get
|
|
9148
9548
|
```
|
|
9149
9549
|
|
|
9150
|
-
_See code: [src/commands/images/version.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9550
|
+
_See code: [src/commands/images/version.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/images/version.ts)_
|
|
9151
9551
|
|
|
9152
9552
|
## `codiac images version bump NAME`
|
|
9153
9553
|
|
|
@@ -9180,7 +9580,7 @@ ALIASES
|
|
|
9180
9580
|
$ codiac img version bump
|
|
9181
9581
|
```
|
|
9182
9582
|
|
|
9183
|
-
_See code: [src/commands/images/version/bump.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
9583
|
+
_See code: [src/commands/images/version/bump.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/images/version/bump.ts)_
|
|
9184
9584
|
|
|
9185
9585
|
## `codiac img [IMAGENAME]`
|
|
9186
9586
|
|
|
@@ -10295,7 +10695,7 @@ DESCRIPTION
|
|
|
10295
10695
|
Declares the given folder as a project root
|
|
10296
10696
|
```
|
|
10297
10697
|
|
|
10298
|
-
_See code: [src/commands/init.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10698
|
+
_See code: [src/commands/init.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/init.ts)_
|
|
10299
10699
|
|
|
10300
10700
|
## `codiac kit create`
|
|
10301
10701
|
|
|
@@ -10338,7 +10738,7 @@ EXAMPLES
|
|
|
10338
10738
|
$ codiac kit create -e myEnterprise -a myApi --to-script
|
|
10339
10739
|
```
|
|
10340
10740
|
|
|
10341
|
-
_See code: [src/commands/kit/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10741
|
+
_See code: [src/commands/kit/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/kit/create.ts)_
|
|
10342
10742
|
|
|
10343
10743
|
## `codiac login`
|
|
10344
10744
|
|
|
@@ -10397,7 +10797,7 @@ EXAMPLES
|
|
|
10397
10797
|
$ codiac login -u joe.cool@fyaml.dev --password $PW --tokenOut
|
|
10398
10798
|
```
|
|
10399
10799
|
|
|
10400
|
-
_See code: [src/commands/login.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10800
|
+
_See code: [src/commands/login.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/login.ts)_
|
|
10401
10801
|
|
|
10402
10802
|
## `codiac logout`
|
|
10403
10803
|
|
|
@@ -10430,7 +10830,7 @@ EXAMPLES
|
|
|
10430
10830
|
$ codiac logout --to-script
|
|
10431
10831
|
```
|
|
10432
10832
|
|
|
10433
|
-
_See code: [src/commands/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10833
|
+
_See code: [src/commands/logout.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/logout.ts)_
|
|
10434
10834
|
|
|
10435
10835
|
## `codiac merge [BRANCH]`
|
|
10436
10836
|
|
|
@@ -10451,7 +10851,7 @@ DESCRIPTION
|
|
|
10451
10851
|
Merges the given branch into the current branch of the main project and on any sourced dependencies.
|
|
10452
10852
|
```
|
|
10453
10853
|
|
|
10454
|
-
_See code: [src/commands/merge.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10854
|
+
_See code: [src/commands/merge.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/merge.ts)_
|
|
10455
10855
|
|
|
10456
10856
|
## `codiac noc cluster capture`
|
|
10457
10857
|
|
|
@@ -10503,7 +10903,7 @@ EXAMPLES
|
|
|
10503
10903
|
cod cluster capture -n my-cluster -p aws -s 123456789012 -l us-east-1
|
|
10504
10904
|
```
|
|
10505
10905
|
|
|
10506
|
-
_See code: [src/commands/noc/cluster/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10906
|
+
_See code: [src/commands/noc/cluster/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/capture.ts)_
|
|
10507
10907
|
|
|
10508
10908
|
## `codiac noc cluster create [NAME]`
|
|
10509
10909
|
|
|
@@ -10593,7 +10993,7 @@ FLAG DESCRIPTIONS
|
|
|
10593
10993
|
initialization is always skipped in that mode.
|
|
10594
10994
|
```
|
|
10595
10995
|
|
|
10596
|
-
_See code: [src/commands/noc/cluster/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
10996
|
+
_See code: [src/commands/noc/cluster/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/create.ts)_
|
|
10597
10997
|
|
|
10598
10998
|
## `codiac noc cluster credentials-set [NAME]`
|
|
10599
10999
|
|
|
@@ -10648,7 +11048,7 @@ EXAMPLES
|
|
|
10648
11048
|
$ codiac noc cluster credentials-set my-cluster --file ~/.kube/my-cluster.yaml --silent
|
|
10649
11049
|
```
|
|
10650
11050
|
|
|
10651
|
-
_See code: [src/commands/noc/cluster/credentials-set.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11051
|
+
_See code: [src/commands/noc/cluster/credentials-set.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/credentials-set.ts)_
|
|
10652
11052
|
|
|
10653
11053
|
## `codiac noc cluster define [NAME]`
|
|
10654
11054
|
|
|
@@ -10662,7 +11062,8 @@ USAGE
|
|
|
10662
11062
|
--to-script]]
|
|
10663
11063
|
|
|
10664
11064
|
ARGUMENTS
|
|
10665
|
-
NAME Name of the cluster to define
|
|
11065
|
+
NAME Name of the cluster to define. If a definition already exists with this name, it is loaded and opened for
|
|
11066
|
+
editing.
|
|
10666
11067
|
|
|
10667
11068
|
FLAGS
|
|
10668
11069
|
-g, --resourceGroup=<value> (Azure only, required) The resource group associated with the cluster.
|
|
@@ -10703,6 +11104,10 @@ EXAMPLES
|
|
|
10703
11104
|
|
|
10704
11105
|
$ codiac noc cluster define
|
|
10705
11106
|
|
|
11107
|
+
Load and edit an existing cluster definition interactively by name.
|
|
11108
|
+
|
|
11109
|
+
$ codiac noc cluster define my-cluster
|
|
11110
|
+
|
|
10706
11111
|
Define an Azure cluster non-interactively.
|
|
10707
11112
|
|
|
10708
11113
|
$ codiac noc cluster define my-cluster --provider azure --providerSubscription <sub-id> --resourceGroup my-rg \
|
|
@@ -10717,7 +11122,7 @@ EXAMPLES
|
|
|
10717
11122
|
$ codiac noc cluster define my-cluster --to-script
|
|
10718
11123
|
```
|
|
10719
11124
|
|
|
10720
|
-
_See code: [src/commands/noc/cluster/define.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11125
|
+
_See code: [src/commands/noc/cluster/define.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/define.ts)_
|
|
10721
11126
|
|
|
10722
11127
|
## `codiac noc cluster deinit`
|
|
10723
11128
|
|
|
@@ -10757,7 +11162,7 @@ EXAMPLES
|
|
|
10757
11162
|
$ codiac noc cluster deinit -n my-cluster --to-script
|
|
10758
11163
|
```
|
|
10759
11164
|
|
|
10760
|
-
_See code: [src/commands/noc/cluster/deinit.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11165
|
+
_See code: [src/commands/noc/cluster/deinit.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/deinit.ts)_
|
|
10761
11166
|
|
|
10762
11167
|
## `codiac noc cluster destroy [NAME]`
|
|
10763
11168
|
|
|
@@ -10791,7 +11196,7 @@ ALIASES
|
|
|
10791
11196
|
$ codiac cluster destroy
|
|
10792
11197
|
```
|
|
10793
11198
|
|
|
10794
|
-
_See code: [src/commands/noc/cluster/destroy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11199
|
+
_See code: [src/commands/noc/cluster/destroy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/destroy.ts)_
|
|
10795
11200
|
|
|
10796
11201
|
## `codiac noc cluster forget`
|
|
10797
11202
|
|
|
@@ -10842,7 +11247,7 @@ EXAMPLES
|
|
|
10842
11247
|
$ codiac noc cluster forget --running
|
|
10843
11248
|
```
|
|
10844
11249
|
|
|
10845
|
-
_See code: [src/commands/noc/cluster/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11250
|
+
_See code: [src/commands/noc/cluster/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/forget.ts)_
|
|
10846
11251
|
|
|
10847
11252
|
## `codiac noc cluster grant`
|
|
10848
11253
|
|
|
@@ -10880,7 +11285,7 @@ EXAMPLES
|
|
|
10880
11285
|
$ codiac noc cluster grant -c my-cluster -u user@example.com --to-script
|
|
10881
11286
|
```
|
|
10882
11287
|
|
|
10883
|
-
_See code: [src/commands/noc/cluster/grant.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11288
|
+
_See code: [src/commands/noc/cluster/grant.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/grant.ts)_
|
|
10884
11289
|
|
|
10885
11290
|
## `codiac noc cluster init`
|
|
10886
11291
|
|
|
@@ -10926,7 +11331,7 @@ EXAMPLES
|
|
|
10926
11331
|
$ codiac noc cluster init -n my-cluster --to-script
|
|
10927
11332
|
```
|
|
10928
11333
|
|
|
10929
|
-
_See code: [src/commands/noc/cluster/init.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11334
|
+
_See code: [src/commands/noc/cluster/init.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/init.ts)_
|
|
10930
11335
|
|
|
10931
11336
|
## `codiac noc cluster journal [CLUSTER]`
|
|
10932
11337
|
|
|
@@ -10975,7 +11380,7 @@ EXAMPLES
|
|
|
10975
11380
|
$ codiac noc cluster journal -o yaml --silent dev-west-aws-02 > myfiles/journal.yaml
|
|
10976
11381
|
```
|
|
10977
11382
|
|
|
10978
|
-
_See code: [src/commands/noc/cluster/journal.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11383
|
+
_See code: [src/commands/noc/cluster/journal.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/journal.ts)_
|
|
10979
11384
|
|
|
10980
11385
|
## `codiac noc cluster list`
|
|
10981
11386
|
|
|
@@ -11036,7 +11441,7 @@ EXAMPLES
|
|
|
11036
11441
|
$ codiac noc cluster list -e myEnterprise --to-script
|
|
11037
11442
|
```
|
|
11038
11443
|
|
|
11039
|
-
_See code: [src/commands/noc/cluster/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11444
|
+
_See code: [src/commands/noc/cluster/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/list.ts)_
|
|
11040
11445
|
|
|
11041
11446
|
## `codiac noc cluster restore [NAME]`
|
|
11042
11447
|
|
|
@@ -11096,7 +11501,7 @@ EXAMPLES
|
|
|
11096
11501
|
$ codiac noc cluster restore prod-cluster-1 --to-script
|
|
11097
11502
|
```
|
|
11098
11503
|
|
|
11099
|
-
_See code: [src/commands/noc/cluster/restore.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11504
|
+
_See code: [src/commands/noc/cluster/restore.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/noc/cluster/restore.ts)_
|
|
11100
11505
|
|
|
11101
11506
|
## `codiac pkg add [DEFINITIONFILE]`
|
|
11102
11507
|
|
|
@@ -11130,7 +11535,7 @@ DESCRIPTION
|
|
|
11130
11535
|
Configures a package to be built and published by the project.
|
|
11131
11536
|
```
|
|
11132
11537
|
|
|
11133
|
-
_See code: [src/commands/pkg/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11538
|
+
_See code: [src/commands/pkg/add.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pkg/add.ts)_
|
|
11134
11539
|
|
|
11135
11540
|
## `codiac pkg delete [PACKAGENAME]`
|
|
11136
11541
|
|
|
@@ -11168,7 +11573,7 @@ DESCRIPTION
|
|
|
11168
11573
|
Renders the list of packages that are configured as project exports.
|
|
11169
11574
|
```
|
|
11170
11575
|
|
|
11171
|
-
_See code: [src/commands/pkg/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11576
|
+
_See code: [src/commands/pkg/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pkg/list.ts)_
|
|
11172
11577
|
|
|
11173
11578
|
## `codiac pkg patch PACKAGENAME`
|
|
11174
11579
|
|
|
@@ -11194,7 +11599,7 @@ DESCRIPTION
|
|
|
11194
11599
|
registryUrl and/or environment.
|
|
11195
11600
|
```
|
|
11196
11601
|
|
|
11197
|
-
_See code: [src/commands/pkg/patch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11602
|
+
_See code: [src/commands/pkg/patch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pkg/patch.ts)_
|
|
11198
11603
|
|
|
11199
11604
|
## `codiac pkg remove [PACKAGENAME]`
|
|
11200
11605
|
|
|
@@ -11217,7 +11622,7 @@ ALIASES
|
|
|
11217
11622
|
$ codiac pkg delete
|
|
11218
11623
|
```
|
|
11219
11624
|
|
|
11220
|
-
_See code: [src/commands/pkg/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11625
|
+
_See code: [src/commands/pkg/remove.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pkg/remove.ts)_
|
|
11221
11626
|
|
|
11222
11627
|
## `codiac portal`
|
|
11223
11628
|
|
|
@@ -11250,7 +11655,7 @@ EXAMPLES
|
|
|
11250
11655
|
$ codiac portal --to-script
|
|
11251
11656
|
```
|
|
11252
11657
|
|
|
11253
|
-
_See code: [src/commands/portal.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11658
|
+
_See code: [src/commands/portal.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/portal.ts)_
|
|
11254
11659
|
|
|
11255
11660
|
## `codiac probe create [CMD]`
|
|
11256
11661
|
|
|
@@ -11371,7 +11776,7 @@ DESCRIPTION
|
|
|
11371
11776
|
Publishes the exports (packages and images) declared in the ProjectConfig.
|
|
11372
11777
|
```
|
|
11373
11778
|
|
|
11374
|
-
_See code: [src/commands/publish.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11779
|
+
_See code: [src/commands/publish.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/publish.ts)_
|
|
11375
11780
|
|
|
11376
11781
|
## `codiac pull [NAME]`
|
|
11377
11782
|
|
|
@@ -11395,7 +11800,7 @@ DESCRIPTION
|
|
|
11395
11800
|
Pulls all commits from upstream to local.
|
|
11396
11801
|
```
|
|
11397
11802
|
|
|
11398
|
-
_See code: [src/commands/pull.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11803
|
+
_See code: [src/commands/pull.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pull.ts)_
|
|
11399
11804
|
|
|
11400
11805
|
## `codiac pullsecret`
|
|
11401
11806
|
|
|
@@ -11478,7 +11883,7 @@ DESCRIPTION
|
|
|
11478
11883
|
Pushes all local commits upstream.
|
|
11479
11884
|
```
|
|
11480
11885
|
|
|
11481
|
-
_See code: [src/commands/push.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11886
|
+
_See code: [src/commands/push.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/push.ts)_
|
|
11482
11887
|
|
|
11483
11888
|
## `codiac pvc create`
|
|
11484
11889
|
|
|
@@ -11562,7 +11967,7 @@ EXAMPLES
|
|
|
11562
11967
|
$ codiac pvc create -e myEnt --name shared-files --type AzureFileStorage --echo
|
|
11563
11968
|
```
|
|
11564
11969
|
|
|
11565
|
-
_See code: [src/commands/pvc/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
11970
|
+
_See code: [src/commands/pvc/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pvc/create.ts)_
|
|
11566
11971
|
|
|
11567
11972
|
## `codiac pvc delete`
|
|
11568
11973
|
|
|
@@ -11609,7 +12014,7 @@ EXAMPLES
|
|
|
11609
12014
|
$ codiac pvc delete --id <fileStoreDefId> --silent
|
|
11610
12015
|
```
|
|
11611
12016
|
|
|
11612
|
-
_See code: [src/commands/pvc/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12017
|
+
_See code: [src/commands/pvc/delete.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pvc/delete.ts)_
|
|
11613
12018
|
|
|
11614
12019
|
## `codiac pvc get`
|
|
11615
12020
|
|
|
@@ -11650,7 +12055,7 @@ EXAMPLES
|
|
|
11650
12055
|
$ codiac pvc get --name app-documents-share --silent -o json
|
|
11651
12056
|
```
|
|
11652
12057
|
|
|
11653
|
-
_See code: [src/commands/pvc/get.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12058
|
+
_See code: [src/commands/pvc/get.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pvc/get.ts)_
|
|
11654
12059
|
|
|
11655
12060
|
## `codiac pvc list`
|
|
11656
12061
|
|
|
@@ -11693,7 +12098,7 @@ EXAMPLES
|
|
|
11693
12098
|
$ codiac pvc list -o yaml
|
|
11694
12099
|
```
|
|
11695
12100
|
|
|
11696
|
-
_See code: [src/commands/pvc/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12101
|
+
_See code: [src/commands/pvc/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/pvc/list.ts)_
|
|
11697
12102
|
|
|
11698
12103
|
## `codiac relay-version`
|
|
11699
12104
|
|
|
@@ -11710,7 +12115,7 @@ EXAMPLES
|
|
|
11710
12115
|
$ codiac relay-version
|
|
11711
12116
|
```
|
|
11712
12117
|
|
|
11713
|
-
_See code: [src/commands/relay-version.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12118
|
+
_See code: [src/commands/relay-version.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/relay-version.ts)_
|
|
11714
12119
|
|
|
11715
12120
|
## `codiac run`
|
|
11716
12121
|
|
|
@@ -11752,7 +12157,7 @@ DESCRIPTION
|
|
|
11752
12157
|
Runs the latest build of the api container locally.
|
|
11753
12158
|
```
|
|
11754
12159
|
|
|
11755
|
-
_See code: [src/commands/run.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12160
|
+
_See code: [src/commands/run.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/run.ts)_
|
|
11756
12161
|
|
|
11757
12162
|
## `codiac secretStore`
|
|
11758
12163
|
|
|
@@ -11814,7 +12219,7 @@ ALIASES
|
|
|
11814
12219
|
$ codiac secretStore
|
|
11815
12220
|
```
|
|
11816
12221
|
|
|
11817
|
-
_See code: [src/commands/secretStore/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12222
|
+
_See code: [src/commands/secretStore/capture.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/secretStore/capture.ts)_
|
|
11818
12223
|
|
|
11819
12224
|
## `codiac secretStore forget`
|
|
11820
12225
|
|
|
@@ -11835,7 +12240,7 @@ DESCRIPTION
|
|
|
11835
12240
|
Removes the reference to the given secret store for the tenant. Does NOT delete the store itself.
|
|
11836
12241
|
```
|
|
11837
12242
|
|
|
11838
|
-
_See code: [src/commands/secretStore/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12243
|
+
_See code: [src/commands/secretStore/forget.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/secretStore/forget.ts)_
|
|
11839
12244
|
|
|
11840
12245
|
## `codiac secretStore list`
|
|
11841
12246
|
|
|
@@ -11880,7 +12285,7 @@ EXAMPLES
|
|
|
11880
12285
|
$ codiac secretStore list
|
|
11881
12286
|
```
|
|
11882
12287
|
|
|
11883
|
-
_See code: [src/commands/secretStore/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12288
|
+
_See code: [src/commands/secretStore/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/secretStore/list.ts)_
|
|
11884
12289
|
|
|
11885
12290
|
## `codiac shell init`
|
|
11886
12291
|
|
|
@@ -11918,7 +12323,7 @@ EXAMPLES
|
|
|
11918
12323
|
Invoke-Expression (codiac shell init --shell powershell)
|
|
11919
12324
|
```
|
|
11920
12325
|
|
|
11921
|
-
_See code: [src/commands/shell/init.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12326
|
+
_See code: [src/commands/shell/init.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/shell/init.ts)_
|
|
11922
12327
|
|
|
11923
12328
|
## `codiac snapshot deploy`
|
|
11924
12329
|
|
|
@@ -11946,7 +12351,7 @@ DESCRIPTION
|
|
|
11946
12351
|
Deploys all assets in a snapshot to a target cabinet.
|
|
11947
12352
|
```
|
|
11948
12353
|
|
|
11949
|
-
_See code: [src/commands/snapshot/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12354
|
+
_See code: [src/commands/snapshot/deploy.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/snapshot/deploy.ts)_
|
|
11950
12355
|
|
|
11951
12356
|
## `codiac snapshot list`
|
|
11952
12357
|
|
|
@@ -11995,7 +12400,7 @@ EXAMPLES
|
|
|
11995
12400
|
$ codiac snapshot list -e myEnterprise --silent
|
|
11996
12401
|
```
|
|
11997
12402
|
|
|
11998
|
-
_See code: [src/commands/snapshot/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12403
|
+
_See code: [src/commands/snapshot/list.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/snapshot/list.ts)_
|
|
11999
12404
|
|
|
12000
12405
|
## `codiac snapshot tag`
|
|
12001
12406
|
|
|
@@ -12038,7 +12443,7 @@ EXAMPLES
|
|
|
12038
12443
|
$ codiac snapshot tag -e myEnterprise -v 5CJRH7XB -t production --to-script
|
|
12039
12444
|
```
|
|
12040
12445
|
|
|
12041
|
-
_See code: [src/commands/snapshot/tag.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12446
|
+
_See code: [src/commands/snapshot/tag.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/snapshot/tag.ts)_
|
|
12042
12447
|
|
|
12043
12448
|
## `codiac snapshot untag`
|
|
12044
12449
|
|
|
@@ -12081,7 +12486,7 @@ EXAMPLES
|
|
|
12081
12486
|
$ codiac snapshot untag -e myEnterprise -v 5CJRH7XB -t production --to-script
|
|
12082
12487
|
```
|
|
12083
12488
|
|
|
12084
|
-
_See code: [src/commands/snapshot/untag.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12489
|
+
_See code: [src/commands/snapshot/untag.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/snapshot/untag.ts)_
|
|
12085
12490
|
|
|
12086
12491
|
## `codiac stage [FILES]`
|
|
12087
12492
|
|
|
@@ -12103,7 +12508,7 @@ DESCRIPTION
|
|
|
12103
12508
|
Flags files to be included in the next commit.
|
|
12104
12509
|
```
|
|
12105
12510
|
|
|
12106
|
-
_See code: [src/commands/stage.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12511
|
+
_See code: [src/commands/stage.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/stage.ts)_
|
|
12107
12512
|
|
|
12108
12513
|
## `codiac stash [FILE]`
|
|
12109
12514
|
|
|
@@ -12125,7 +12530,7 @@ DESCRIPTION
|
|
|
12125
12530
|
describe the command here
|
|
12126
12531
|
```
|
|
12127
12532
|
|
|
12128
|
-
_See code: [src/commands/stash.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12533
|
+
_See code: [src/commands/stash.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/stash.ts)_
|
|
12129
12534
|
|
|
12130
12535
|
## `codiac status`
|
|
12131
12536
|
|
|
@@ -12144,7 +12549,7 @@ DESCRIPTION
|
|
|
12144
12549
|
Shows the current uncommitted changes in the current branch.
|
|
12145
12550
|
```
|
|
12146
12551
|
|
|
12147
|
-
_See code: [src/commands/status.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12552
|
+
_See code: [src/commands/status.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/status.ts)_
|
|
12148
12553
|
|
|
12149
12554
|
## `codiac stop`
|
|
12150
12555
|
|
|
@@ -12162,7 +12567,7 @@ DESCRIPTION
|
|
|
12162
12567
|
Stops the running container for this project
|
|
12163
12568
|
```
|
|
12164
12569
|
|
|
12165
|
-
_See code: [src/commands/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12570
|
+
_See code: [src/commands/stop.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/stop.ts)_
|
|
12166
12571
|
|
|
12167
12572
|
## `codiac switch [NAME]`
|
|
12168
12573
|
|
|
@@ -12182,7 +12587,7 @@ DESCRIPTION
|
|
|
12182
12587
|
Changes branch on the main project and any sourced dependencies.
|
|
12183
12588
|
```
|
|
12184
12589
|
|
|
12185
|
-
_See code: [src/commands/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12590
|
+
_See code: [src/commands/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/switch.ts)_
|
|
12186
12591
|
|
|
12187
12592
|
## `codiac sync [NAME]`
|
|
12188
12593
|
|
|
@@ -12207,7 +12612,7 @@ DESCRIPTION
|
|
|
12207
12612
|
Merges the given branch into the current branch.
|
|
12208
12613
|
```
|
|
12209
12614
|
|
|
12210
|
-
_See code: [src/commands/sync.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12615
|
+
_See code: [src/commands/sync.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/sync.ts)_
|
|
12211
12616
|
|
|
12212
12617
|
## `codiac tenant create [NAME]`
|
|
12213
12618
|
|
|
@@ -12250,7 +12655,7 @@ EXAMPLES
|
|
|
12250
12655
|
$ codiac tenant create -n 'Acme Corp' -c acme --to-script
|
|
12251
12656
|
```
|
|
12252
12657
|
|
|
12253
|
-
_See code: [src/commands/tenant/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12658
|
+
_See code: [src/commands/tenant/create.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/tenant/create.ts)_
|
|
12254
12659
|
|
|
12255
12660
|
## `codiac tenant switch [CODE]`
|
|
12256
12661
|
|
|
@@ -12290,7 +12695,7 @@ EXAMPLES
|
|
|
12290
12695
|
$ codiac tenant switch my-tenant-code --to-script
|
|
12291
12696
|
```
|
|
12292
12697
|
|
|
12293
|
-
_See code: [src/commands/tenant/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12698
|
+
_See code: [src/commands/tenant/switch.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/tenant/switch.ts)_
|
|
12294
12699
|
|
|
12295
12700
|
## `codiac token [TOKENNAME]`
|
|
12296
12701
|
|
|
@@ -12412,7 +12817,7 @@ DESCRIPTION
|
|
|
12412
12817
|
Flags files to be included in the next commit.
|
|
12413
12818
|
```
|
|
12414
12819
|
|
|
12415
|
-
_See code: [src/commands/unstage.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
12820
|
+
_See code: [src/commands/unstage.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/unstage.ts)_
|
|
12416
12821
|
|
|
12417
12822
|
## `codiac update [CHANNEL]`
|
|
12418
12823
|
|
|
@@ -12599,7 +13004,7 @@ EXAMPLES
|
|
|
12599
13004
|
$ codiac whereami --to-script
|
|
12600
13005
|
```
|
|
12601
13006
|
|
|
12602
|
-
_See code: [src/commands/whereami.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
13007
|
+
_See code: [src/commands/whereami.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/whereami.ts)_
|
|
12603
13008
|
|
|
12604
13009
|
## `codiac whoami`
|
|
12605
13010
|
|
|
@@ -12641,5 +13046,5 @@ EXAMPLES
|
|
|
12641
13046
|
$ codiac whoami --to-script
|
|
12642
13047
|
```
|
|
12643
13048
|
|
|
12644
|
-
_See code: [src/commands/whoami.ts](https://github.com/codiac/codiac-cli/blob/v1.3.
|
|
13049
|
+
_See code: [src/commands/whoami.ts](https://github.com/codiac/codiac-cli/blob/v1.3.204/src/commands/whoami.ts)_
|
|
12645
13050
|
<!-- commandsstop -->
|