Added docs

Signed-off-by: Prafulla Mahindrakar <[email protected]>
flyteorg · Apr 18, 2021 · a70f997 · a70f997
1 parent c92ddf1
commit a70f997
Show file tree

Hide file tree

Showing 7 changed files with 286 additions and 4 deletions.
diff --git a/cmd/update/launch_plan.go b/cmd/update/launch_plan.go
@@ -13,7 +13,6 @@ import (
 const (
 	updateLPShort = "Updates launch plan metadata"
 	updateLPLong  = `
-Updates launchplan metadata.
 Following command updates the description on the launchplan.
 ::
 

diff --git a/cmd/update/task.go b/cmd/update/task.go
@@ -13,7 +13,6 @@ import (
 const (
 	updateTaskShort = "Updates task metadata"
 	updateTaskLong  = `
-Updates task metadata.
 Following command updates the description on the task.
 ::
 

diff --git a/cmd/update/workflow.go b/cmd/update/workflow.go
@@ -11,9 +11,8 @@ import (
 )
 
 const (
-	updateWorkflowShort = "Updates launch plan metadata"
+	updateWorkflowShort = "Updates workflow metadata"
 	updateWorkflowLong  = `
-Updates workflow metadata.
 Following command updates the description on the workflow.
 ::
 

diff --git a/docs/source/gen/flytectl_update.rst b/docs/source/gen/flytectl_update.rst
@@ -73,5 +73,8 @@ SEE ALSO
 ~~~~~~~~
 
 * :doc:`flytectl` 	 - flyetcl CLI tool
+* :doc:`flytectl_update_launchplan` 	 - Updates launch plan metadata
 * :doc:`flytectl_update_project` 	 - Updates project resources
+* :doc:`flytectl_update_task` 	 - Updates task metadata
+* :doc:`flytectl_update_workflow` 	 - Updates launch plan metadata
 
diff --git a/docs/source/gen/flytectl_update_launchplan.rst b/docs/source/gen/flytectl_update_launchplan.rst
@@ -0,0 +1,94 @@
+.. _flytectl_update_launchplan:
+
+flytectl update launchplan
+--------------------------
+
+Updates launch plan metadata
+
+Synopsis
+~~~~~~~~
+
+
+
+Updates launchplan metadata.
+Following command updates the description on the launchplan.
+::
+
+ flytectl update launchplan -p flytectldemo -d development  core.advanced.run_merge_sort.merge_sort --description "Mergesort example"
+
+Archiving launchplan named entity is not supported and would throw an error.
+::
+
+ flytectl update launchplan -p flytectldemo -d development  core.advanced.run_merge_sort.merge_sort --archive
+
+Activating launchplan named entity would be a noop.
+::
+
+ flytectl update launchplan -p flytectldemo -d development  core.advanced.run_merge_sort.merge_sort --activate
+
+Usage
+
+
+::
+
+  flytectl update launchplan [flags]
+
+Options
+~~~~~~~
+
+::
+
+      --activate             Activates the named entity specified as argument.
+      --archive              Archives the named entity specified as argument.
+      --description string   description of the namedentity.
+  -h, --help                 help for launchplan
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --admin.authorizationHeader string           Custom metadata header to pass JWT
+      --admin.authorizationServerUrl string        This is the URL to your IDP's authorization server'
+      --admin.clientId string                      Client ID
+      --admin.clientSecretLocation string          File containing the client secret
+      --admin.endpoint string                      For admin types,  specify where the uri of the service is located.
+      --admin.insecure                             Use insecure connection.
+      --admin.maxBackoffDelay string               Max delay for grpc backoff (default "8s")
+      --admin.maxRetries int                       Max number of gRPC retries (default 4)
+      --admin.perRetryTimeout string               gRPC per retry timeout (default "15s")
+      --admin.scopes strings                       List of scopes to request
+      --admin.tokenUrl string                      Your IDPs token endpoint
+      --admin.useAuth                              Whether or not to try to authenticate with options below
+      --adminutils.batchSize int                   Maximum number of records to retrieve per call. (default 100)
+      --adminutils.maxRecords int                  Maximum number of records to retrieve. (default 500)
+      --config string                              config file (default is $HOME/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")
+  -p, --project string                             Specifies the Flyte project.
+      --root.domain string                         Specified the domain to work on.
+      --root.output string                         Specified the output type.
+      --root.project string                        Specifies the project to work on.
+      --storage.cache.max_size_mbs int             Maximum size of the cache where the Blob store data is cached in-memory. If not specified or set to 0,  cache is not used
+      --storage.cache.target_gc_percent int        Sets the garbage collection target percentage.
+      --storage.connection.access-key string       Access key to use. Only required when authtype is set to accesskey.
+      --storage.connection.auth-type string        Auth Type to use [iam, accesskey]. (default "iam")
+      --storage.connection.disable-ssl             Disables SSL connection. Should only be used for development.
+      --storage.connection.endpoint string         URL for storage client to connect to.
+      --storage.connection.region string           Region to connect to. (default "us-east-1")
+      --storage.connection.secret-key string       Secret to use when accesskey is set.
+      --storage.container string                   Initial container to create -if it doesn't exist-.'
+      --storage.defaultHttpClient.timeout string   Sets time out on the http client. (default "0s")
+      --storage.enable-multicontainer              If this is true,  then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered
+      --storage.limits.maxDownloadMBs int          Maximum allowed download size (in MBs) per call. (default 2)
+      --storage.type string                        Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3")
+
+SEE ALSO
+~~~~~~~~
+
+* :doc:`flytectl_update` 	 - Used for updating flyte resources eg: project.
+
diff --git a/docs/source/gen/flytectl_update_task.rst b/docs/source/gen/flytectl_update_task.rst
@@ -0,0 +1,94 @@
+.. _flytectl_update_task:
+
+flytectl update task
+--------------------
+
+Updates task metadata
+
+Synopsis
+~~~~~~~~
+
+
+
+Updates task metadata.
+Following command updates the description on the task.
+::
+
+ flytectl update  task -d development -p flytectldemo core.advanced.run_merge_sort.merge --description "Merge sort example"
+
+Archiving task named entity would is not supported and would throw an error.
+::
+
+ flytectl update  task -d development -p flytectldemo core.advanced.run_merge_sort.merge --archive
+
+Activating workflow named entity would be a noop as archiving is not possible.
+::
+
+ flytectl update  task -d development -p flytectldemo core.advanced.run_merge_sort.merge --activate
+
+Usage
+
+
+::
+
+  flytectl update task [flags]
+
+Options
+~~~~~~~
+
+::
+
+      --activate             Activates the named entity specified as argument.
+      --archive              Archives the named entity specified as argument.
+      --description string   description of the namedentity.
+  -h, --help                 help for task
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --admin.authorizationHeader string           Custom metadata header to pass JWT
+      --admin.authorizationServerUrl string        This is the URL to your IDP's authorization server'
+      --admin.clientId string                      Client ID
+      --admin.clientSecretLocation string          File containing the client secret
+      --admin.endpoint string                      For admin types,  specify where the uri of the service is located.
+      --admin.insecure                             Use insecure connection.
+      --admin.maxBackoffDelay string               Max delay for grpc backoff (default "8s")
+      --admin.maxRetries int                       Max number of gRPC retries (default 4)
+      --admin.perRetryTimeout string               gRPC per retry timeout (default "15s")
+      --admin.scopes strings                       List of scopes to request
+      --admin.tokenUrl string                      Your IDPs token endpoint
+      --admin.useAuth                              Whether or not to try to authenticate with options below
+      --adminutils.batchSize int                   Maximum number of records to retrieve per call. (default 100)
+      --adminutils.maxRecords int                  Maximum number of records to retrieve. (default 500)
+      --config string                              config file (default is $HOME/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")
+  -p, --project string                             Specifies the Flyte project.
+      --root.domain string                         Specified the domain to work on.
+      --root.output string                         Specified the output type.
+      --root.project string                        Specifies the project to work on.
+      --storage.cache.max_size_mbs int             Maximum size of the cache where the Blob store data is cached in-memory. If not specified or set to 0,  cache is not used
+      --storage.cache.target_gc_percent int        Sets the garbage collection target percentage.
+      --storage.connection.access-key string       Access key to use. Only required when authtype is set to accesskey.
+      --storage.connection.auth-type string        Auth Type to use [iam, accesskey]. (default "iam")
+      --storage.connection.disable-ssl             Disables SSL connection. Should only be used for development.
+      --storage.connection.endpoint string         URL for storage client to connect to.
+      --storage.connection.region string           Region to connect to. (default "us-east-1")
+      --storage.connection.secret-key string       Secret to use when accesskey is set.
+      --storage.container string                   Initial container to create -if it doesn't exist-.'
+      --storage.defaultHttpClient.timeout string   Sets time out on the http client. (default "0s")
+      --storage.enable-multicontainer              If this is true,  then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered
+      --storage.limits.maxDownloadMBs int          Maximum allowed download size (in MBs) per call. (default 2)
+      --storage.type string                        Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3")
+
+SEE ALSO
+~~~~~~~~
+
+* :doc:`flytectl_update` 	 - Used for updating flyte resources eg: project.
+
diff --git a/docs/source/gen/flytectl_update_workflow.rst b/docs/source/gen/flytectl_update_workflow.rst
@@ -0,0 +1,94 @@
+.. _flytectl_update_workflow:
+
+flytectl update workflow
+------------------------
+
+Updates launch plan metadata
+
+Synopsis
+~~~~~~~~
+
+
+
+Updates workflow metadata.
+Following command updates the description on the workflow.
+::
+
+ flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --description "Mergesort workflow example"
+
+Archiving workflow named entity would cause this to disapper from flyteconsole UI.
+::
+
+ flytectl update workflow -p flytectldemo -d development  core.advanced.run_merge_sort.merge_sort --archive
+
+Activating workflow named entity would unarchive it.
+::
+
+ flytectl update workflow -p flytectldemo -d development  core.advanced.run_merge_sort.merge_sort --activate
+
+Usage
+
+
+::
+
+  flytectl update workflow [flags]
+
+Options
+~~~~~~~
+
+::
+
+      --activate             Activates the named entity specified as argument.
+      --archive              Archives the named entity specified as argument.
+      --description string   description of the namedentity.
+  -h, --help                 help for workflow
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --admin.authorizationHeader string           Custom metadata header to pass JWT
+      --admin.authorizationServerUrl string        This is the URL to your IDP's authorization server'
+      --admin.clientId string                      Client ID
+      --admin.clientSecretLocation string          File containing the client secret
+      --admin.endpoint string                      For admin types,  specify where the uri of the service is located.
+      --admin.insecure                             Use insecure connection.
+      --admin.maxBackoffDelay string               Max delay for grpc backoff (default "8s")
+      --admin.maxRetries int                       Max number of gRPC retries (default 4)
+      --admin.perRetryTimeout string               gRPC per retry timeout (default "15s")
+      --admin.scopes strings                       List of scopes to request
+      --admin.tokenUrl string                      Your IDPs token endpoint
+      --admin.useAuth                              Whether or not to try to authenticate with options below
+      --adminutils.batchSize int                   Maximum number of records to retrieve per call. (default 100)
+      --adminutils.maxRecords int                  Maximum number of records to retrieve. (default 500)
+      --config string                              config file (default is $HOME/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")
+  -p, --project string                             Specifies the Flyte project.
+      --root.domain string                         Specified the domain to work on.
+      --root.output string                         Specified the output type.
+      --root.project string                        Specifies the project to work on.
+      --storage.cache.max_size_mbs int             Maximum size of the cache where the Blob store data is cached in-memory. If not specified or set to 0,  cache is not used
+      --storage.cache.target_gc_percent int        Sets the garbage collection target percentage.
+      --storage.connection.access-key string       Access key to use. Only required when authtype is set to accesskey.
+      --storage.connection.auth-type string        Auth Type to use [iam, accesskey]. (default "iam")
+      --storage.connection.disable-ssl             Disables SSL connection. Should only be used for development.
+      --storage.connection.endpoint string         URL for storage client to connect to.
+      --storage.connection.region string           Region to connect to. (default "us-east-1")
+      --storage.connection.secret-key string       Secret to use when accesskey is set.
+      --storage.container string                   Initial container to create -if it doesn't exist-.'
+      --storage.defaultHttpClient.timeout string   Sets time out on the http client. (default "0s")
+      --storage.enable-multicontainer              If this is true,  then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered
+      --storage.limits.maxDownloadMBs int          Maximum allowed download size (in MBs) per call. (default 2)
+      --storage.type string                        Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3")
+
+SEE ALSO
+~~~~~~~~
+
+* :doc:`flytectl_update` 	 - Used for updating flyte resources eg: project.
+