From c03f55e996e330db14e18903486b73c4868ea37b Mon Sep 17 00:00:00 2001 From: Niels Bantilan Date: Thu, 11 Jan 2024 11:43:59 -0500 Subject: [PATCH] add flytectl docs redirects to monodocs Signed-off-by: Niels Bantilan --- doc-requirements.in | 1 + doc-requirements.txt | 70 ++++++++++--------- docs/source/conf.py | 10 +++ docs/source/gen/flytectl.rst | 1 + docs/source/gen/flytectl_compile.rst | 1 + docs/source/gen/flytectl_completion.rst | 1 + docs/source/gen/flytectl_config.rst | 2 + docs/source/gen/flytectl_config_discover.rst | 1 + docs/source/gen/flytectl_config_docs.rst | 5 +- docs/source/gen/flytectl_config_init.rst | 2 + docs/source/gen/flytectl_config_validate.rst | 1 + docs/source/gen/flytectl_create.rst | 1 + docs/source/gen/flytectl_create_execution.rst | 34 +++++++-- docs/source/gen/flytectl_create_project.rst | 2 + docs/source/gen/flytectl_delete.rst | 1 + ...ectl_delete_cluster-resource-attribute.rst | 1 + ...lytectl_delete_execution-cluster-label.rst | 1 + ...tectl_delete_execution-queue-attribute.rst | 1 + docs/source/gen/flytectl_delete_execution.rst | 1 + .../gen/flytectl_delete_plugin-override.rst | 1 + ...lytectl_delete_task-resource-attribute.rst | 1 + ...tectl_delete_workflow-execution-config.rst | 1 + docs/source/gen/flytectl_demo.rst | 1 + docs/source/gen/flytectl_demo_exec.rst | 1 + docs/source/gen/flytectl_demo_reload.rst | 3 + docs/source/gen/flytectl_demo_start.rst | 3 + docs/source/gen/flytectl_demo_status.rst | 1 + docs/source/gen/flytectl_demo_teardown.rst | 1 + docs/source/gen/flytectl_get.rst | 1 + ...lytectl_get_cluster-resource-attribute.rst | 1 + .../flytectl_get_execution-cluster-label.rst | 1 + ...flytectl_get_execution-queue-attribute.rst | 1 + docs/source/gen/flytectl_get_execution.rst | 1 + docs/source/gen/flytectl_get_launchplan.rst | 1 + .../gen/flytectl_get_plugin-override.rst | 1 + docs/source/gen/flytectl_get_project.rst | 1 + .../flytectl_get_task-resource-attribute.rst | 1 + docs/source/gen/flytectl_get_task.rst | 1 + ...flytectl_get_workflow-execution-config.rst | 1 + docs/source/gen/flytectl_get_workflow.rst | 1 + docs/source/gen/flytectl_register.rst | 1 + .../source/gen/flytectl_register_examples.rst | 1 + docs/source/gen/flytectl_register_files.rst | 1 + docs/source/gen/flytectl_sandbox.rst | 1 + docs/source/gen/flytectl_sandbox_exec.rst | 1 + docs/source/gen/flytectl_sandbox_start.rst | 3 + docs/source/gen/flytectl_sandbox_status.rst | 1 + docs/source/gen/flytectl_sandbox_teardown.rst | 1 + docs/source/gen/flytectl_update.rst | 8 +-- ...ectl_update_cluster-resource-attribute.rst | 2 + ...lytectl_update_execution-cluster-label.rst | 2 + ...tectl_update_execution-queue-attribute.rst | 2 + docs/source/gen/flytectl_update_execution.rst | 2 + .../gen/flytectl_update_launchplan-meta.rst | 8 ++- .../source/gen/flytectl_update_launchplan.rst | 1 + .../gen/flytectl_update_plugin-override.rst | 2 + docs/source/gen/flytectl_update_project.rst | 8 ++- docs/source/gen/flytectl_update_task-meta.rst | 8 ++- ...lytectl_update_task-resource-attribute.rst | 2 + ...tectl_update_workflow-execution-config.rst | 2 + .../gen/flytectl_update_workflow-meta.rst | 2 + docs/source/gen/flytectl_upgrade.rst | 1 + docs/source/gen/flytectl_version.rst | 1 + 63 files changed, 167 insertions(+), 56 deletions(-) diff --git a/doc-requirements.in b/doc-requirements.in index 0bdd65dd..38b976f5 100644 --- a/doc-requirements.in +++ b/doc-requirements.in @@ -7,3 +7,4 @@ sphinx-copybutton sphinx_fontawesome sphinxcontrib-youtube sphinx-panels +sphinx-reredirects diff --git a/doc-requirements.txt b/doc-requirements.txt index bb24f24d..bc5dfeb5 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -1,21 +1,21 @@ # -# This file is autogenerated by pip-compile with python 3.8 -# To update, run: +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: # # pip-compile doc-requirements.in # -alabaster==0.7.12 +alabaster==0.7.16 # via sphinx -babel==2.9.1 +babel==2.14.0 # via sphinx -beautifulsoup4==4.10.0 +beautifulsoup4==4.12.2 # via # furo # sphinx-code-include # sphinx-material -certifi==2023.7.22 +certifi==2023.11.17 # via requests -charset-normalizer==2.0.10 +charset-normalizer==3.3.2 # via requests css-html-js-minify==2.5.5 # via sphinx-material @@ -25,64 +25,69 @@ docutils==0.17.1 # sphinx-panels furo @ git+https://github.com/flyteorg/furo@main # via -r doc-requirements.in -idna==3.3 +idna==3.6 # via requests -imagesize==1.3.0 +imagesize==1.4.1 # via sphinx -jinja2==3.0.3 +jinja2==3.1.3 # via sphinx -lxml==4.9.1 +lxml==5.1.0 # via sphinx-material -markupsafe==2.0.1 +markupsafe==2.1.3 # via jinja2 -packaging==21.3 +packaging==23.2 # via sphinx -pygments==2.11.2 +pygments==2.17.2 # via + # furo # sphinx # sphinx-prompt -pyparsing==3.0.6 - # via packaging -python-slugify[unidecode]==5.0.2 +python-slugify[unidecode]==8.0.1 # via sphinx-material -pytz==2021.3 - # via babel -requests==2.27.1 - # via sphinx +requests==2.31.0 + # via + # sphinx + # sphinxcontrib-youtube six==1.16.0 # via sphinx-code-include snowballstemmer==2.2.0 # via sphinx -soupsieve==2.3.1 +soupsieve==2.5 # via beautifulsoup4 -sphinx==4.3.2 +sphinx==4.5.0 # via # -r doc-requirements.in # furo + # sphinx-basic-ng # sphinx-code-include # sphinx-copybutton # sphinx-fontawesome # sphinx-material # sphinx-panels # sphinx-prompt - # sphinxcontrib-yt + # sphinx-reredirects + # sphinxcontrib-youtube +sphinx-basic-ng==1.0.0b2 + # via furo sphinx-code-include==1.1.1 # via -r doc-requirements.in -sphinx-copybutton==0.4.0 +sphinx-copybutton==0.5.2 # via -r doc-requirements.in sphinx-fontawesome==0.0.6 # via -r doc-requirements.in -sphinx-material==0.0.35 +sphinx-material==0.0.36 # via -r doc-requirements.in sphinx-panels==0.6.0 # via -r doc-requirements.in sphinx-prompt==1.5.0 # via -r doc-requirements.in -sphinxcontrib-applehelp==1.0.2 +sphinx-reredirects==0.1.3 + # via -r doc-requirements.in +sphinxcontrib-applehelp==1.0.4 # via sphinx sphinxcontrib-devhelp==1.0.2 # via sphinx -sphinxcontrib-htmlhelp==2.0.0 +sphinxcontrib-htmlhelp==2.0.1 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx @@ -90,14 +95,11 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx -sphinxcontrib-youtube==1.2.0 +sphinxcontrib-youtube==1.3.0 # via -r doc-requirements.in text-unidecode==1.3 # via python-slugify -unidecode==1.3.2 +unidecode==1.3.8 # via python-slugify -urllib3==1.26.7 +urllib3==2.1.0 # via requests - -# The following packages are considered to be unsafe in a requirements file: -# setuptools diff --git a/docs/source/conf.py b/docs/source/conf.py index d9f9045f..905b3067 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,6 +44,7 @@ "sphinx_copybutton", "sphinx_fontawesome", "sphinxcontrib.youtube", + "sphinx_reredirects", "sphinx_panels", ] @@ -201,3 +202,12 @@ "flyteidl": ("https://docs.flyte.org/projects/flyteidl/en/latest", None), "flyte": ("https://docs.flyte.org/en/latest", None), } + +if int(os.environ.get("ENABLE_SPHINX_REDIRECTS", 0)): + # Redirects to the new docs site + redirects = { + "verbs.html": "https://docs.flyte.org/en/latest/flytectl/verbs.html", + "nouns.html": "https://docs.flyte.org/en/latest/flytectl/nouns.html", + "gen/*": "https://docs.flyte.org/en/latest/flytectl/$source.html", + "contribute.html": "https://docs.flyte.org/en/latest/flytectl/contribute.html", + } diff --git a/docs/source/gen/flytectl.rst b/docs/source/gen/flytectl.rst index c30c1269..9109b234 100644 --- a/docs/source/gen/flytectl.rst +++ b/docs/source/gen/flytectl.rst @@ -30,6 +30,7 @@ Options --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_compile.rst b/docs/source/gen/flytectl_compile.rst index 0e178524..6ce685df 100644 --- a/docs/source/gen/flytectl_compile.rst +++ b/docs/source/gen/flytectl_compile.rst @@ -56,6 +56,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_completion.rst b/docs/source/gen/flytectl_completion.rst index aedf9442..5671d345 100644 --- a/docs/source/gen/flytectl_completion.rst +++ b/docs/source/gen/flytectl_completion.rst @@ -103,6 +103,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_config.rst b/docs/source/gen/flytectl_config.rst index 60e755e6..be0ef536 100644 --- a/docs/source/gen/flytectl_config.rst +++ b/docs/source/gen/flytectl_config.rst @@ -18,6 +18,7 @@ Options --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. + --force Force to overwrite the default config file without confirmation -h, --help help for config Options inherited from parent commands @@ -39,6 +40,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_config_discover.rst b/docs/source/gen/flytectl_config_discover.rst index 092093e4..6727e00d 100644 --- a/docs/source/gen/flytectl_config_discover.rst +++ b/docs/source/gen/flytectl_config_discover.rst @@ -41,6 +41,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_config_docs.rst b/docs/source/gen/flytectl_config_docs.rst index b6c9cb86..06d0969e 100644 --- a/docs/source/gen/flytectl_config_docs.rst +++ b/docs/source/gen/flytectl_config_docs.rst @@ -3,13 +3,13 @@ flytectl config docs -------------------- -Generate configuration documetation in rst format +Generate configuration documentation in rst format Synopsis ~~~~~~~~ -Generate configuration documetation in rst format +Generate configuration documentation in rst format :: @@ -41,6 +41,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_config_init.rst b/docs/source/gen/flytectl_config_init.rst index 07cd65bd..ea2a964d 100644 --- a/docs/source/gen/flytectl_config_init.rst +++ b/docs/source/gen/flytectl_config_init.rst @@ -53,6 +53,7 @@ Options :: --console string Endpoint of console, if different than flyte admin + --force Force to overwrite the default config file without confirmation -h, --help help for init --host string Endpoint of flyte admin --insecure Enable insecure mode @@ -76,6 +77,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_config_validate.rst b/docs/source/gen/flytectl_config_validate.rst index 9d9491da..41a5511b 100644 --- a/docs/source/gen/flytectl_config_validate.rst +++ b/docs/source/gen/flytectl_config_validate.rst @@ -43,6 +43,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_create.rst b/docs/source/gen/flytectl_create.rst index 7a28ca97..8827dc20 100644 --- a/docs/source/gen/flytectl_create.rst +++ b/docs/source/gen/flytectl_create.rst @@ -42,6 +42,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_create_execution.rst b/docs/source/gen/flytectl_create_execution.rst index 4fdbf89b..a51529dc 100644 --- a/docs/source/gen/flytectl_create_execution.rst +++ b/docs/source/gen/flytectl_create_execution.rst @@ -56,20 +56,39 @@ The generated spec file can be modified to change the input values, as shown bel task: core.control_flow.merge_sort.merge version: "v2" -3. Run the execution by passing the generated YAML file. +3. [Optional] Update the envs for the execution, if needed. +The generated spec file can be modified to change the envs values, as shown below: + +.. code-block:: yaml + + iamRoleARN: "" + inputs: + sorted_list1: + - 0 + sorted_list2: + - 0 + envs: + foo: bar + kubeServiceAcct: "" + targetDomain: "" + targetProject: "" + task: core.control_flow.merge_sort.merge + version: "v2" + +4. Run the execution by passing the generated YAML file. The file can then be passed through the command line. It is worth noting that the source's and target's project and domain can be different. :: flytectl create execution --execFile execution_spec.yaml -p flytesnacks -d staging --targetProject flytesnacks -4. To relaunch an execution, pass the current execution ID as follows: +5. To relaunch an execution, pass the current execution ID as follows: :: flytectl create execution --relaunch ffb31066a0f8b4d52b77 -p flytesnacks -d development -5. To recover an execution, i.e., recreate it from the last known failure point for previously-run workflow execution, run: +6. To recover an execution, i.e., recreate it from the last known failure point for previously-run workflow execution, run: :: @@ -77,7 +96,7 @@ It is worth noting that the source's and target's project and domain can be diff See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details. -6. You can create executions idempotently by naming them. This is also a way to *name* an execution for discovery. Note, +7. You can create executions idempotently by naming them. This is also a way to *name* an execution for discovery. Note, an execution id has to be unique within a project domain. So if the *name* matches an existing execution an already exists exceptioj will be raised. @@ -85,7 +104,7 @@ will be raised. flytectl create execution --recover ffb31066a0f8b4d52b77 -p flytesnacks -d development custom_name -7. Generic/Struct/Dataclass/JSON types are supported for execution in a similar manner. +8. Generic/Struct/Dataclass/JSON types are supported for execution in a similar manner. The following is an example of how generic data can be specified while creating the execution. :: @@ -105,7 +124,7 @@ The generated file would look similar to this. Here, empty values have been dump task: core.type_system.custom_objects.add version: v3 -8. Modified file with struct data populated for 'x' and 'y' parameters for the task "core.type_system.custom_objects.add": +9. Modified file with struct data populated for 'x' and 'y' parameters for the task "core.type_system.custom_objects.add": :: @@ -129,7 +148,7 @@ The generated file would look similar to this. Here, empty values have been dump task: core.type_system.custom_objects.add version: v3 -9. If you have configured a plugin that implements github.com/flyteorg/flyteadmin/pkg/workflowengine/interfaces/WorkflowExecutor +10. If you have configured a plugin that implements github.com/flyteorg/flyteadmin/pkg/workflowengine/interfaces/WorkflowExecutor that supports cluster pools, then when creating a new execution, you can assign it to a specific cluster pool: :: @@ -180,6 +199,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_create_project.rst b/docs/source/gen/flytectl_create_project.rst index a8e6b370..16dedc8a 100644 --- a/docs/source/gen/flytectl_create_project.rst +++ b/docs/source/gen/flytectl_create_project.rst @@ -54,6 +54,7 @@ Options --description string description for the project specified as argument. --dryRun execute command without making any modifications. --file string file for the project definition. + --force Skips asking for an acknowledgement during an update operation. Only used in update -h, --help help for project --id string id for the project specified as argument. --labels stringToString labels for the project specified as argument. (default []) @@ -78,6 +79,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete.rst b/docs/source/gen/flytectl_delete.rst index d338a861..485404ad 100644 --- a/docs/source/gen/flytectl_delete.rst +++ b/docs/source/gen/flytectl_delete.rst @@ -42,6 +42,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst b/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst index a8ae5e39..5264b904 100644 --- a/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst @@ -77,6 +77,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_execution-cluster-label.rst b/docs/source/gen/flytectl_delete_execution-cluster-label.rst index 92ac7a3b..3314aba8 100644 --- a/docs/source/gen/flytectl_delete_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_delete_execution-cluster-label.rst @@ -74,6 +74,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_execution-queue-attribute.rst b/docs/source/gen/flytectl_delete_execution-queue-attribute.rst index 74c8504e..57bd1c6d 100644 --- a/docs/source/gen/flytectl_delete_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_delete_execution-queue-attribute.rst @@ -78,6 +78,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_execution.rst b/docs/source/gen/flytectl_delete_execution.rst index 71577b85..c336e66a 100644 --- a/docs/source/gen/flytectl_delete_execution.rst +++ b/docs/source/gen/flytectl_delete_execution.rst @@ -85,6 +85,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_plugin-override.rst b/docs/source/gen/flytectl_delete_plugin-override.rst index e2e2d6f4..58e26d44 100644 --- a/docs/source/gen/flytectl_delete_plugin-override.rst +++ b/docs/source/gen/flytectl_delete_plugin-override.rst @@ -79,6 +79,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_task-resource-attribute.rst b/docs/source/gen/flytectl_delete_task-resource-attribute.rst index 8e3c5405..f523a771 100644 --- a/docs/source/gen/flytectl_delete_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_delete_task-resource-attribute.rst @@ -79,6 +79,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_delete_workflow-execution-config.rst b/docs/source/gen/flytectl_delete_workflow-execution-config.rst index 6376d8d7..389dad93 100644 --- a/docs/source/gen/flytectl_delete_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_delete_workflow-execution-config.rst @@ -77,6 +77,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_demo.rst b/docs/source/gen/flytectl_demo.rst index 904d0482..2176c7b9 100644 --- a/docs/source/gen/flytectl_demo.rst +++ b/docs/source/gen/flytectl_demo.rst @@ -60,6 +60,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_demo_exec.rst b/docs/source/gen/flytectl_demo_exec.rst index 6b360fbe..8a0c9c48 100644 --- a/docs/source/gen/flytectl_demo_exec.rst +++ b/docs/source/gen/flytectl_demo_exec.rst @@ -49,6 +49,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_demo_reload.rst b/docs/source/gen/flytectl_demo_reload.rst index 09bd8746..9fccacec 100644 --- a/docs/source/gen/flytectl_demo_reload.rst +++ b/docs/source/gen/flytectl_demo_reload.rst @@ -30,8 +30,10 @@ Options :: --dev Optional. Only start minio and postgres in the sandbox. + --disable-agent Optional. Disable the agent service. --dryRun Optional. Only print the docker commands to bring up flyte sandbox/demo container.This will still call github api's to get the latest flyte release to use' --env strings Optional. Provide Env variable in key=value format which can be passed to sandbox container. + --force Optional. Forcefully delete existing sandbox cluster if it exists. -h, --help help for reload --image string Optional. Provide a fully qualified path to a Flyte compliant docker image. --imagePullOptions.platform string Forces a specific platform's image to be pulled.' @@ -60,6 +62,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_demo_start.rst b/docs/source/gen/flytectl_demo_start.rst index ef1ae5ad..89ed10f5 100644 --- a/docs/source/gen/flytectl_demo_start.rst +++ b/docs/source/gen/flytectl_demo_start.rst @@ -91,8 +91,10 @@ Options :: --dev Optional. Only start minio and postgres in the sandbox. + --disable-agent Optional. Disable the agent service. --dryRun Optional. Only print the docker commands to bring up flyte sandbox/demo container.This will still call github api's to get the latest flyte release to use' --env strings Optional. Provide Env variable in key=value format which can be passed to sandbox container. + --force Optional. Forcefully delete existing sandbox cluster if it exists. -h, --help help for start --image string Optional. Provide a fully qualified path to a Flyte compliant docker image. --imagePullOptions.platform string Forces a specific platform's image to be pulled.' @@ -121,6 +123,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_demo_status.rst b/docs/source/gen/flytectl_demo_status.rst index 296de34f..3d213343 100644 --- a/docs/source/gen/flytectl_demo_status.rst +++ b/docs/source/gen/flytectl_demo_status.rst @@ -49,6 +49,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_demo_teardown.rst b/docs/source/gen/flytectl_demo_teardown.rst index 544f9179..42d9c226 100644 --- a/docs/source/gen/flytectl_demo_teardown.rst +++ b/docs/source/gen/flytectl_demo_teardown.rst @@ -50,6 +50,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get.rst b/docs/source/gen/flytectl_get.rst index 17105355..f48ddf3e 100644 --- a/docs/source/gen/flytectl_get.rst +++ b/docs/source/gen/flytectl_get.rst @@ -42,6 +42,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_cluster-resource-attribute.rst b/docs/source/gen/flytectl_get_cluster-resource-attribute.rst index e047a870..b242491a 100644 --- a/docs/source/gen/flytectl_get_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_get_cluster-resource-attribute.rst @@ -85,6 +85,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_execution-cluster-label.rst b/docs/source/gen/flytectl_get_execution-cluster-label.rst index ed79e39e..9147ff07 100644 --- a/docs/source/gen/flytectl_get_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_get_execution-cluster-label.rst @@ -84,6 +84,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_execution-queue-attribute.rst b/docs/source/gen/flytectl_get_execution-queue-attribute.rst index 3be1a9b9..71929da6 100644 --- a/docs/source/gen/flytectl_get_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_get_execution-queue-attribute.rst @@ -87,6 +87,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_execution.rst b/docs/source/gen/flytectl_get_execution.rst index e460dbec..38543aad 100644 --- a/docs/source/gen/flytectl_get_execution.rst +++ b/docs/source/gen/flytectl_get_execution.rst @@ -117,6 +117,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_launchplan.rst b/docs/source/gen/flytectl_get_launchplan.rst index 12df2747..e340b866 100644 --- a/docs/source/gen/flytectl_get_launchplan.rst +++ b/docs/source/gen/flytectl_get_launchplan.rst @@ -152,6 +152,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_plugin-override.rst b/docs/source/gen/flytectl_get_plugin-override.rst index 21d69b8b..bf943751 100644 --- a/docs/source/gen/flytectl_get_plugin-override.rst +++ b/docs/source/gen/flytectl_get_plugin-override.rst @@ -106,6 +106,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_project.rst b/docs/source/gen/flytectl_get_project.rst index b3136ffe..07d25570 100644 --- a/docs/source/gen/flytectl_get_project.rst +++ b/docs/source/gen/flytectl_get_project.rst @@ -89,6 +89,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_task-resource-attribute.rst b/docs/source/gen/flytectl_get_task-resource-attribute.rst index 095c0c59..2b2f369a 100644 --- a/docs/source/gen/flytectl_get_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_get_task-resource-attribute.rst @@ -89,6 +89,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_task.rst b/docs/source/gen/flytectl_get_task.rst index 8f54e8f2..38364522 100644 --- a/docs/source/gen/flytectl_get_task.rst +++ b/docs/source/gen/flytectl_get_task.rst @@ -133,6 +133,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_workflow-execution-config.rst b/docs/source/gen/flytectl_get_workflow-execution-config.rst index 9850f7bf..8c332c3a 100644 --- a/docs/source/gen/flytectl_get_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_get_workflow-execution-config.rst @@ -146,6 +146,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_get_workflow.rst b/docs/source/gen/flytectl_get_workflow.rst index 7584c765..f446fdeb 100644 --- a/docs/source/gen/flytectl_get_workflow.rst +++ b/docs/source/gen/flytectl_get_workflow.rst @@ -117,6 +117,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_register.rst b/docs/source/gen/flytectl_register.rst index 234c1210..745dffa9 100644 --- a/docs/source/gen/flytectl_register.rst +++ b/docs/source/gen/flytectl_register.rst @@ -42,6 +42,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_register_examples.rst b/docs/source/gen/flytectl_register_examples.rst index 438b6fef..9c681548 100644 --- a/docs/source/gen/flytectl_register_examples.rst +++ b/docs/source/gen/flytectl_register_examples.rst @@ -68,6 +68,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_register_files.rst b/docs/source/gen/flytectl_register_files.rst index 633984e3..512b1166 100644 --- a/docs/source/gen/flytectl_register_files.rst +++ b/docs/source/gen/flytectl_register_files.rst @@ -145,6 +145,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_sandbox.rst b/docs/source/gen/flytectl_sandbox.rst index 87f1cda5..8cc08fc4 100644 --- a/docs/source/gen/flytectl_sandbox.rst +++ b/docs/source/gen/flytectl_sandbox.rst @@ -66,6 +66,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_sandbox_exec.rst b/docs/source/gen/flytectl_sandbox_exec.rst index 1bfbb387..f1f3c446 100644 --- a/docs/source/gen/flytectl_sandbox_exec.rst +++ b/docs/source/gen/flytectl_sandbox_exec.rst @@ -49,6 +49,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_sandbox_start.rst b/docs/source/gen/flytectl_sandbox_start.rst index 13d0af08..048b92b2 100644 --- a/docs/source/gen/flytectl_sandbox_start.rst +++ b/docs/source/gen/flytectl_sandbox_start.rst @@ -86,8 +86,10 @@ Options :: --dev Optional. Only start minio and postgres in the sandbox. + --disable-agent Optional. Disable the agent service. --dryRun Optional. Only print the docker commands to bring up flyte sandbox/demo container.This will still call github api's to get the latest flyte release to use' --env strings Optional. Provide Env variable in key=value format which can be passed to sandbox container. + --force Optional. Forcefully delete existing sandbox cluster if it exists. -h, --help help for start --image string Optional. Provide a fully qualified path to a Flyte compliant docker image. --imagePullOptions.platform string Forces a specific platform's image to be pulled.' @@ -116,6 +118,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_sandbox_status.rst b/docs/source/gen/flytectl_sandbox_status.rst index 0eb7f19c..abce2715 100644 --- a/docs/source/gen/flytectl_sandbox_status.rst +++ b/docs/source/gen/flytectl_sandbox_status.rst @@ -49,6 +49,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_sandbox_teardown.rst b/docs/source/gen/flytectl_sandbox_teardown.rst index 7a52bc5d..c57c64b6 100644 --- a/docs/source/gen/flytectl_sandbox_teardown.rst +++ b/docs/source/gen/flytectl_sandbox_teardown.rst @@ -49,6 +49,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update.rst b/docs/source/gen/flytectl_update.rst index 0dfd304a..27949e61 100644 --- a/docs/source/gen/flytectl_update.rst +++ b/docs/source/gen/flytectl_update.rst @@ -10,12 +10,11 @@ Synopsis -Currently, this command only provides subcommands to update project. -Take input project that needs to be archived or unarchived. Name of the project to be updated is a mandatory field. -Update Flyte resources; if a project: +Provides subcommands to update Flyte resources, such as tasks, workflows, launch plans, executions, and projects. +Update Flyte resource; e.g., to activate a project: :: - flytectl update project -p flytesnacks --activateProject + flytectl update project -p flytesnacks --activate Options @@ -44,6 +43,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst index 21f631bb..55ea963f 100644 --- a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst @@ -63,6 +63,7 @@ Options --attrFile string attribute file name to be used for updating attribute for the resource type. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for cluster-resource-attribute Options inherited from parent commands @@ -84,6 +85,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_execution-cluster-label.rst b/docs/source/gen/flytectl_update_execution-cluster-label.rst index 67cfd6f9..01179865 100644 --- a/docs/source/gen/flytectl_update_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_update_execution-cluster-label.rst @@ -56,6 +56,7 @@ Options --attrFile string attribute file name to be used for updating attribute for the resource type. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for execution-cluster-label Options inherited from parent commands @@ -77,6 +78,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_execution-queue-attribute.rst b/docs/source/gen/flytectl_update_execution-queue-attribute.rst index 5b6f11e6..5b3f080c 100644 --- a/docs/source/gen/flytectl_update_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_update_execution-queue-attribute.rst @@ -67,6 +67,7 @@ Options --attrFile string attribute file name to be used for updating attribute for the resource type. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for execution-queue-attribute Options inherited from parent commands @@ -88,6 +89,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_execution.rst b/docs/source/gen/flytectl_update_execution.rst index 3dd6920c..373b625c 100644 --- a/docs/source/gen/flytectl_update_execution.rst +++ b/docs/source/gen/flytectl_update_execution.rst @@ -36,6 +36,7 @@ Options --activate activate execution. --archive archive execution. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for execution Options inherited from parent commands @@ -57,6 +58,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_launchplan-meta.rst b/docs/source/gen/flytectl_update_launchplan-meta.rst index a6fc2310..8e28b948 100644 --- a/docs/source/gen/flytectl_update_launchplan-meta.rst +++ b/docs/source/gen/flytectl_update_launchplan-meta.rst @@ -13,17 +13,17 @@ Synopsis Update the description on the launch plan: :: - flytectl update launchplan -p flytesnacks -d development core.advanced.merge_sort.merge_sort --description "Mergesort example" + flytectl update launchplan-meta -p flytesnacks -d development core.advanced.merge_sort.merge_sort --description "Mergesort example" Archiving launch plan named entity is not supported and would throw an error: :: - flytectl update launchplan -p flytesnacks -d development core.advanced.merge_sort.merge_sort --archive + flytectl update launchplan-meta -p flytesnacks -d development core.advanced.merge_sort.merge_sort --archive Activating launch plan named entity would be a noop: :: - flytectl update launchplan -p flytesnacks -d development core.advanced.merge_sort.merge_sort --activate + flytectl update launchplan-meta -p flytesnacks -d development core.advanced.merge_sort.merge_sort --activate Usage @@ -41,6 +41,7 @@ Options --archive archive named entity. --description string description of the named entity. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for launchplan-meta Options inherited from parent commands @@ -62,6 +63,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_launchplan.rst b/docs/source/gen/flytectl_update_launchplan.rst index b6de8566..203e060a 100644 --- a/docs/source/gen/flytectl_update_launchplan.rst +++ b/docs/source/gen/flytectl_update_launchplan.rst @@ -33,6 +33,7 @@ Options :: --activate activate launchplan. + --archive (Deprecated) disable the launch plan schedule (if it has an active schedule associated with it). --deactivate disable the launch plan schedule (if it has an active schedule associated with it). --dryRun execute command without making any modifications. --force do not ask for an acknowledgement during updates. diff --git a/docs/source/gen/flytectl_update_plugin-override.rst b/docs/source/gen/flytectl_update_plugin-override.rst index ebfb2fb1..95f744f8 100644 --- a/docs/source/gen/flytectl_update_plugin-override.rst +++ b/docs/source/gen/flytectl_update_plugin-override.rst @@ -69,6 +69,7 @@ Options --attrFile string attribute file name to be used for updating attribute for the resource type. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for plugin-override Options inherited from parent commands @@ -90,6 +91,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_project.rst b/docs/source/gen/flytectl_update_project.rst index 051de323..c4eeb48a 100644 --- a/docs/source/gen/flytectl_update_project.rst +++ b/docs/source/gen/flytectl_update_project.rst @@ -26,7 +26,7 @@ Incorrect usage when passing both archive and activate: :: - flytectl update project -p flytesnacks --archiveProject --activate + flytectl update project -p flytesnacks --archive --activate Incorrect usage when passing unknown-project: @@ -38,7 +38,7 @@ project ID is required flag :: - flytectl update project unknown-project --archiveProject + flytectl update project unknown-project --archive Update projects.(project/projects can be used interchangeably in these commands) @@ -49,7 +49,7 @@ Update projects.(project/projects can be used interchangeably in these commands) Update a project by definition file. Note: The name shouldn't contain any whitespace characters. :: - flytectl update project --file project.yaml + flytectl update project --file project.yaml .. code-block:: yaml @@ -93,6 +93,7 @@ Options --description string description for the project specified as argument. --dryRun execute command without making any modifications. --file string file for the project definition. + --force Skips asking for an acknowledgement during an update operation. Only used in update -h, --help help for project --id string id for the project specified as argument. --labels stringToString labels for the project specified as argument. (default []) @@ -117,6 +118,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_task-meta.rst b/docs/source/gen/flytectl_update_task-meta.rst index 6470e908..61312af7 100644 --- a/docs/source/gen/flytectl_update_task-meta.rst +++ b/docs/source/gen/flytectl_update_task-meta.rst @@ -13,17 +13,17 @@ Synopsis Update the description on the task: :: - flytectl update task -d development -p flytesnacks core.control_flow.merge_sort.merge --description "Merge sort example" + flytectl update task-meta -d development -p flytesnacks core.control_flow.merge_sort.merge --description "Merge sort example" Archiving task named entity is not supported and would throw an error: :: - flytectl update task -d development -p flytesnacks core.control_flow.merge_sort.merge --archive + flytectl update task-meta -d development -p flytesnacks core.control_flow.merge_sort.merge --archive Activating task named entity would be a noop since archiving is not possible: :: - flytectl update task -d development -p flytesnacks core.control_flow.merge_sort.merge --activate + flytectl update task-meta -d development -p flytesnacks core.control_flow.merge_sort.merge --activate Usage @@ -41,6 +41,7 @@ Options --archive archive named entity. --description string description of the named entity. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for task-meta Options inherited from parent commands @@ -62,6 +63,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_task-resource-attribute.rst b/docs/source/gen/flytectl_update_task-resource-attribute.rst index 91512cac..0ef4798a 100644 --- a/docs/source/gen/flytectl_update_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_task-resource-attribute.rst @@ -69,6 +69,7 @@ Options --attrFile string attribute file name to be used for updating attribute for the resource type. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for task-resource-attribute Options inherited from parent commands @@ -90,6 +91,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_workflow-execution-config.rst b/docs/source/gen/flytectl_update_workflow-execution-config.rst index 9d8bc318..b025df8a 100644 --- a/docs/source/gen/flytectl_update_workflow-execution-config.rst +++ b/docs/source/gen/flytectl_update_workflow-execution-config.rst @@ -65,6 +65,7 @@ Options --attrFile string attribute file name to be used for updating attribute for the resource type. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for workflow-execution-config Options inherited from parent commands @@ -86,6 +87,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_update_workflow-meta.rst b/docs/source/gen/flytectl_update_workflow-meta.rst index 6765578a..aadccfab 100644 --- a/docs/source/gen/flytectl_update_workflow-meta.rst +++ b/docs/source/gen/flytectl_update_workflow-meta.rst @@ -41,6 +41,7 @@ Options --archive archive named entity. --description string description of the named entity. --dryRun execute command without making any modifications. + --force do not ask for an acknowledgement during updates. -h, --help help for workflow-meta Options inherited from parent commands @@ -62,6 +63,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_upgrade.rst b/docs/source/gen/flytectl_upgrade.rst index b44645a5..a0bcedda 100644 --- a/docs/source/gen/flytectl_upgrade.rst +++ b/docs/source/gen/flytectl_upgrade.rst @@ -57,6 +57,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") diff --git a/docs/source/gen/flytectl_version.rst b/docs/source/gen/flytectl_version.rst index ce0ea2e0..220a3757 100644 --- a/docs/source/gen/flytectl_version.rst +++ b/docs/source/gen/flytectl_version.rst @@ -46,6 +46,7 @@ Options inherited from parent commands --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") --admin.endpoint string For admin types, specify where the uri of the service is located. + --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. --admin.insecure Use insecure connection. --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s")