From fce0445eda914b2d1b265988ccf37927fe1c80fa Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Wed, 14 Feb 2024 11:56:27 -0800 Subject: [PATCH] make -C docs gendocs Signed-off-by: Kevin Su --- cmd/root.go | 2 - docs/source/gen/flytectl.rst | 1 - docs/source/gen/flytectl_sandbox.rst | 127 ------------- docs/source/gen/flytectl_sandbox_exec.rst | 106 ----------- docs/source/gen/flytectl_sandbox_start.rst | 175 ------------------ docs/source/gen/flytectl_sandbox_status.rst | 106 ----------- docs/source/gen/flytectl_sandbox_teardown.rst | 106 ----------- go.sum | 1 + 8 files changed, 1 insertion(+), 623 deletions(-) delete mode 100644 docs/source/gen/flytectl_sandbox.rst delete mode 100644 docs/source/gen/flytectl_sandbox_exec.rst delete mode 100644 docs/source/gen/flytectl_sandbox_start.rst delete mode 100644 docs/source/gen/flytectl_sandbox_status.rst delete mode 100644 docs/source/gen/flytectl_sandbox_teardown.rst diff --git a/cmd/root.go b/cmd/root.go index 418406c0..1d4d76d1 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -16,7 +16,6 @@ import ( "github.com/flyteorg/flytectl/cmd/demo" "github.com/flyteorg/flytectl/cmd/get" "github.com/flyteorg/flytectl/cmd/register" - "github.com/flyteorg/flytectl/cmd/sandbox" "github.com/flyteorg/flytectl/cmd/update" "github.com/flyteorg/flytectl/cmd/upgrade" "github.com/flyteorg/flytectl/cmd/version" @@ -64,7 +63,6 @@ func newRootCmd() *cobra.Command { rootCmd.AddCommand(update.CreateUpdateCommand()) rootCmd.AddCommand(register.RemoteRegisterCommand()) rootCmd.AddCommand(delete.RemoteDeleteCommand()) - rootCmd.AddCommand(sandbox.CreateSandboxCommand()) rootCmd.AddCommand(demo.CreateDemoCommand()) rootCmd.AddCommand(configuration.CreateConfigCommand()) rootCmd.AddCommand(completionCmd) diff --git a/docs/source/gen/flytectl.rst b/docs/source/gen/flytectl.rst index 9109b234..8c90f440 100644 --- a/docs/source/gen/flytectl.rst +++ b/docs/source/gen/flytectl.rst @@ -92,7 +92,6 @@ SEE ALSO * :doc:`flytectl_demo` - Helps with demo interactions like start, teardown, status, and exec. * :doc:`flytectl_get` - Fetches various Flyte resources such as tasks, workflows, launch plans, executions, and projects. * :doc:`flytectl_register` - Registers tasks, workflows, and launch plans from a list of generated serialized files. -* :doc:`flytectl_sandbox` - Helps with sandbox interactions like start, teardown, status, and exec. * :doc:`flytectl_update` - Update Flyte resources e.g., project. * :doc:`flytectl_upgrade` - Upgrades/rollbacks to a Flyte version. * :doc:`flytectl_version` - Fetches Flyte version diff --git a/docs/source/gen/flytectl_sandbox.rst b/docs/source/gen/flytectl_sandbox.rst deleted file mode 100644 index 8cc08fc4..00000000 --- a/docs/source/gen/flytectl_sandbox.rst +++ /dev/null @@ -1,127 +0,0 @@ -.. _flytectl_sandbox: - -flytectl sandbox ----------------- - -Helps with sandbox interactions like start, teardown, status, and exec. - -Synopsis -~~~~~~~~ - - - -Flyte Sandbox is a fully standalone minimal environment for running Flyte. -It provides a simplified way of running Flyte sandbox as a single Docker container locally. - -To create a sandbox cluster, run: -:: - - flytectl sandbox start - -To remove a sandbox cluster, run: -:: - - flytectl sandbox teardown - -To check the status of the sandbox container, run: -:: - - flytectl sandbox status - -To execute commands inside the sandbox container, use exec: -:: - - flytectl sandbox exec -- pwd - -For just printing the docker commands for bringingup the demo container -:: - - flytectl demo start --dryRun - - - -Options -~~~~~~~ - -:: - - -h, --help help for sandbox - -Options inherited from parent commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - --admin.audience string Audience to use when initiating OAuth2 authorization requests. - --admin.authType string Type of OAuth2 flow used for communicating with admin.ClientSecret, Pkce, ExternalCommand are valid values (default "ClientSecret") - --admin.authorizationHeader string Custom metadata header to pass JWT - --admin.authorizationServerUrl string This is the URL to your IdP's authorization server. It'll default to Endpoint - --admin.caCertFilePath string Use specified certificate file to verify the admin server peer. - --admin.clientId string Client ID (default "flytepropeller") - --admin.clientSecretEnvVar string Environment variable containing the client secret - --admin.clientSecretLocation string File containing the client secret (default "/etc/secrets/client_secret") - --admin.command strings Command for external authentication token generation - --admin.defaultServiceConfig string - --admin.deviceFlowConfig.pollInterval string amount of time the device flow would poll the token endpoint if auth server doesn't return a polling interval. Okta and google IDP do return an interval' (default "5s") - --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") - --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") - --admin.endpoint string For admin types, specify where the uri of the service is located. - --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. - --admin.insecure Use insecure connection. - --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' - --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") - --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.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. - --admin.useAudienceFromAdmin Use Audience configured from admins public endpoint config. - --admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information. - -c, --config string config file (default is $HOME/.flyte/config.yaml) - --console.endpoint string Endpoint of console, if different than flyte admin - -d, --domain string Specifies the Flyte project's domain. - --files.archive Pass in archive file either an http link or local path. - --files.assumableIamRole string Custom assumable iam auth role to register launch plans with. - --files.continueOnError Continue on error when registering files. - --files.destinationDirectory string Location of source code in container. - --files.dryRun Execute command without making any modifications. - --files.enableSchedule Enable the schedule if the files contain schedulable launchplan. - --files.force Force use of version number on entities registered with flyte. - --files.k8ServiceAccount string Deprecated. Please use --K8sServiceAccount - --files.k8sServiceAccount string Custom kubernetes service account auth role to register launch plans with. - --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. - --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. - -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 - --storage.cache.target_gc_percent int Sets the garbage collection target percentage. - --storage.connection.access-key string Access key to use. Only required when authtype is set to accesskey. - --storage.connection.auth-type string Auth Type to use [iam, accesskey]. (default "iam") - --storage.connection.disable-ssl Disables SSL connection. Should only be used for development. - --storage.connection.endpoint string URL for storage client to connect to. - --storage.connection.region string Region to connect to. (default "us-east-1") - --storage.connection.secret-key string Secret to use when accesskey is set. - --storage.container string Initial container (in s3 a bucket) to create -if it doesn't exist-.' - --storage.defaultHttpClient.timeout string Sets time out on the http client. (default "0s") - --storage.enable-multicontainer If this is true, then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered - --storage.limits.maxDownloadMBs int Maximum allowed download size (in MBs) per call. (default 2) - --storage.stow.config stringToString Configuration for stow backend. Refer to github/flyteorg/stow (default []) - --storage.stow.kind string Kind of Stow backend to use. Refer to github/flyteorg/stow - --storage.type string Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3") - -SEE ALSO -~~~~~~~~ - -* :doc:`flytectl` - Flytectl CLI tool -* :doc:`flytectl_sandbox_exec` - Executes non-interactive command inside the sandbox container -* :doc:`flytectl_sandbox_start` - Starts the Flyte sandbox cluster. -* :doc:`flytectl_sandbox_status` - Gets the status of the sandbox environment. -* :doc:`flytectl_sandbox_teardown` - Cleans up the sandbox environment - diff --git a/docs/source/gen/flytectl_sandbox_exec.rst b/docs/source/gen/flytectl_sandbox_exec.rst deleted file mode 100644 index f1f3c446..00000000 --- a/docs/source/gen/flytectl_sandbox_exec.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _flytectl_sandbox_exec: - -flytectl sandbox exec ---------------------- - -Executes non-interactive command inside the sandbox container - -Synopsis -~~~~~~~~ - - - -Run non-interactive commands inside the sandbox container and immediately return the output. -By default, "flytectl exec" is present in the /root directory inside the sandbox container. - -:: - - flytectl sandbox exec -- ls -al - -Usage - -:: - - flytectl sandbox exec [flags] - -Options -~~~~~~~ - -:: - - -h, --help help for exec - -Options inherited from parent commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - --admin.audience string Audience to use when initiating OAuth2 authorization requests. - --admin.authType string Type of OAuth2 flow used for communicating with admin.ClientSecret, Pkce, ExternalCommand are valid values (default "ClientSecret") - --admin.authorizationHeader string Custom metadata header to pass JWT - --admin.authorizationServerUrl string This is the URL to your IdP's authorization server. It'll default to Endpoint - --admin.caCertFilePath string Use specified certificate file to verify the admin server peer. - --admin.clientId string Client ID (default "flytepropeller") - --admin.clientSecretEnvVar string Environment variable containing the client secret - --admin.clientSecretLocation string File containing the client secret (default "/etc/secrets/client_secret") - --admin.command strings Command for external authentication token generation - --admin.defaultServiceConfig string - --admin.deviceFlowConfig.pollInterval string amount of time the device flow would poll the token endpoint if auth server doesn't return a polling interval. Okta and google IDP do return an interval' (default "5s") - --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") - --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") - --admin.endpoint string For admin types, specify where the uri of the service is located. - --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. - --admin.insecure Use insecure connection. - --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' - --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") - --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.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. - --admin.useAudienceFromAdmin Use Audience configured from admins public endpoint config. - --admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information. - -c, --config string config file (default is $HOME/.flyte/config.yaml) - --console.endpoint string Endpoint of console, if different than flyte admin - -d, --domain string Specifies the Flyte project's domain. - --files.archive Pass in archive file either an http link or local path. - --files.assumableIamRole string Custom assumable iam auth role to register launch plans with. - --files.continueOnError Continue on error when registering files. - --files.destinationDirectory string Location of source code in container. - --files.dryRun Execute command without making any modifications. - --files.enableSchedule Enable the schedule if the files contain schedulable launchplan. - --files.force Force use of version number on entities registered with flyte. - --files.k8ServiceAccount string Deprecated. Please use --K8sServiceAccount - --files.k8sServiceAccount string Custom kubernetes service account auth role to register launch plans with. - --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. - --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. - -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 - --storage.cache.target_gc_percent int Sets the garbage collection target percentage. - --storage.connection.access-key string Access key to use. Only required when authtype is set to accesskey. - --storage.connection.auth-type string Auth Type to use [iam, accesskey]. (default "iam") - --storage.connection.disable-ssl Disables SSL connection. Should only be used for development. - --storage.connection.endpoint string URL for storage client to connect to. - --storage.connection.region string Region to connect to. (default "us-east-1") - --storage.connection.secret-key string Secret to use when accesskey is set. - --storage.container string Initial container (in s3 a bucket) to create -if it doesn't exist-.' - --storage.defaultHttpClient.timeout string Sets time out on the http client. (default "0s") - --storage.enable-multicontainer If this is true, then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered - --storage.limits.maxDownloadMBs int Maximum allowed download size (in MBs) per call. (default 2) - --storage.stow.config stringToString Configuration for stow backend. Refer to github/flyteorg/stow (default []) - --storage.stow.kind string Kind of Stow backend to use. Refer to github/flyteorg/stow - --storage.type string Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3") - -SEE ALSO -~~~~~~~~ - -* :doc:`flytectl_sandbox` - Helps with sandbox interactions like start, teardown, status, and exec. - diff --git a/docs/source/gen/flytectl_sandbox_start.rst b/docs/source/gen/flytectl_sandbox_start.rst deleted file mode 100644 index 048b92b2..00000000 --- a/docs/source/gen/flytectl_sandbox_start.rst +++ /dev/null @@ -1,175 +0,0 @@ -.. _flytectl_sandbox_start: - -flytectl sandbox start ----------------------- - -Starts the Flyte sandbox cluster. - -Synopsis -~~~~~~~~ - - - -Flyte sandbox is a fully standalone minimal environment for running Flyte. -It provides a simplified way of running Flyte sandbox as a single Docker container locally. - -Starts the sandbox cluster without any source code: -:: - - flytectl sandbox start - -Mounts your source code repository inside the sandbox: - -:: - - flytectl sandbox start --source=$HOME/flyteorg/flytesnacks - -Runs a specific version of Flyte. Flytectl sandbox only supports Flyte version available in the Github release, https://github.com/flyteorg/flyte/tags. - -:: - - flytectl sandbox start --version=v0.14.0 - -.. note:: - Flytectl Sandbox is only supported for Flyte versions > v0.10.0. - -Runs the latest pre release of Flyte. -:: - - flytectl sandbox start --pre - -Note: The pre release flag will be ignored if the user passes the version flag. In that case, Flytectl will use a specific version. - -Specify a Flyte Sandbox compliant image with the registry. This is useful in case you want to use an image from your registry. -:: - - flytectl sandbox start --image docker.io/my-override:latest - -Note: If image flag is passed then Flytectl will ignore version and pre flags. - -Specify a Flyte Sandbox image pull policy. Possible pull policy values are Always, IfNotPresent, or Never: -:: - - flytectl sandbox start --image docker.io/my-override:latest --imagePullPolicy Always - -Start sandbox cluster passing environment variables. This can be used to pass docker specific env variables or flyte specific env variables. -eg : for passing timeout value in secs for the sandbox container use the following. -:: - - flytectl sandbox start --env FLYTE_TIMEOUT=700 - - -The DURATION can be a positive integer or a floating-point number, followed by an optional unit suffix:: -s - seconds (default) -m - minutes -h - hours -d - days -When no unit is used, it defaults to seconds. If the duration is set to zero, the associated timeout is disabled. - - -eg : for passing multiple environment variables -:: - - flytectl sandbox start --env USER=foo --env PASSWORD=bar - - -Usage - - -:: - - flytectl sandbox start [flags] - -Options -~~~~~~~ - -:: - - --dev Optional. Only start minio and postgres in the sandbox. - --disable-agent Optional. Disable the agent service. - --dryRun Optional. Only print the docker commands to bring up flyte sandbox/demo container.This will still call github api's to get the latest flyte release to use' - --env strings Optional. Provide Env variable in key=value format which can be passed to sandbox container. - --force Optional. Forcefully delete existing sandbox cluster if it exists. - -h, --help help for start - --image string Optional. Provide a fully qualified path to a Flyte compliant docker image. - --imagePullOptions.platform string Forces a specific platform's image to be pulled.' - --imagePullOptions.registryAuth string The base64 encoded credentials for the registry. - --imagePullPolicy ImagePullPolicy Optional. Defines the image pull behavior [Always/IfNotPresent/Never] (default Always) - --pre Optional. Pre release Version of flyte will be used for sandbox. - --source string deprecated, path of your source code, please build images with local daemon - --version string Version of flyte. Only supports flyte releases greater than v0.10.0 - -Options inherited from parent commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - --admin.audience string Audience to use when initiating OAuth2 authorization requests. - --admin.authType string Type of OAuth2 flow used for communicating with admin.ClientSecret, Pkce, ExternalCommand are valid values (default "ClientSecret") - --admin.authorizationHeader string Custom metadata header to pass JWT - --admin.authorizationServerUrl string This is the URL to your IdP's authorization server. It'll default to Endpoint - --admin.caCertFilePath string Use specified certificate file to verify the admin server peer. - --admin.clientId string Client ID (default "flytepropeller") - --admin.clientSecretEnvVar string Environment variable containing the client secret - --admin.clientSecretLocation string File containing the client secret (default "/etc/secrets/client_secret") - --admin.command strings Command for external authentication token generation - --admin.defaultServiceConfig string - --admin.deviceFlowConfig.pollInterval string amount of time the device flow would poll the token endpoint if auth server doesn't return a polling interval. Okta and google IDP do return an interval' (default "5s") - --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") - --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") - --admin.endpoint string For admin types, specify where the uri of the service is located. - --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. - --admin.insecure Use insecure connection. - --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' - --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") - --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.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. - --admin.useAudienceFromAdmin Use Audience configured from admins public endpoint config. - --admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information. - -c, --config string config file (default is $HOME/.flyte/config.yaml) - --console.endpoint string Endpoint of console, if different than flyte admin - -d, --domain string Specifies the Flyte project's domain. - --files.archive Pass in archive file either an http link or local path. - --files.assumableIamRole string Custom assumable iam auth role to register launch plans with. - --files.continueOnError Continue on error when registering files. - --files.destinationDirectory string Location of source code in container. - --files.dryRun Execute command without making any modifications. - --files.enableSchedule Enable the schedule if the files contain schedulable launchplan. - --files.force Force use of version number on entities registered with flyte. - --files.k8ServiceAccount string Deprecated. Please use --K8sServiceAccount - --files.k8sServiceAccount string Custom kubernetes service account auth role to register launch plans with. - --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. - --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. - -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 - --storage.cache.target_gc_percent int Sets the garbage collection target percentage. - --storage.connection.access-key string Access key to use. Only required when authtype is set to accesskey. - --storage.connection.auth-type string Auth Type to use [iam, accesskey]. (default "iam") - --storage.connection.disable-ssl Disables SSL connection. Should only be used for development. - --storage.connection.endpoint string URL for storage client to connect to. - --storage.connection.region string Region to connect to. (default "us-east-1") - --storage.connection.secret-key string Secret to use when accesskey is set. - --storage.container string Initial container (in s3 a bucket) to create -if it doesn't exist-.' - --storage.defaultHttpClient.timeout string Sets time out on the http client. (default "0s") - --storage.enable-multicontainer If this is true, then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered - --storage.limits.maxDownloadMBs int Maximum allowed download size (in MBs) per call. (default 2) - --storage.stow.config stringToString Configuration for stow backend. Refer to github/flyteorg/stow (default []) - --storage.stow.kind string Kind of Stow backend to use. Refer to github/flyteorg/stow - --storage.type string Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3") - -SEE ALSO -~~~~~~~~ - -* :doc:`flytectl_sandbox` - Helps with sandbox interactions like start, teardown, status, and exec. - diff --git a/docs/source/gen/flytectl_sandbox_status.rst b/docs/source/gen/flytectl_sandbox_status.rst deleted file mode 100644 index abce2715..00000000 --- a/docs/source/gen/flytectl_sandbox_status.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _flytectl_sandbox_status: - -flytectl sandbox status ------------------------ - -Gets the status of the sandbox environment. - -Synopsis -~~~~~~~~ - - - -Retrieves the status of the sandbox environment. Currently, Flyte sandbox runs as a local Docker container. - -Usage -:: - - flytectl sandbox status - - - -:: - - flytectl sandbox status [flags] - -Options -~~~~~~~ - -:: - - -h, --help help for status - -Options inherited from parent commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - --admin.audience string Audience to use when initiating OAuth2 authorization requests. - --admin.authType string Type of OAuth2 flow used for communicating with admin.ClientSecret, Pkce, ExternalCommand are valid values (default "ClientSecret") - --admin.authorizationHeader string Custom metadata header to pass JWT - --admin.authorizationServerUrl string This is the URL to your IdP's authorization server. It'll default to Endpoint - --admin.caCertFilePath string Use specified certificate file to verify the admin server peer. - --admin.clientId string Client ID (default "flytepropeller") - --admin.clientSecretEnvVar string Environment variable containing the client secret - --admin.clientSecretLocation string File containing the client secret (default "/etc/secrets/client_secret") - --admin.command strings Command for external authentication token generation - --admin.defaultServiceConfig string - --admin.deviceFlowConfig.pollInterval string amount of time the device flow would poll the token endpoint if auth server doesn't return a polling interval. Okta and google IDP do return an interval' (default "5s") - --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") - --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") - --admin.endpoint string For admin types, specify where the uri of the service is located. - --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. - --admin.insecure Use insecure connection. - --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' - --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") - --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.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. - --admin.useAudienceFromAdmin Use Audience configured from admins public endpoint config. - --admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information. - -c, --config string config file (default is $HOME/.flyte/config.yaml) - --console.endpoint string Endpoint of console, if different than flyte admin - -d, --domain string Specifies the Flyte project's domain. - --files.archive Pass in archive file either an http link or local path. - --files.assumableIamRole string Custom assumable iam auth role to register launch plans with. - --files.continueOnError Continue on error when registering files. - --files.destinationDirectory string Location of source code in container. - --files.dryRun Execute command without making any modifications. - --files.enableSchedule Enable the schedule if the files contain schedulable launchplan. - --files.force Force use of version number on entities registered with flyte. - --files.k8ServiceAccount string Deprecated. Please use --K8sServiceAccount - --files.k8sServiceAccount string Custom kubernetes service account auth role to register launch plans with. - --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. - --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. - -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 - --storage.cache.target_gc_percent int Sets the garbage collection target percentage. - --storage.connection.access-key string Access key to use. Only required when authtype is set to accesskey. - --storage.connection.auth-type string Auth Type to use [iam, accesskey]. (default "iam") - --storage.connection.disable-ssl Disables SSL connection. Should only be used for development. - --storage.connection.endpoint string URL for storage client to connect to. - --storage.connection.region string Region to connect to. (default "us-east-1") - --storage.connection.secret-key string Secret to use when accesskey is set. - --storage.container string Initial container (in s3 a bucket) to create -if it doesn't exist-.' - --storage.defaultHttpClient.timeout string Sets time out on the http client. (default "0s") - --storage.enable-multicontainer If this is true, then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered - --storage.limits.maxDownloadMBs int Maximum allowed download size (in MBs) per call. (default 2) - --storage.stow.config stringToString Configuration for stow backend. Refer to github/flyteorg/stow (default []) - --storage.stow.kind string Kind of Stow backend to use. Refer to github/flyteorg/stow - --storage.type string Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3") - -SEE ALSO -~~~~~~~~ - -* :doc:`flytectl_sandbox` - Helps with sandbox interactions like start, teardown, status, and exec. - diff --git a/docs/source/gen/flytectl_sandbox_teardown.rst b/docs/source/gen/flytectl_sandbox_teardown.rst deleted file mode 100644 index c57c64b6..00000000 --- a/docs/source/gen/flytectl_sandbox_teardown.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _flytectl_sandbox_teardown: - -flytectl sandbox teardown -------------------------- - -Cleans up the sandbox environment - -Synopsis -~~~~~~~~ - - - -Removes the Sandbox cluster and all the Flyte config created by 'sandbox start': -:: - - flytectl sandbox teardown - - -Usage - - -:: - - flytectl sandbox teardown [flags] - -Options -~~~~~~~ - -:: - - -h, --help help for teardown - -Options inherited from parent commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - --admin.audience string Audience to use when initiating OAuth2 authorization requests. - --admin.authType string Type of OAuth2 flow used for communicating with admin.ClientSecret, Pkce, ExternalCommand are valid values (default "ClientSecret") - --admin.authorizationHeader string Custom metadata header to pass JWT - --admin.authorizationServerUrl string This is the URL to your IdP's authorization server. It'll default to Endpoint - --admin.caCertFilePath string Use specified certificate file to verify the admin server peer. - --admin.clientId string Client ID (default "flytepropeller") - --admin.clientSecretEnvVar string Environment variable containing the client secret - --admin.clientSecretLocation string File containing the client secret (default "/etc/secrets/client_secret") - --admin.command strings Command for external authentication token generation - --admin.defaultServiceConfig string - --admin.deviceFlowConfig.pollInterval string amount of time the device flow would poll the token endpoint if auth server doesn't return a polling interval. Okta and google IDP do return an interval' (default "5s") - --admin.deviceFlowConfig.refreshTime string grace period from the token expiry after which it would refresh the token. (default "5m0s") - --admin.deviceFlowConfig.timeout string amount of time the device flow should complete or else it will be cancelled. (default "10m0s") - --admin.endpoint string For admin types, specify where the uri of the service is located. - --admin.httpProxyURL string OPTIONAL: HTTP Proxy to be used for OAuth requests. - --admin.insecure Use insecure connection. - --admin.insecureSkipVerify InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. Caution : shouldn't be use for production usecases' - --admin.maxBackoffDelay string Max delay for grpc backoff (default "8s") - --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.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. - --admin.useAudienceFromAdmin Use Audience configured from admins public endpoint config. - --admin.useAuth Deprecated: Auth will be enabled/disabled based on admin's dynamically discovered information. - -c, --config string config file (default is $HOME/.flyte/config.yaml) - --console.endpoint string Endpoint of console, if different than flyte admin - -d, --domain string Specifies the Flyte project's domain. - --files.archive Pass in archive file either an http link or local path. - --files.assumableIamRole string Custom assumable iam auth role to register launch plans with. - --files.continueOnError Continue on error when registering files. - --files.destinationDirectory string Location of source code in container. - --files.dryRun Execute command without making any modifications. - --files.enableSchedule Enable the schedule if the files contain schedulable launchplan. - --files.force Force use of version number on entities registered with flyte. - --files.k8ServiceAccount string Deprecated. Please use --K8sServiceAccount - --files.k8sServiceAccount string Custom kubernetes service account auth role to register launch plans with. - --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. - --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. - -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 - --storage.cache.target_gc_percent int Sets the garbage collection target percentage. - --storage.connection.access-key string Access key to use. Only required when authtype is set to accesskey. - --storage.connection.auth-type string Auth Type to use [iam, accesskey]. (default "iam") - --storage.connection.disable-ssl Disables SSL connection. Should only be used for development. - --storage.connection.endpoint string URL for storage client to connect to. - --storage.connection.region string Region to connect to. (default "us-east-1") - --storage.connection.secret-key string Secret to use when accesskey is set. - --storage.container string Initial container (in s3 a bucket) to create -if it doesn't exist-.' - --storage.defaultHttpClient.timeout string Sets time out on the http client. (default "0s") - --storage.enable-multicontainer If this is true, then the container argument is overlooked and redundant. This config will automatically open new connections to new containers/buckets as they are encountered - --storage.limits.maxDownloadMBs int Maximum allowed download size (in MBs) per call. (default 2) - --storage.stow.config stringToString Configuration for stow backend. Refer to github/flyteorg/stow (default []) - --storage.stow.kind string Kind of Stow backend to use. Refer to github/flyteorg/stow - --storage.type string Sets the type of storage to configure [s3/minio/local/mem/stow]. (default "s3") - -SEE ALSO -~~~~~~~~ - -* :doc:`flytectl_sandbox` - Helps with sandbox interactions like start, teardown, status, and exec. - diff --git a/go.sum b/go.sum index 88b64583..aeef3581 100644 --- a/go.sum +++ b/go.sum @@ -1429,6 +1429,7 @@ k8s.io/kube-openapi v0.0.0-20201113171705-d219536bb9fd/go.mod h1:WOJ3KddDSol4tAG k8s.io/kube-openapi v0.0.0-20220328201542-3ee0da9b0b42/go.mod h1:Z/45zLw8lUo4wdiUkI+v/ImEGAvu3WatcZl3lPMR4Rk= k8s.io/kube-openapi v0.0.0-20230501164219-8b0f38b5fd1f h1:2kWPakN3i/k81b0gvD5C5FJ2kxm1WrQFanWchyKuqGg= k8s.io/kube-openapi v0.0.0-20230501164219-8b0f38b5fd1f/go.mod h1:byini6yhqGC14c3ebc/QwanvYwhuMWF6yz2F8uwW8eg= +k8s.io/kubernetes v1.13.0/go.mod h1:ocZa8+6APFNC2tX1DZASIbocyYT5jHzqFVsY5aoB7Jk= k8s.io/utils v0.0.0-20201110183641-67b214c5f920/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= k8s.io/utils v0.0.0-20210802155522-efc7438f0176/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA=