add graph subcommand that ouputs the installer's internal dependency graph

[abhinavdahiya]

/cc @wking @crawford

[smarterclayton]

/retest

[wking]

To stay DRY, we should put these lists under variables in targets.go. Maybe:

type target struct {
  name string
  command *cobra.Command
  assets []asset.Asset
}

var targets := map[string]target{
  "install-config": {
    name: "Install Config",
    command: &cobra.Command{
      Use:   "install-config",
      Short: "Generates the Install Config asset",
    },
    assets: {&installconfig.InstallConfig{}},
  },
  ...
}

Then in main():

for key, target := range targets { // maybe after sorting?
  target.command.RunE = runTargetCmd(target.assets...)
  subCmds = append(subCmds, target.command)
}

[abhinavdahiya]

done.

[wking]

Do we need PkgPath? elem.Name seems fairly unique on its own. Or maybe make the displayed name elem.Name, but make the node href point to the associated godocs? For SVG output (and anything else that supports hrefs) that would give you a compact display with fully-qualified names available as needed to clickers and hoverrers.

[abhinavdahiya]

It adds context if anybody wants to find the asset.

[wking]

This still duplicates the assets peoperty two lines below. Not a big deal, because they're so close together, but does building RunE on the fly not work?

[abhinavdahiya]

fixed, forgot to remove that.

[wking]

The trim leaves this without the required leading quote. And I'd still prefer context via URL. Something like:

InstallConfig [URL="https://godoc.org/github.com/openshift/installer/pkg/asset/installconfig#InstallConfig"]

For private classes, maybe just link to the package?

To make it easier to tune this, maybe add a new commit updating our dependency SVG and dropping our current hand-coded dot source?

[abhinavdahiya]

dropped the name to just name of elem for now. we can iterate over the url stuff later.
Also adding the commit for replacing existing graph in docs.

[abhinavdahiya]

@wking updated to include doc.

[abhinavdahiya]

github.com/awalterschulze/gographviz cannot print strict digraph.

[wking]

I think we can drop resource_dep.dot from version control and just use:

bin/openshift-install graph | dot -Tsvg >docs/design/resource_dep.svg

Also, with sh highlighting, you don't want the $ prompts (more on sh vs. console in #27.

[abhinavdahiya]

@wking done.

[wking]

/lgtm

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abhinavdahiya, wking

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [abhinavdahiya,wking]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[abhinavdahiya]

/test e2e-aws

[openshift-bot]

/retest

Please review the full test history for this PR and help us cut down flakes.

[wking]

e2e:

Ran for 41s
error: could not run steps: could not wait for template instance to be ready: could not determine if template instance was ready: failed to create objects: object is being deleted: pods "e2e-aws" already exists