`Flytectl` Reference¶

Install¶

Flytectl is a Golang binary and can be installed on any platform supported by golang

brew install flyteorg/homebrew-tap/flytectl

Upgrade existing installation using the following command:

brew upgrade flytectl

curl -s https://raw.githubusercontent.com/lyft/flytectl/master/install.sh | bash

Test if Flytectl is installed correctly (your Flytectl version should be > 0.2.0) using the following command:

flytectl version

Configure¶

Flytectl allows configuring using a YAML file or pass every configuration value on command-line. The following configuration is useful to setup.

Basic Configuration¶

Flytectl configuration

Automatically configured for you by flytectl sandbox command.

admin:
  # For GRPC endpoints you might want to use dns:///flyte.myexample.com
  endpoint: dns:///localhost:30081
  insecure: true
  authType: Pkce # if using authentication or just drop this. If insecure set insecure: True
storage:
  connection:
    access-key: minio
    auth-type: accesskey
    disable-ssl: true
    endpoint: http://localhost:30084
    region: my-region-here
    secret-key: miniostorage
  container: my-s3-bucket
  type: minio

admin:
  # For GRPC endpoints you might want to use dns:///flyte.myexample.com
  endpoint: dns:///<replace-me>
  authType: Pkce # if using authentication or just drop this. If insecure set insecure: True
storage:
  kind: s3
  config:
    auth_type: iam
    region: <replace> # Example: us-east-2
  container: <replace> # Example my-bucket. Flyte k8s cluster / service account for execution should have read access to this bucket

admin:
  # For GRPC endpoints you might want to use dns:///flyte.myexample.com
  endpoint: dns:///<replace-me>
  authType: Pkce # if using authentication or just drop this. If insecure set insecure: True
storage:
  kind: google
  config:
    json: ""
    project_id: <replace-me> # TODO: replace <project-id> with the GCP project ID
    scopes: https://www.googleapis.com/auth/devstorage.read_write
  container: <replace> # Example my-bucket. Flyte k8s cluster / service account for execution should have access to this bucket

Flytectl Reference¶

Install¶

Configure¶

Basic Configuration¶

`Flytectl` Reference¶