flytectl demo start#
Starts the Flyte demo cluster.
Synopsis#
Flyte demo is a fully standalone minimal environment for running Flyte. It provides a simplified way of running Flyte demo as a single Docker container locally.
Starts the demo cluster without any source code:
flytectl demo start
Runs a dev cluster, which only has minio and postgres pod.
flytectl demo start --dev
Mounts your source code repository inside the demo cluster:
flytectl demo start --source=$HOME/flyteorg/flytesnacks
Specify a Flyte demo compliant image with the registry. This is useful in case you want to use an image from your registry.
flytectl demo start --image docker.io/my-override:latest
Note: If image flag is passed then Flytectl will ignore version and pre flags.
Specify a Flyte demo image pull policy. Possible pull policy values are Always, IfNotPresent, or Never:
flytectl demo start --image docker.io/my-override:latest --imagePullPolicy Always
Runs a specific version of Flyte. Flytectl demo only supports Flyte version available in the Github release, flyteorg/flyte.
flytectl demo start --version=v0.14.0
Note
Flytectl demo is only supported for Flyte versions >= v1.0.0
Runs the latest pre release of Flyte.
flytectl demo start --pre
Start demo 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 demo container use the following.
flytectl demo 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 demo start --env USER=foo --env PASSWORD=bar
For just printing the docker commands for bringing up the demo container
flytectl demo start --dryRun
Usage
flytectl demo 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#
flytectl demo - Helps with demo interactions like start, teardown, status, and exec.