Skip to content

Commit

Permalink
Clarify namespace flags (#284)
Browse files Browse the repository at this point in the history 
* Clarify namespace flags

* Update common/defs-flags.go

Co-authored-by: Loren ☺️ <251288+lorensr@users.noreply.github.com>

---------

Co-authored-by: Loren ☺️ <251288+lorensr@users.noreply.github.com>
  • Loading branch information
@feedmeapples @lorensr
feedmeapples and lorensr committed Jul 12, 2023
1 parent 87b78d4 commit b21ddf1
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 23 deletions.
15 changes: 15 additions & 0 deletions common/defs-flags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,21 @@ const (
FlagTaskQueueName = "Name of the Task Queue."
FlagTaskQueueTypeDefinition = "Task Queue type [workflow|activity]"

// Namespace update flags
FlagActiveClusterDefinition = "Active cluster name."
FlagClusterDefinition = "Cluster name."
FlagDescriptionDefinition = "Namespace description."
FlagHistoryArchivalStateDefinition = "History archival state, valid values are \"disabled\" and \"enabled\""
FlagHistoryArchivalURIDefinition = "Optionally specify history archival URI (cannot be changed after first time archival is enabled)"
FlagIsGlobalNamespaceDefinition = "Whether the namespace is a global namespace."
FlagNamespaceDataDefinition = "Namespace data in key=value format. Use JSON for values."
FlagNamespaceVerboseDefinition = "Print applied namespace changes"
FlagOwnerDefinition = "Owner email."
FlagPromoteNamespaceDefinition = "Promote local namespace to global namespace"
FlagRetentionDefinition = "Length of time (in days) a closed Workflow is preserved before deletion."
FlagVisibilityArchivalStateDefinition = "Visibility archival state, valid values are \"disabled\" and \"enabled\""
FlagVisibilityArchivalURIDefinition = "Optionally specify visibility archival URI (cannot be changed after first time archival is enabled)"

// Build id based versioning flags
FlagNewBuildIDUsage = "The new build id to be added."
FlagExistingCompatibleBuildIDUsage = "A build id which must already exist in the version sets known by the task queue. The new id will be stored in the set containing this id, marking it as compatible with the versions within."
Expand Down
46 changes: 23 additions & 23 deletions namespace/namespace_utils.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,121 +9,121 @@ var (
createNamespaceFlags = []cli.Flag{
&cli.StringFlag{
Name: common.FlagDescription,
Usage: "Namespace description",
Usage: common.FlagDescriptionDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagOwnerEmail,
Usage: "Owner email",
Usage: common.FlagOwnerDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagRetention,
Usage: "Workflow Execution retention",
Usage: common.FlagRetentionDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagActiveCluster,
Usage: "Active cluster name",
Usage: common.FlagActiveClusterDefinition,
Category: common.CategoryMain,
},
&cli.StringSliceFlag{
Name: common.FlagCluster,
Usage: "Cluster name",
Usage: common.FlagClusterDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagIsGlobalNamespace,
Usage: "Flag to indicate whether namespace is a global namespace",
Usage: common.FlagIsGlobalNamespaceDefinition,
Category: common.CategoryMain,
},
&cli.StringSliceFlag{
Name: common.FlagNamespaceData,
Usage: "Namespace data in a format key=value",
Usage: common.FlagNamespaceDataDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagHistoryArchivalState,
Usage: "Flag to set history archival state, valid values are \"disabled\" and \"enabled\"",
Usage: common.FlagHistoryArchivalStateDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagHistoryArchivalURI,
Usage: "Optionally specify history archival URI (cannot be changed after first time archival is enabled)",
Usage: common.FlagHistoryArchivalURIDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagVisibilityArchivalState,
Usage: "Flag to set visibility archival state, valid values are \"disabled\" and \"enabled\"",
Usage: common.FlagVisibilityArchivalStateDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagVisibilityArchivalURI,
Usage: "Optionally specify visibility archival URI (cannot be changed after first time archival is enabled)",
Usage: common.FlagVisibilityArchivalURIDefinition,
Category: common.CategoryMain,
},
}

updateNamespaceFlags = []cli.Flag{
&cli.StringFlag{
Name: common.FlagDescription,
Usage: "Namespace description",
Usage: common.FlagDescriptionDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagOwnerEmail,
Usage: "Owner email",
Usage: common.FlagOwnerDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagRetention,
Usage: "Length of time (in days) a closed Workflow is preserved before deletion",
Usage: common.FlagRetentionDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagActiveCluster,
Usage: "Active cluster name",
Usage: common.FlagActiveClusterDefinition,
Category: common.CategoryMain,
},
&cli.StringSliceFlag{
Name: common.FlagCluster,
Usage: "Cluster name",
Usage: common.FlagClusterDefinition,
Category: common.CategoryMain,
},
&cli.StringSliceFlag{
Name: common.FlagNamespaceData,
Usage: "Namespace data in a format key=value",
Usage: common.FlagNamespaceDataDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagHistoryArchivalState,
Usage: "Flag to set history archival state, valid values are \"disabled\" and \"enabled\"",
Usage: common.FlagHistoryArchivalStateDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagHistoryArchivalURI,
Usage: "Optionally specify history archival URI (cannot be changed after first time archival is enabled)",
Usage: common.FlagHistoryArchivalURIDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagVisibilityArchivalState,
Usage: "Flag to set visibility archival state, valid values are \"disabled\" and \"enabled\"",
Usage: common.FlagVisibilityArchivalStateDefinition,
Category: common.CategoryMain,
},
&cli.StringFlag{
Name: common.FlagVisibilityArchivalURI,
Usage: "Optionally specify visibility archival URI (cannot be changed after first time archival is enabled)",
Usage: common.FlagVisibilityArchivalURIDefinition,
Category: common.CategoryMain,
},
&cli.BoolFlag{
Name: common.FlagPromoteNamespace,
Usage: "Promote local namespace to global namespace",
Usage: common.FlagPromoteNamespaceDefinition,
Category: common.CategoryMain,
},
&cli.BoolFlag{
Name: common.FlagVerbose,
Aliases: common.FlagVerboseAlias,
Usage: "Print applied namespace changes",
Usage: common.FlagNamespaceVerboseDefinition,
Category: common.CategoryDisplay,
},
}
Expand Down

0 comments on commit b21ddf1

Please sign in to comment.