Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Visualize graphs on command line #75

Merged
merged 16 commits into from
Jun 18, 2021
Merged

Visualize graphs on command line #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4ab2b4e
[wip]: Visualize graphs on command line
kumare3 May 28, 2021
6b57157
[wip] working version
kumare3 May 31, 2021
cc9c35a
updated
kumare3 May 31, 2021
b8908c1
Working nested graphs - v0
kumare3 Jun 1, 2021
6f05a5e
better graph
kumare3 Jun 1, 2021
ad4d4c3
update todos
kumare3 Jun 1, 2021
644ff2b
improved graph
kumare3 Jun 1, 2021
d420faf
Working with subworkflows
kumare3 Jun 1, 2021
7dbb47b
subworkflows rendering
kumare3 Jun 1, 2021
517f539
Using go graphviz library to print dot file (#97)
pmahindrakar-oss Jun 17, 2021
b347c0c
Added output option for dot and doturl (#101)
pmahindrakar-oss Jun 17, 2021
af5fc12
Graphviz interfaces and unit tests (#106)
pmahindrakar-oss Jun 18, 2021
f4711af
Added more coverage
pmahindrakar-oss Jun 18, 2021
731bcc6
Fixed the doc
pmahindrakar-oss Jun 18, 2021
f85d6b6
Generated the docs
pmahindrakar-oss Jun 18, 2021
9d1c85a
Fixed the docs
pmahindrakar-oss Jun 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions cmd/config/subcommand/workflow/config_flags.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions cmd/config/subcommand/workflow/workflow_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package workflow

import "github.com/flyteorg/flytectl/pkg/filters"
import (
"github.com/flyteorg/flytectl/pkg/filters"
)

//go:generate pflags Config --default-var DefaultConfig
//go:generate pflags Config --default-var DefaultConfig --bind-default-var

var (
DefaultConfig = &Config{
Expand Down
12 changes: 12 additions & 0 deletions cmd/get/workflow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,18 @@ Retrieves all the workflow within project and domain in json format.

flytectl get workflow -p flytesnacks -d development -o json

Visualize the graph for a workflow within project and domain in dot format.

::

flytectl get workflow -p flytesnacks -d development core.flyte_basics.basic_workflow.my_wf --latest -o dot

Visualize the graph for a workflow within project and domain in a dot content render.

::

flytectl get workflow -p flytesnacks -d development core.flyte_basics.basic_workflow.my_wf --latest -o doturl

Usage
`
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func newRootCmd() *cobra.Command {
// --root.project, this adds a convenience on top to allow --project to be used
rootCmd.PersistentFlags().StringVarP(&(config.GetConfig().Project), "project", "p", "", "Specifies the Flyte project.")
rootCmd.PersistentFlags().StringVarP(&(config.GetConfig().Domain), "domain", "d", "", "Specifies the Flyte project's domain.")
rootCmd.PersistentFlags().StringVarP(&(config.GetConfig().Output), "output", "o", printer.OutputFormatTABLE.String(), fmt.Sprintf("Specifies the output type - supported formats %s", printer.OutputFormats()))
rootCmd.PersistentFlags().StringVarP(&(config.GetConfig().Output), "output", "o", printer.OutputFormatTABLE.String(), fmt.Sprintf("Specifies the output type - supported formats %s. NOTE: dot, doturl are only supported for Workflow", printer.OutputFormats()))
rootCmd.AddCommand(viper.GetConfigCommand())
rootCmd.AddCommand(get.CreateGetCommand())
rootCmd.AddCommand(create.RemoteCreateCommand())
Expand Down
5 changes: 3 additions & 2 deletions docs/source/gen/flytectl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Options
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
-h, --help help for flytectl
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand All @@ -64,6 +64,7 @@ SEE ALSO
* :doc:`flytectl_delete` - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project.
* :doc:`flytectl_get` - Used for fetching various flyte resources including tasks/workflows/launchplans/executions/project.
* :doc:`flytectl_register` - Registers tasks/workflows/launchplans from list of generated serialized files.
* :doc:`flytectl_sandbox` - Used for testing flyte sandbox.
* :doc:`flytectl_update` - Used for updating flyte resources eg: project.
* :doc:`flytectl_version` - Used for fetching flyte version

4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_config_discover.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--file stringArray Passes the config file to load.
If empty, it'll first search for the config file path then, if found, will load config from there.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_config_validate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--file stringArray Passes the config file to load.
If empty, it'll first search for the config file path then, if found, will load config from there.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_create.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_create_execution.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,13 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_create_project.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_delete.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ Options inherited from parent commands
--admin.scopes strings List of scopes to request
--admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided.
--admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information.
--config string config file (default is $HOME/.flyte/config.yaml)
-c, --config string config file (default is $HOME/.flyte/config.yaml)
-d, --domain string Specifies the Flyte project's domain.
--logger.formatter.type string Sets logging format type. (default "json")
--logger.level int Sets the minimum logging level. (default 4)
--logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only.
--logger.show-source Includes source code location in logs.
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML] (default "TABLE")
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
-p, --project string Specifies the Flyte project.
--root.domain string Specified the domain to work on.
--root.output string Specified the output type.
Expand Down
Loading