You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/30_commands.md
+45-2Lines changed: 45 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -514,6 +514,50 @@ Available flags for the command:
514
514
-`--context`, to specify a different context from the currently selected one
515
515
-`--company-id`, to set the ID of the desired Company
516
516
517
+
### describe
518
+
519
+
The `project describe` subcommand allows you to inspect the current configuration of an Application Project in Console.
520
+
521
+
Specify the correct flags to indicate which revision/version/branch/tag to describe.
522
+
523
+
For Application Projects using Enhanced Workflow specify either the `revision` or `version` flag. For Projects using the standard workflow specify either the `branch` or `tag` flag.
524
+
525
+
If no configuration is found for the specified revision/version/branch/tag flag, an empty configuration is returned.
526
+
527
+
Usage:
528
+
529
+
```sh
530
+
miactl project describe [flags]
531
+
```
532
+
533
+
Flags available for this command:
534
+
535
+
-`--project-id`: required. The ID of the Application Project to describe
536
+
-`--revision`: for projects using Enhanced Workflow. The revision of the Application Project to describe
537
+
-`--version`: for projects using Enhanced Workflow. The version of the Application Project to describe
538
+
-`--branch`: for projects using the standard workflow. The branch of the Application Project to describe
539
+
-`--tag`: for projects using the standard workflow. The tag of the Application Project to describe
540
+
-`--output` or `-o`: output format. Allowed values: json, yaml (default is "json")
541
+
542
+
### apply
543
+
544
+
The `project apply` subcommand allows you to update an already existing Application Project configuration by providing a valid configuration file from your local machine. This command creates a new snapshot for the specified ref using the provided configuration overriding the previous configuration.
545
+
546
+
This feature is available only for Application Projects using Enhanced Workflow.
547
+
548
+
Usage:
549
+
550
+
```sh
551
+
miactl project apply [flags]
552
+
```
553
+
554
+
Flags available for this command:
555
+
556
+
-`--project-id`: required. The ID of the Application Project
557
+
-`--revision`: required. The revision of the Application Project
558
+
-`--file` or `-f`: required. The path to the configuration file. Supported formats for configuration file are yaml and json
559
+
-`--message` or `-m`: the custom message used to save the configuration. If not specified, a default message is used
560
+
517
561
### iam
518
562
519
563
The `project iam` subcommands are used for managing the RBAC permissions associated with a project. Only
@@ -600,8 +644,7 @@ Available flags for the command:
600
644
601
645
### import
602
646
603
-
The `project import` subcommand allows you to import kubernetes resource yaml definition in an empty Mia-Platform Console
604
-
project.
647
+
The `project import` subcommand allows you to import kubernetes resource yaml definition in an empty Mia-Platform Console project.
605
648
606
649
The import function is lossy and some advanced configuration can be lost. We recommend to check the generated file
607
650
before trying a deploy to check if anything is amiss.
0 commit comments