From ffa1672b599055742a5abd7123fe0824f4505de2 Mon Sep 17 00:00:00 2001 From: Nikki Everett Date: Thu, 5 Dec 2024 18:10:06 -0600 Subject: [PATCH] Regenerate flytectl docs (#5914) * add flytectl docs requirements Signed-off-by: nikki everett * update flytectl docs Signed-off-by: nikki everett --------- Signed-off-by: nikki everett Co-authored-by: nikki everett --- flytectl/docs/docs-requirements.in | 8 ++ flytectl/docs/docs-requirements.txt | 87 +++++++++++++++++++ flytectl/docs/source/gen/flytectl.rst | 9 ++ flytectl/docs/source/gen/flytectl_compile.rst | 9 ++ .../docs/source/gen/flytectl_completion.rst | 9 ++ flytectl/docs/source/gen/flytectl_config.rst | 9 ++ .../source/gen/flytectl_config_discover.rst | 9 ++ .../docs/source/gen/flytectl_config_docs.rst | 9 ++ .../docs/source/gen/flytectl_config_init.rst | 9 ++ .../source/gen/flytectl_config_validate.rst | 9 ++ flytectl/docs/source/gen/flytectl_create.rst | 9 ++ .../source/gen/flytectl_create_execution.rst | 72 ++++++++++----- .../source/gen/flytectl_create_project.rst | 9 ++ flytectl/docs/source/gen/flytectl_delete.rst | 9 ++ ...ectl_delete_cluster-resource-attribute.rst | 9 ++ ...lytectl_delete_execution-cluster-label.rst | 9 ++ ...tectl_delete_execution-queue-attribute.rst | 9 ++ .../source/gen/flytectl_delete_execution.rst | 9 ++ .../gen/flytectl_delete_plugin-override.rst | 9 ++ ...lytectl_delete_task-resource-attribute.rst | 9 ++ ...tectl_delete_workflow-execution-config.rst | 9 ++ flytectl/docs/source/gen/flytectl_demo.rst | 9 ++ .../docs/source/gen/flytectl_demo_exec.rst | 9 ++ .../docs/source/gen/flytectl_demo_reload.rst | 9 ++ .../docs/source/gen/flytectl_demo_start.rst | 9 ++ .../docs/source/gen/flytectl_demo_status.rst | 9 ++ .../source/gen/flytectl_demo_teardown.rst | 9 ++ flytectl/docs/source/gen/flytectl_get.rst | 9 ++ ...lytectl_get_cluster-resource-attribute.rst | 9 ++ .../flytectl_get_execution-cluster-label.rst | 9 ++ ...flytectl_get_execution-queue-attribute.rst | 9 ++ .../source/gen/flytectl_get_execution.rst | 9 ++ .../source/gen/flytectl_get_launchplan.rst | 9 ++ .../gen/flytectl_get_plugin-override.rst | 9 ++ .../docs/source/gen/flytectl_get_project.rst | 9 ++ .../flytectl_get_task-resource-attribute.rst | 11 ++- .../docs/source/gen/flytectl_get_task.rst | 9 ++ ...flytectl_get_workflow-execution-config.rst | 9 ++ .../docs/source/gen/flytectl_get_workflow.rst | 9 ++ .../docs/source/gen/flytectl_register.rst | 9 ++ .../source/gen/flytectl_register_examples.rst | 9 ++ .../source/gen/flytectl_register_files.rst | 9 ++ flytectl/docs/source/gen/flytectl_sandbox.rst | 9 ++ .../docs/source/gen/flytectl_sandbox_exec.rst | 9 ++ .../source/gen/flytectl_sandbox_start.rst | 9 ++ .../source/gen/flytectl_sandbox_status.rst | 9 ++ .../source/gen/flytectl_sandbox_teardown.rst | 9 ++ flytectl/docs/source/gen/flytectl_update.rst | 9 ++ ...ectl_update_cluster-resource-attribute.rst | 9 ++ ...lytectl_update_execution-cluster-label.rst | 9 ++ ...tectl_update_execution-queue-attribute.rst | 9 ++ .../source/gen/flytectl_update_execution.rst | 9 ++ .../gen/flytectl_update_launchplan-meta.rst | 9 ++ .../source/gen/flytectl_update_launchplan.rst | 9 ++ .../gen/flytectl_update_plugin-override.rst | 9 ++ .../source/gen/flytectl_update_project.rst | 11 ++- .../source/gen/flytectl_update_task-meta.rst | 9 ++ ...lytectl_update_task-resource-attribute.rst | 9 ++ ...tectl_update_workflow-execution-config.rst | 9 ++ .../gen/flytectl_update_workflow-meta.rst | 9 ++ flytectl/docs/source/gen/flytectl_upgrade.rst | 9 ++ flytectl/docs/source/gen/flytectl_version.rst | 9 ++ 62 files changed, 679 insertions(+), 23 deletions(-) create mode 100644 flytectl/docs/docs-requirements.in create mode 100644 flytectl/docs/docs-requirements.txt diff --git a/flytectl/docs/docs-requirements.in b/flytectl/docs/docs-requirements.in new file mode 100644 index 0000000000..9d2c7c0a35 --- /dev/null +++ b/flytectl/docs/docs-requirements.in @@ -0,0 +1,8 @@ +sphinx +sphinx-panels +sphinx-prompt +furo +sphinx-copybutton +sphinx-reredirects +sphinx-fontawesome +sphinxcontrib-youtube diff --git a/flytectl/docs/docs-requirements.txt b/flytectl/docs/docs-requirements.txt new file mode 100644 index 0000000000..2f17c12754 --- /dev/null +++ b/flytectl/docs/docs-requirements.txt @@ -0,0 +1,87 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile docs-requirements.in -o docs-requirements.txt +alabaster==1.0.0 + # via sphinx +babel==2.16.0 + # via sphinx +beautifulsoup4==4.12.3 + # via furo +certifi==2024.8.30 + # via + # requests + # sphinx-prompt +charset-normalizer==3.4.0 + # via requests +docutils==0.21.2 + # via + # sphinx + # sphinx-panels + # sphinx-prompt +furo==2024.8.6 + # via -r docs-requirements.in +idna==3.10 + # via + # requests + # sphinx-prompt +imagesize==1.4.1 + # via sphinx +jinja2==3.1.4 + # via sphinx +markupsafe==3.0.2 + # via jinja2 +packaging==24.1 + # via sphinx +pygments==2.18.0 + # via + # furo + # sphinx + # sphinx-prompt +requests==2.32.3 + # via + # sphinx + # sphinxcontrib-youtube +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.6 + # via beautifulsoup4 +sphinx==8.1.3 + # via + # -r docs-requirements.in + # furo + # sphinx-basic-ng + # sphinx-copybutton + # sphinx-fontawesome + # sphinx-panels + # sphinx-prompt + # sphinx-reredirects + # sphinxcontrib-youtube +sphinx-basic-ng==1.0.0b2 + # via furo +sphinx-copybutton==0.5.2 + # via -r docs-requirements.in +sphinx-fontawesome==0.0.6 + # via -r docs-requirements.in +sphinx-panels==0.4.1 + # via -r docs-requirements.in +sphinx-prompt==1.9.0 + # via -r docs-requirements.in +sphinx-reredirects==0.1.5 + # via -r docs-requirements.in +sphinxcontrib-applehelp==2.0.0 + # via sphinx +sphinxcontrib-devhelp==2.0.0 + # via sphinx +sphinxcontrib-htmlhelp==2.1.0 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==2.0.0 + # via sphinx +sphinxcontrib-serializinghtml==2.0.0 + # via sphinx +sphinxcontrib-youtube==1.4.1 + # via -r docs-requirements.in +urllib3==2.2.3 + # via + # requests + # sphinx-prompt diff --git a/flytectl/docs/source/gen/flytectl.rst b/flytectl/docs/source/gen/flytectl.rst index 9109b234bd..b42c57d922 100644 --- a/flytectl/docs/source/gen/flytectl.rst +++ b/flytectl/docs/source/gen/flytectl.rst @@ -34,10 +34,12 @@ Options --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -59,10 +61,17 @@ Options --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. -h, --help help for flytectl + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_compile.rst b/flytectl/docs/source/gen/flytectl_compile.rst index 6ce685df5b..0df8a2c70a 100644 --- a/flytectl/docs/source/gen/flytectl_compile.rst +++ b/flytectl/docs/source/gen/flytectl_compile.rst @@ -60,10 +60,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -84,10 +86,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_completion.rst b/flytectl/docs/source/gen/flytectl_completion.rst index 5671d3453b..01d8a2e800 100644 --- a/flytectl/docs/source/gen/flytectl_completion.rst +++ b/flytectl/docs/source/gen/flytectl_completion.rst @@ -107,10 +107,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -131,10 +133,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_config.rst b/flytectl/docs/source/gen/flytectl_config.rst index be0ef53651..ba559e4fdf 100644 --- a/flytectl/docs/source/gen/flytectl_config.rst +++ b/flytectl/docs/source/gen/flytectl_config.rst @@ -44,10 +44,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -68,10 +70,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_config_discover.rst b/flytectl/docs/source/gen/flytectl_config_discover.rst index 6727e00da8..d09fbaf241 100644 --- a/flytectl/docs/source/gen/flytectl_config_discover.rst +++ b/flytectl/docs/source/gen/flytectl_config_discover.rst @@ -45,10 +45,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -71,10 +73,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_config_docs.rst b/flytectl/docs/source/gen/flytectl_config_docs.rst index 06d0969e83..30f0bfe1a8 100644 --- a/flytectl/docs/source/gen/flytectl_config_docs.rst +++ b/flytectl/docs/source/gen/flytectl_config_docs.rst @@ -45,10 +45,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -71,10 +73,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_config_init.rst b/flytectl/docs/source/gen/flytectl_config_init.rst index ea2a964d67..27b43bbe52 100644 --- a/flytectl/docs/source/gen/flytectl_config_init.rst +++ b/flytectl/docs/source/gen/flytectl_config_init.rst @@ -81,10 +81,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -107,10 +109,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_config_validate.rst b/flytectl/docs/source/gen/flytectl_config_validate.rst index 41a5511b11..d0ed7d1b1a 100644 --- a/flytectl/docs/source/gen/flytectl_config_validate.rst +++ b/flytectl/docs/source/gen/flytectl_config_validate.rst @@ -47,10 +47,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -73,10 +75,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_create.rst b/flytectl/docs/source/gen/flytectl_create.rst index 8827dc20e9..6dc452ec4b 100644 --- a/flytectl/docs/source/gen/flytectl_create.rst +++ b/flytectl/docs/source/gen/flytectl_create.rst @@ -46,10 +46,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -70,10 +72,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_create_execution.rst b/flytectl/docs/source/gen/flytectl_create_execution.rst index a51529dcbd..91c2ab15d4 100644 --- a/flytectl/docs/source/gen/flytectl_create_execution.rst +++ b/flytectl/docs/source/gen/flytectl_create_execution.rst @@ -75,20 +75,40 @@ The generated spec file can be modified to change the envs values, as shown belo task: core.control_flow.merge_sort.merge version: "v2" -4. Run the execution by passing the generated YAML file. +4. [Optional] Update the TargetExecutionCluster, if needed. +The generated spec file can be modified to change the TargetExecutionCluster values, as shown below: + +.. code-block:: yaml + + iamRoleARN: "" + inputs: + sorted_list1: + - 0 + sorted_list2: + - 0 + envs: + foo: bar + kubeServiceAcct: "" + targetDomain: "" + targetProject: "" + targetExecutionCluster: "" + task: core.control_flow.merge_sort.merge + version: "v2" + +5. 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 -5. To relaunch an execution, pass the current execution ID as follows: +6. To relaunch an execution, pass the current execution ID as follows: :: flytectl create execution --relaunch ffb31066a0f8b4d52b77 -p flytesnacks -d development -6. To recover an execution, i.e., recreate it from the last known failure point for previously-run workflow execution, run: +7. To recover an execution, i.e., recreate it from the last known failure point for previously-run workflow execution, run: :: @@ -96,7 +116,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. -7. You can create executions idempotently by naming them. This is also a way to *name* an execution for discovery. Note, +8. 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. @@ -104,7 +124,7 @@ will be raised. flytectl create execution --recover ffb31066a0f8b4d52b77 -p flytesnacks -d development custom_name -8. Generic/Struct/Dataclass/JSON types are supported for execution in a similar manner. +9. 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. :: @@ -124,7 +144,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. Modified file with struct data populated for 'x' and 'y' parameters for the task "core.type_system.custom_objects.add": +10. Modified file with struct data populated for 'x' and 'y' parameters for the task "core.type_system.custom_objects.add": :: @@ -148,7 +168,7 @@ The generated file would look similar to this. Here, empty values have been dump task: core.type_system.custom_objects.add version: v3 -10. If you have configured a plugin that implements github.com/flyteorg/flyteadmin/pkg/workflowengine/interfaces/WorkflowExecutor +11. 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: :: @@ -165,20 +185,21 @@ Options :: - --clusterPool string specify which cluster pool to assign execution to. - --dryRun execute command without making any modifications. - --execFile string file for the execution params. If not specified defaults to <_name>.execution_spec.yaml - -h, --help help for execution - --iamRoleARN string iam role ARN AuthRole for launching execution. - --kubeServiceAcct string kubernetes service account AuthRole for launching execution. - --overwriteCache skip cached results when performing execution, causing all outputs to be re-calculated and stored data to be overwritten. Does not work for recovered executions. - --recover string execution id to be recreated from the last known failure point. - --relaunch string execution id to be relaunched. - --targetDomain string project where execution needs to be created. If not specified configured domain would be used. - --targetProject string project where execution needs to be created. If not specified configured project would be used. - --task string - --version string specify version of execution workflow/task. - --workflow string + --clusterPool string specify which cluster pool to assign execution to. + --dryRun execute command without making any modifications. + --execFile string file for the execution params. If not specified defaults to <_name>.execution_spec.yaml + -h, --help help for execution + --iamRoleARN string iam role ARN AuthRole for launching execution. + --kubeServiceAcct string kubernetes service account AuthRole for launching execution. + --overwriteCache skip cached results when performing execution, causing all outputs to be re-calculated and stored data to be overwritten. Does not work for recovered executions. + --recover string execution id to be recreated from the last known failure point. + --relaunch string execution id to be relaunched. + --targetDomain string domain where execution needs to be created. If not specified configured domain would be used. + --targetExecutionCluster string cluster where execution needs to be created. If not specific the default would be used. + --targetProject string project where execution needs to be created. If not specified configured project would be used. + --task string + --version string specify version of execution workflow/task. + --workflow string Options inherited from parent commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -203,10 +224,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -227,10 +250,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_create_project.rst b/flytectl/docs/source/gen/flytectl_create_project.rst index 16dedc8af4..a7a0e829f4 100644 --- a/flytectl/docs/source/gen/flytectl_create_project.rst +++ b/flytectl/docs/source/gen/flytectl_create_project.rst @@ -83,10 +83,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -107,10 +109,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete.rst b/flytectl/docs/source/gen/flytectl_delete.rst index 485404ade9..2d87f99afc 100644 --- a/flytectl/docs/source/gen/flytectl_delete.rst +++ b/flytectl/docs/source/gen/flytectl_delete.rst @@ -46,10 +46,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -70,10 +72,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst index 5264b9046e..50d732c682 100644 --- a/flytectl/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst @@ -81,10 +81,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -105,10 +107,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_execution-cluster-label.rst b/flytectl/docs/source/gen/flytectl_delete_execution-cluster-label.rst index 3314aba82e..c99be61780 100644 --- a/flytectl/docs/source/gen/flytectl_delete_execution-cluster-label.rst +++ b/flytectl/docs/source/gen/flytectl_delete_execution-cluster-label.rst @@ -78,10 +78,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -102,10 +104,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_execution-queue-attribute.rst b/flytectl/docs/source/gen/flytectl_delete_execution-queue-attribute.rst index 57bd1c6d04..5bae8553eb 100644 --- a/flytectl/docs/source/gen/flytectl_delete_execution-queue-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_delete_execution-queue-attribute.rst @@ -82,10 +82,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -106,10 +108,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_execution.rst b/flytectl/docs/source/gen/flytectl_delete_execution.rst index c336e66abf..8f325aeb0c 100644 --- a/flytectl/docs/source/gen/flytectl_delete_execution.rst +++ b/flytectl/docs/source/gen/flytectl_delete_execution.rst @@ -89,10 +89,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -113,10 +115,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_plugin-override.rst b/flytectl/docs/source/gen/flytectl_delete_plugin-override.rst index 58e26d4457..902a175aff 100644 --- a/flytectl/docs/source/gen/flytectl_delete_plugin-override.rst +++ b/flytectl/docs/source/gen/flytectl_delete_plugin-override.rst @@ -83,10 +83,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -107,10 +109,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_task-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_delete_task-resource-attribute.rst index f523a7717e..ee00a740c4 100644 --- a/flytectl/docs/source/gen/flytectl_delete_task-resource-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_delete_task-resource-attribute.rst @@ -83,10 +83,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -107,10 +109,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_delete_workflow-execution-config.rst b/flytectl/docs/source/gen/flytectl_delete_workflow-execution-config.rst index 389dad93be..5403ab1a26 100644 --- a/flytectl/docs/source/gen/flytectl_delete_workflow-execution-config.rst +++ b/flytectl/docs/source/gen/flytectl_delete_workflow-execution-config.rst @@ -81,10 +81,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -105,10 +107,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_demo.rst b/flytectl/docs/source/gen/flytectl_demo.rst index 2176c7b95d..d0b10b555c 100644 --- a/flytectl/docs/source/gen/flytectl_demo.rst +++ b/flytectl/docs/source/gen/flytectl_demo.rst @@ -64,10 +64,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -88,10 +90,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_demo_exec.rst b/flytectl/docs/source/gen/flytectl_demo_exec.rst index 8a0c9c4861..ff649fa3ff 100644 --- a/flytectl/docs/source/gen/flytectl_demo_exec.rst +++ b/flytectl/docs/source/gen/flytectl_demo_exec.rst @@ -53,10 +53,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -77,10 +79,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_demo_reload.rst b/flytectl/docs/source/gen/flytectl_demo_reload.rst index 9fccacec1c..a971d11a4e 100644 --- a/flytectl/docs/source/gen/flytectl_demo_reload.rst +++ b/flytectl/docs/source/gen/flytectl_demo_reload.rst @@ -66,10 +66,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -90,10 +92,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_demo_start.rst b/flytectl/docs/source/gen/flytectl_demo_start.rst index 89ed10f585..669aac6409 100644 --- a/flytectl/docs/source/gen/flytectl_demo_start.rst +++ b/flytectl/docs/source/gen/flytectl_demo_start.rst @@ -127,10 +127,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -151,10 +153,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_demo_status.rst b/flytectl/docs/source/gen/flytectl_demo_status.rst index 3d21334326..0647451f30 100644 --- a/flytectl/docs/source/gen/flytectl_demo_status.rst +++ b/flytectl/docs/source/gen/flytectl_demo_status.rst @@ -53,10 +53,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -77,10 +79,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_demo_teardown.rst b/flytectl/docs/source/gen/flytectl_demo_teardown.rst index 42d9c22630..05c9e1a462 100644 --- a/flytectl/docs/source/gen/flytectl_demo_teardown.rst +++ b/flytectl/docs/source/gen/flytectl_demo_teardown.rst @@ -54,10 +54,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -78,10 +80,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get.rst b/flytectl/docs/source/gen/flytectl_get.rst index f48ddf3ef8..9bae30c3f5 100644 --- a/flytectl/docs/source/gen/flytectl_get.rst +++ b/flytectl/docs/source/gen/flytectl_get.rst @@ -46,10 +46,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -70,10 +72,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_cluster-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_get_cluster-resource-attribute.rst index b242491a88..0046a883d2 100644 --- a/flytectl/docs/source/gen/flytectl_get_cluster-resource-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_get_cluster-resource-attribute.rst @@ -89,10 +89,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -113,10 +115,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_execution-cluster-label.rst b/flytectl/docs/source/gen/flytectl_get_execution-cluster-label.rst index 9147ff0736..31837c402d 100644 --- a/flytectl/docs/source/gen/flytectl_get_execution-cluster-label.rst +++ b/flytectl/docs/source/gen/flytectl_get_execution-cluster-label.rst @@ -88,10 +88,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -112,10 +114,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_execution-queue-attribute.rst b/flytectl/docs/source/gen/flytectl_get_execution-queue-attribute.rst index 71929da6ae..0a4e14d01b 100644 --- a/flytectl/docs/source/gen/flytectl_get_execution-queue-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_get_execution-queue-attribute.rst @@ -91,10 +91,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -115,10 +117,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_execution.rst b/flytectl/docs/source/gen/flytectl_get_execution.rst index 56ed2a6a70..98898d2872 100644 --- a/flytectl/docs/source/gen/flytectl_get_execution.rst +++ b/flytectl/docs/source/gen/flytectl_get_execution.rst @@ -121,10 +121,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -145,10 +147,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_launchplan.rst b/flytectl/docs/source/gen/flytectl_get_launchplan.rst index e340b86636..d8855340b5 100644 --- a/flytectl/docs/source/gen/flytectl_get_launchplan.rst +++ b/flytectl/docs/source/gen/flytectl_get_launchplan.rst @@ -156,10 +156,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -180,10 +182,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_plugin-override.rst b/flytectl/docs/source/gen/flytectl_get_plugin-override.rst index bf9437513c..ef5c0f899a 100644 --- a/flytectl/docs/source/gen/flytectl_get_plugin-override.rst +++ b/flytectl/docs/source/gen/flytectl_get_plugin-override.rst @@ -110,10 +110,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -134,10 +136,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_project.rst b/flytectl/docs/source/gen/flytectl_get_project.rst index 07d25570a2..f9f6d4b3b0 100644 --- a/flytectl/docs/source/gen/flytectl_get_project.rst +++ b/flytectl/docs/source/gen/flytectl_get_project.rst @@ -93,10 +93,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -117,10 +119,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_task-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_get_task-resource-attribute.rst index 2b2f369afe..b55906720b 100644 --- a/flytectl/docs/source/gen/flytectl_get_task-resource-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_get_task-resource-attribute.rst @@ -41,7 +41,7 @@ Example: content of tra.yaml: :: - flytectl get task-resource-attribute --attrFile tra.yaml + flytectl get -p flytesnacks -d development task-resource-attribute --attrFile tra.yaml .. code-block:: yaml @@ -93,10 +93,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -117,10 +119,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_task.rst b/flytectl/docs/source/gen/flytectl_get_task.rst index 383645221e..92d0f7521a 100644 --- a/flytectl/docs/source/gen/flytectl_get_task.rst +++ b/flytectl/docs/source/gen/flytectl_get_task.rst @@ -137,10 +137,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -161,10 +163,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_workflow-execution-config.rst b/flytectl/docs/source/gen/flytectl_get_workflow-execution-config.rst index 8c332c3ada..3f0820838a 100644 --- a/flytectl/docs/source/gen/flytectl_get_workflow-execution-config.rst +++ b/flytectl/docs/source/gen/flytectl_get_workflow-execution-config.rst @@ -150,10 +150,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -174,10 +176,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_get_workflow.rst b/flytectl/docs/source/gen/flytectl_get_workflow.rst index f446fdeb9f..1dfa2a2213 100644 --- a/flytectl/docs/source/gen/flytectl_get_workflow.rst +++ b/flytectl/docs/source/gen/flytectl_get_workflow.rst @@ -121,10 +121,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -145,10 +147,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_register.rst b/flytectl/docs/source/gen/flytectl_register.rst index 745dffa9b6..5720f3915a 100644 --- a/flytectl/docs/source/gen/flytectl_register.rst +++ b/flytectl/docs/source/gen/flytectl_register.rst @@ -46,10 +46,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -70,10 +72,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_register_examples.rst b/flytectl/docs/source/gen/flytectl_register_examples.rst index 9c681548d1..a61c709e23 100644 --- a/flytectl/docs/source/gen/flytectl_register_examples.rst +++ b/flytectl/docs/source/gen/flytectl_register_examples.rst @@ -72,10 +72,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -96,10 +98,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_register_files.rst b/flytectl/docs/source/gen/flytectl_register_files.rst index 512b1166b6..2f29c612f2 100644 --- a/flytectl/docs/source/gen/flytectl_register_files.rst +++ b/flytectl/docs/source/gen/flytectl_register_files.rst @@ -149,10 +149,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -173,10 +175,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_sandbox.rst b/flytectl/docs/source/gen/flytectl_sandbox.rst index 8cc08fc448..b609cfb1ea 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox.rst @@ -70,10 +70,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -94,10 +96,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_sandbox_exec.rst b/flytectl/docs/source/gen/flytectl_sandbox_exec.rst index f1f3c44600..7089fa97ec 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_exec.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_exec.rst @@ -53,10 +53,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -77,10 +79,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_sandbox_start.rst b/flytectl/docs/source/gen/flytectl_sandbox_start.rst index 048b92b24e..e2c46b0ccc 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_start.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_start.rst @@ -122,10 +122,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -146,10 +148,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_sandbox_status.rst b/flytectl/docs/source/gen/flytectl_sandbox_status.rst index abce271578..abc05313e6 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_status.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_status.rst @@ -53,10 +53,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -77,10 +79,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst b/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst index c57c64b61a..7497ef6fcb 100644 --- a/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst +++ b/flytectl/docs/source/gen/flytectl_sandbox_teardown.rst @@ -53,10 +53,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -77,10 +79,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update.rst b/flytectl/docs/source/gen/flytectl_update.rst index ffc18b7101..6ce9100531 100644 --- a/flytectl/docs/source/gen/flytectl_update.rst +++ b/flytectl/docs/source/gen/flytectl_update.rst @@ -47,10 +47,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -71,10 +73,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_cluster-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_update_cluster-resource-attribute.rst index 55ea963f65..c488177371 100644 --- a/flytectl/docs/source/gen/flytectl_update_cluster-resource-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_update_cluster-resource-attribute.rst @@ -89,10 +89,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -113,10 +115,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_execution-cluster-label.rst b/flytectl/docs/source/gen/flytectl_update_execution-cluster-label.rst index 0117986578..30e0d8d74b 100644 --- a/flytectl/docs/source/gen/flytectl_update_execution-cluster-label.rst +++ b/flytectl/docs/source/gen/flytectl_update_execution-cluster-label.rst @@ -82,10 +82,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -106,10 +108,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_execution-queue-attribute.rst b/flytectl/docs/source/gen/flytectl_update_execution-queue-attribute.rst index 5b3f080c03..edc91e18d1 100644 --- a/flytectl/docs/source/gen/flytectl_update_execution-queue-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_update_execution-queue-attribute.rst @@ -93,10 +93,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -117,10 +119,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_execution.rst b/flytectl/docs/source/gen/flytectl_update_execution.rst index 373b625c9a..7c2a28d7fa 100644 --- a/flytectl/docs/source/gen/flytectl_update_execution.rst +++ b/flytectl/docs/source/gen/flytectl_update_execution.rst @@ -62,10 +62,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -86,10 +88,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_launchplan-meta.rst b/flytectl/docs/source/gen/flytectl_update_launchplan-meta.rst index 8e28b948c3..8ebab3cec8 100644 --- a/flytectl/docs/source/gen/flytectl_update_launchplan-meta.rst +++ b/flytectl/docs/source/gen/flytectl_update_launchplan-meta.rst @@ -67,10 +67,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -91,10 +93,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_launchplan.rst b/flytectl/docs/source/gen/flytectl_update_launchplan.rst index bb9992861d..2446e77f4a 100644 --- a/flytectl/docs/source/gen/flytectl_update_launchplan.rst +++ b/flytectl/docs/source/gen/flytectl_update_launchplan.rst @@ -63,10 +63,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -87,10 +89,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_plugin-override.rst b/flytectl/docs/source/gen/flytectl_update_plugin-override.rst index 95f744f85e..26c0690198 100644 --- a/flytectl/docs/source/gen/flytectl_update_plugin-override.rst +++ b/flytectl/docs/source/gen/flytectl_update_plugin-override.rst @@ -95,10 +95,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -119,10 +121,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_project.rst b/flytectl/docs/source/gen/flytectl_update_project.rst index ce203b736b..b405166eba 100644 --- a/flytectl/docs/source/gen/flytectl_update_project.rst +++ b/flytectl/docs/source/gen/flytectl_update_project.rst @@ -53,7 +53,7 @@ Then, pass it in using the *file* flag: To archive or activate (unarchive) a project using a *yaml* file: -* Add a state field, with a value of *0* for activated (unarchived) or *1* for archived, at the top level of the *yaml* file. +* Add a state field, with a value of *0* for activated (unarchived) or *1* for archived, at the top level of the the *yaml* file. * Add the *archive* flag to the command. @@ -133,10 +133,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -157,10 +159,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_task-meta.rst b/flytectl/docs/source/gen/flytectl_update_task-meta.rst index 61312af748..74f5502a4f 100644 --- a/flytectl/docs/source/gen/flytectl_update_task-meta.rst +++ b/flytectl/docs/source/gen/flytectl_update_task-meta.rst @@ -67,10 +67,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -91,10 +93,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_task-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_update_task-resource-attribute.rst index 0ef4798aab..798675b7b9 100644 --- a/flytectl/docs/source/gen/flytectl_update_task-resource-attribute.rst +++ b/flytectl/docs/source/gen/flytectl_update_task-resource-attribute.rst @@ -95,10 +95,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -119,10 +121,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_workflow-execution-config.rst b/flytectl/docs/source/gen/flytectl_update_workflow-execution-config.rst index b025df8a57..553a7c7e7d 100644 --- a/flytectl/docs/source/gen/flytectl_update_workflow-execution-config.rst +++ b/flytectl/docs/source/gen/flytectl_update_workflow-execution-config.rst @@ -91,10 +91,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -115,10 +117,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_update_workflow-meta.rst b/flytectl/docs/source/gen/flytectl_update_workflow-meta.rst index aadccfabd2..fcbf56d22e 100644 --- a/flytectl/docs/source/gen/flytectl_update_workflow-meta.rst +++ b/flytectl/docs/source/gen/flytectl_update_workflow-meta.rst @@ -67,10 +67,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -91,10 +93,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_upgrade.rst b/flytectl/docs/source/gen/flytectl_upgrade.rst index a0bcedda9d..23ea76ea60 100644 --- a/flytectl/docs/source/gen/flytectl_upgrade.rst +++ b/flytectl/docs/source/gen/flytectl_upgrade.rst @@ -61,10 +61,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -85,10 +87,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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 diff --git a/flytectl/docs/source/gen/flytectl_version.rst b/flytectl/docs/source/gen/flytectl_version.rst index 220a375741..6a075a71c8 100644 --- a/flytectl/docs/source/gen/flytectl_version.rst +++ b/flytectl/docs/source/gen/flytectl_version.rst @@ -50,10 +50,12 @@ Options inherited from parent commands --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") + --admin.maxMessageSizeBytes int The max size in bytes for incoming gRPC messages --admin.maxRetries int Max number of gRPC retries (default 4) --admin.perRetryTimeout string gRPC per retry timeout (default "15s") --admin.pkceConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") --admin.pkceConfig.timeout string Amount of time the browser session would be active for authentication from client app. (default "2m0s") + --admin.proxyCommand strings Command for external proxy-authorization token generation --admin.scopes strings List of scopes to request --admin.tokenRefreshWindow string Max duration between token refresh attempt and token expiry. (default "0s") --admin.tokenUrl string OPTIONAL: Your IdP's token endpoint. It'll be discovered from flyte admin's OAuth Metadata endpoint if not provided. @@ -74,10 +76,17 @@ Options inherited from parent commands --files.outputLocationPrefix string Custom output location prefix for offloaded types (files/schemas). --files.sourceUploadPath string Deprecated: Update flyte admin to avoid having to configure storage access from flytectl. --files.version string Version of the entity to be registered with flyte which are un-versioned after serialization. + -i, --interactive Set this flag to use an interactive CLI --logger.formatter.type string Sets logging format type. (default "json") --logger.level int Sets the minimum logging level. (default 3) --logger.mute Mutes all logs regardless of severity. Intended for benchmarks/tests only. --logger.show-source Includes source code location in logs. + --otel.file.filename string Filename to store exported telemetry traces (default "/tmp/trace.txt") + --otel.jaeger.endpoint string Endpoint for the jaeger telemetry trace ingestor (default "http://localhost:14268/api/traces") + --otel.otlpgrpc.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4317") + --otel.otlphttp.endpoint string Endpoint for the OTLP telemetry trace collector (default "http://localhost:4318/v1/traces") + --otel.sampler.parentSampler string Sets the parent sampler to use for the tracer (default "always") + --otel.type string Sets the type of exporter to configure [noop/file/jaeger/otlpgrpc/otlphttp]. (default "noop") -o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") -p, --project string Specifies the Flyte project. --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