feat: add deployment flag for printing out the graph of resources #1064

erikmiller-gusto · 2025-04-30T03:46:20Z

What this PR does / why we need it:

Adds a deployment flag for printing out the graph of resources
This allows for loading the graph data into visualization tools and to better reason about the ordering of a deployment

Does this PR introduce a user-facing change?

Add new deploy flag --change-graph-file-output
Allows for printing out the graph of changes that will be performed in the deployment

Additional Notes for your reviewer:

Review Checklist:

Follows the developer guidelines
Relevant tests are added or updated
Relevant docs in this repo added or updated
Relevant carvel.dev docs added or updated in a separate PR and there's
a link to that PR
Code is at least as readable and maintainable as it was before this
change

Additional documentation e.g., Proposal, usage docs, etc.:

joaopapereira

Thanks for creating the PR. I added some questions and suggestions, but can you please provide an example of the output?

joaopapereira · 2025-04-30T15:43:02Z

pkg/kapp/cmd/app/deploy.go

 		return err
 	}

+	if o.DeployFlags.ChangeGraphFile != "" {


Any particular reason we do this check in this line and in line 528?

having it here makes it clear what the cli logic actually does. The check in the writeChangeGraphToFile was purely defensive/copying the pattern of writeAppMetadataToFile. Happy to remove that to remove any confusion

joaopapereira · 2025-04-30T15:44:13Z

pkg/kapp/cmd/app/deploy_flags.go

 	cmd.Flags().BoolVar(&s.DisableGKScoping, "dangerous-disable-gk-scoping",
 		false, "Disable scoping of resource searching to used GroupKinds")
+
+	cmd.Flags().StringVar(&s.ChangeGraphFile, "change-graph-file-output", "", "Render the deployment graph to a file")


Would it make sense that this option would only print the graph and not apply it?

I see it as option to print out the graph that will be used to apply. This flag can then be used either with the apply or with the --diff-run. The hope is to be able to use the information in the graph to display the plan for review ahead of time and use it to show progress of the deployment when it's being applied

joaopapereira · 2025-04-30T15:46:02Z

pkg/kapp/cmd/app/deploy.go

 	return nil
 }

+func (o *DeployOptions) writeChangeGraphToFile(graph *ctldgraph.ChangeGraph) error {


I think that this function makes more sense to be part of the carvel.dev/kapp/pkg/kapp/diffgraph package

joaopapereira · 2025-04-30T15:46:20Z

pkg/kapp/cmd/app/deploy.go

 	cmdtools "carvel.dev/kapp/pkg/kapp/cmd/tools"
 	ctlconf "carvel.dev/kapp/pkg/kapp/config"
 	ctldiff "carvel.dev/kapp/pkg/kapp/diff"
+	"carvel.dev/kapp/pkg/kapp/diffgraph"


Isn't this import the same as the next line?

IDE snafu, will remove

erikmiller-gusto

Example output

{
  "nodes": [
    {
      "id": "v1.6a86088b196cff2407b0eb62e4ea2c30",
      "data": {
        "name": "localstack-aws-secret",
        "namespace": "default",
        "changeGroups": [
          "change-groups.kapp.k14s.io/pod-related"
        ],
        "groupKind": {
          "group": "",
          "kind": "Secret"
        },
        "op": "upsert"
      }
    },
    {
      "id": "v1.f3b750c8ef32f6f406ad8f65f507c5bd",
      "data": {
        "name": "provider-kubernetes-admin-binding",
        "namespace": null,
        "changeGroups": [
          "change-groups.kapp.k14s.io/rbac-role-bindings",
          "change-groups.kapp.k14s.io/rbac"
        ],
        "groupKind": {
          "group": "rbac.authorization.k8s.io",
          "kind": "ClusterRoleBinding"
        },
        "op": "upsert"
      }
    },
    {
      "id": "v1.13f78867be9c1e85b4e0ff14ddde74d5",
      "data": {
        "name": "xservicecomposition.example.com",
        "namespace": null,
        "changeGroups": [
          "example.com/crossplane-xrds"
        ],
        "groupKind": {
          "group": "apiextensions.crossplane.io",
          "kind": "CompositeResourceDefinition"
        },
        "op": "upsert"
      }
    }
  ],
  "edges": [
    {
      "source": "v1.6a86088b196cff2407b0eb62e4ea2c30",
      "target": "v1.f3b750c8ef32f6f406ad8f65f507c5bd"
    }
  ]
}

erikmiller-gusto · 2025-04-30T18:26:07Z

pkg/kapp/cmd/app/deploy_flags.go

 	cmd.Flags().BoolVar(&s.DisableGKScoping, "dangerous-disable-gk-scoping",
 		false, "Disable scoping of resource searching to used GroupKinds")
+
+	cmd.Flags().StringVar(&s.ChangeGraphFile, "change-graph-file-output", "", "Render the deployment graph to a file")


I see it as option to print out the graph that will be used to apply. This flag can then be used either with the apply or with the --diff-run. The hope is to be able to use the information in the graph to display the plan for review ahead of time and use it to show progress of the deployment when it's being applied

erikmiller-gusto · 2025-04-30T18:28:23Z

pkg/kapp/cmd/app/deploy.go

 		return err
 	}

+	if o.DeployFlags.ChangeGraphFile != "" {


having it here makes it clear what the cli logic actually does. The check in the writeChangeGraphToFile was purely defensive/copying the pattern of writeAppMetadataToFile. Happy to remove that to remove any confusion

erikmiller-gusto · 2025-04-30T18:28:54Z

pkg/kapp/cmd/app/deploy.go

 	cmdtools "carvel.dev/kapp/pkg/kapp/cmd/tools"
 	ctlconf "carvel.dev/kapp/pkg/kapp/config"
 	ctldiff "carvel.dev/kapp/pkg/kapp/diff"
+	"carvel.dev/kapp/pkg/kapp/diffgraph"


IDE snafu, will remove

joaopapereira

Sorry for not pointing this out earlier, but do you mind adding 1 or 2 tests just to ensure that the functionality is working as expected?
The PR code as a whole looks good

This allows for loading the graph data into visualization tools and to better reason about the ordering of a deployment Signed-off-by: Erik Miller <[email protected]>

erikmiller-gusto · 2025-05-02T17:19:58Z

@joaopapereira seems like the test that's failing was already failing on mainline
https://github.com/carvel-dev/kapp/actions/runs/14644823758/job/41099267984

joaopapereira · 2025-05-02T18:33:30Z

@erikmiller-gusto yes I am aware, @devanshuVmware is looking into it and when he gets it fixed we can rebase your PR

erikmiller-gusto · 2025-09-25T17:04:34Z

@joaopapereira @devanshuVmware any update on that?

carvel-bot added this to Carvel Apr 30, 2025

erikmiller-gusto force-pushed the develop branch from f0af80a to 941b555 Compare April 30, 2025 03:47

joaopapereira requested changes Apr 30, 2025

View reviewed changes

github-project-automation bot moved this to In Progress in Carvel Apr 30, 2025

erikmiller-gusto commented Apr 30, 2025

View reviewed changes

erikmiller-gusto force-pushed the develop branch from 941b555 to 4162098 Compare April 30, 2025 18:38

erikmiller-gusto requested a review from joaopapereira April 30, 2025 18:38

joaopapereira requested changes May 1, 2025

View reviewed changes

erikmiller-gusto force-pushed the develop branch from 4162098 to 6e41a72 Compare May 1, 2025 15:38

erikmiller-gusto requested a review from joaopapereira May 1, 2025 15:39

feat: add deployment flag for printing out the graph of resources

042d678

This allows for loading the graph data into visualization tools and to better reason about the ordering of a deployment Signed-off-by: Erik Miller <[email protected]>

erikmiller-gusto force-pushed the develop branch from 6e41a72 to 042d678 Compare May 1, 2025 15:43

feat: add deployment flag for printing out the graph of resources #1064

Are you sure you want to change the base?

feat: add deployment flag for printing out the graph of resources #1064

Uh oh!

Conversation

erikmiller-gusto commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Does this PR introduce a user-facing change?

Additional Notes for your reviewer:

Review Checklist:

Additional documentation e.g., Proposal, usage docs, etc.:

Uh oh!

joaopapereira left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

erikmiller-gusto left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joaopapereira left a comment

Choose a reason for hiding this comment

Uh oh!

erikmiller-gusto commented May 2, 2025

Uh oh!

joaopapereira commented May 2, 2025

Uh oh!

erikmiller-gusto commented Sep 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

erikmiller-gusto commented Apr 30, 2025 •

edited

Loading

erikmiller-gusto left a comment •

edited

Loading