Feat: get raw Application yaml, json or jsonpath #4415
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
charlie0129
changed the title
Codecov Report
@@ Coverage Diff @@
## master #4415 +/- ##
==========================================
+ Coverage 59.38% 61.50% +2.12%
==========================================
Files 342 347 +5
Lines 34115 34260 +145
==========================================
+ Hits 20258 21073 +815
+ Misses 11201 10443 -758
- Partials 2656 2744 +88
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
charlie0129
requested review from
Somefive,
zzxwill and
StevenLeiZhang
as code owners
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
|
Great job! Please trim the managedFields. |
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
Sure, gone are the managedFields now. |
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
barnettZQG
reviewed
Jul 21, 2022
| @@ -118,6 +136,9 @@ func NewAppStatusCommand(c common.Args, order string, ioStreams cmdutil.IOStream | |||
| if err != nil { | |||
| return err | |||
| } | |||
| if outputFormat != "" { | |||
| return printRawApplication(context.Background(), c, outputFormat, cmd.OutOrStdout(), namespace, appName) | |||
There was a problem hiding this comment.
Does "showEndpoints" still work? if "return" here.
There was a problem hiding this comment.
No, this is intended.
If the user wants raw output, then the endpoints table will be purely noise to them.
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
Signed-off-by: Charlie Chiang <charlie_c_0129@outlook.com>
Somefive
approved these changes
Jul 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Charlie Chiang charlie_c_0129@outlook.com
Description of your changes
Added support for getting raw Application yaml in Vela CLI, via
-o--outputparameter.Looking at some examples will give you a better understanding:
Get whole Application in
yamlvela status first-vela-app -o yamlClick to see command output
Get whole Application in
jsonvela status first-vela-app -o jsonClick to see command output
{ "kind": "Application", "apiVersion": "core.oam.dev/v1beta1", "metadata": { "name": "first-vela-app", "namespace": "default", "uid": "63032d71-85c2-4571-8d81-56b7370bb113", "resourceVersion": "4535251", "generation": 1, "creationTimestamp": "2022-07-20T08:57:46Z", "labels": { "oam.dev/render-hash": "ea855623cc3ffbb9" }, "annotations": { "app.oam.dev/last-applied-configuration": "{\"kind\":\"Application\",\"apiVersion\":\"core.oam.dev/v1beta1\",\"metadata\":{\"name\":\"first-vela-app\",\"namespace\":\"default\",\"creationTimestamp\":null,\"labels\":{\"oam.dev/render-hash\":\"ea855623cc3ffbb9\"}},\"spec\":{\"components\":[{\"name\":\"express-server\",\"type\":\"webservice\",\"properties\":{\"image\":\"oamdev/hello-world\",\"ports\":[{\"expose\":true,\"port\":8000}]},\"traits\":[{\"type\":\"scaler\",\"properties\":{\"replicas\":1}}]}],\"policies\":[{\"name\":\"target-default\",\"type\":\"topology\",\"properties\":{\"clusters\":[\"local\"],\"namespace\":\"default\"}}]},\"status\":{}}", "app.oam.dev/last-applied-time": "2022-07-20T16:57:46+08:00", "oam.dev/kubevela-version": "v1.4.0" }, "finalizers": [ "app.oam.dev/resource-tracker-finalizer" ] }, "spec": { "components": [ { "name": "express-server", "type": "webservice", "properties": { "image": "oamdev/hello-world", "ports": [ { "expose": true, "port": 8000 } ] }, "traits": [ { "type": "scaler", "properties": { "replicas": 1 } } ] } ], "policies": [ { "name": "target-default", "type": "topology", "properties": { "clusters": [ "local" ], "namespace": "default" } } ] }, "status": { "conditions": [ { "type": "Parsed", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Revision", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Policy", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Render", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Workflow", "status": "True", "lastTransitionTime": "2022-07-20T08:57:55Z", "reason": "Available" }, { "type": "Ready", "status": "True", "lastTransitionTime": "2022-07-20T08:57:55Z", "reason": "ReconcileSuccess" } ], "observedGeneration": 1, "status": "running", "services": [ { "name": "express-server", "namespace": "default", "cluster": "local", "workloadDefinition": { "apiVersion": "apps/v1", "kind": "Deployment" }, "healthy": true, "message": "Ready:1/1", "traits": [ { "type": "scaler", "healthy": true } ] } ], "workflow": { "appRevision": "first-vela-app-v1:630c401488fe8a9", "mode": "DAG", "message": "Succeeded", "suspend": false, "terminated": false, "finished": true, "contextBackend": { "name": "workflow-first-vela-app-context", "uid": "a321f89e-2c9c-40ea-81ab-27d6e8a5d273" }, "steps": [ { "id": "ega2uspq28", "name": "deploy-target-default", "type": "deploy", "phase": "succeeded", "firstExecuteTime": "2022-07-20T08:57:46Z", "lastExecuteTime": "2022-07-20T08:57:55Z" } ], "startTime": "2022-07-20T08:57:46Z" }, "latestRevision": { "name": "first-vela-app-v1", "revision": 1, "revisionHash": "8ad93499a2dc2fa9" }, "appliedResources": [ { "cluster": "local", "creator": "workflow", "kind": "Deployment", "namespace": "default", "name": "express-server", "apiVersion": "apps/v1" }, { "cluster": "local", "creator": "workflow", "kind": "Service", "namespace": "default", "name": "express-server", "apiVersion": "v1" } ] } }Quickly check Application
statususingjsonpathvela status first-vela-app -o jsonpath='{.status}' | jqClick to see command output
{ "conditions": [ { "type": "Parsed", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Revision", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Policy", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Render", "status": "True", "lastTransitionTime": "2022-07-20T08:57:46Z", "reason": "Available" }, { "type": "Workflow", "status": "True", "lastTransitionTime": "2022-07-20T08:57:55Z", "reason": "Available" }, { "type": "Ready", "status": "True", "lastTransitionTime": "2022-07-20T08:57:55Z", "reason": "ReconcileSuccess" } ], "observedGeneration": 1, "status": "running", "services": [ { "name": "express-server", "namespace": "default", "cluster": "local", "workloadDefinition": { "apiVersion": "apps/v1", "kind": "Deployment" }, "healthy": true, "message": "Ready:1/1", "traits": [ { "type": "scaler", "healthy": true } ] } ], "workflow": { "appRevision": "first-vela-app-v1:630c401488fe8a9", "mode": "DAG", "message": "Succeeded", "suspend": false, "terminated": false, "finished": true, "contextBackend": { "name": "workflow-first-vela-app-context", "uid": "a321f89e-2c9c-40ea-81ab-27d6e8a5d273" }, "steps": [ { "id": "ega2uspq28", "name": "deploy-target-default", "type": "deploy", "phase": "succeeded", "firstExecuteTime": "2022-07-20T08:57:46Z", "lastExecuteTime": "2022-07-20T08:57:55Z" } ], "startTime": "2022-07-20T08:57:46Z" }, "latestRevision": { "name": "first-vela-app-v1", "revision": 1, "revisionHash": "8ad93499a2dc2fa9" }, "appliedResources": [ { "cluster": "local", "creator": "workflow", "kind": "Deployment", "namespace": "default", "name": "express-server", "apiVersion": "apps/v1" }, { "cluster": "local", "creator": "workflow", "kind": "Service", "namespace": "default", "name": "express-server", "apiVersion": "v1" } ] }Only the above three formats are supported in
-o--outputoption.Fixes #4235
I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested
Manually tested with possible user inputs. Unit tests for the util function are added.
Special notes for your reviewer
There is a
--detail-formatflag mentioned in the original issue. I didn't use it because it serves a different purpose.