From 44a7a7a0be7bf7be21656b56b9d6f9121ee59406 Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Wed, 14 Feb 2024 11:47:28 -0800 Subject: [PATCH 1/5] Remove sandbox command Signed-off-by: Kevin Su --- cmd/sandbox/exec.go | 50 --------------------- cmd/sandbox/exec_test.go | 76 -------------------------------- cmd/sandbox/sandbox.go | 70 ------------------------------ cmd/sandbox/sandbox_test.go | 39 ----------------- cmd/sandbox/start.go | 84 ------------------------------------ cmd/sandbox/start_test.go | 1 - cmd/sandbox/status.go | 32 -------------- cmd/sandbox/status_test.go | 39 ----------------- cmd/sandbox/teardown.go | 32 -------------- cmd/sandbox/teardown_test.go | 34 --------------- 10 files changed, 457 deletions(-) delete mode 100644 cmd/sandbox/exec.go delete mode 100644 cmd/sandbox/exec_test.go delete mode 100644 cmd/sandbox/sandbox.go delete mode 100644 cmd/sandbox/sandbox_test.go delete mode 100644 cmd/sandbox/start.go delete mode 100644 cmd/sandbox/start_test.go delete mode 100644 cmd/sandbox/status.go delete mode 100644 cmd/sandbox/status_test.go delete mode 100644 cmd/sandbox/teardown.go delete mode 100644 cmd/sandbox/teardown_test.go diff --git a/cmd/sandbox/exec.go b/cmd/sandbox/exec.go deleted file mode 100644 index 0d45c235..00000000 --- a/cmd/sandbox/exec.go +++ /dev/null @@ -1,50 +0,0 @@ -package sandbox - -import ( - "context" - "fmt" - - cmdCore "github.com/flyteorg/flytectl/cmd/core" - "github.com/flyteorg/flytectl/pkg/docker" -) - -const ( - execShort = "Executes non-interactive command inside the sandbox container" - execLong = ` -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` -) - -func sandboxClusterExec(ctx context.Context, args []string, cmdCtx cmdCore.CommandContext) error { - cli, err := docker.GetDockerClient() - if err != nil { - return err - } - if len(args) > 0 { - return execute(ctx, cli, args) - } - return fmt.Errorf("missing argument. Please check usage examples by running flytectl sandbox exec --help") -} - -func execute(ctx context.Context, cli docker.Docker, args []string) error { - c, err := docker.GetSandbox(ctx, cli) - if err != nil { - return err - } - if c != nil { - exec, err := docker.ExecCommend(ctx, cli, c.ID, args) - if err != nil { - return err - } - if err := docker.InspectExecResp(ctx, cli, exec.ID); err != nil { - return err - } - } - return nil -} diff --git a/cmd/sandbox/exec_test.go b/cmd/sandbox/exec_test.go deleted file mode 100644 index b86a9a78..00000000 --- a/cmd/sandbox/exec_test.go +++ /dev/null @@ -1,76 +0,0 @@ -package sandbox - -import ( - "bufio" - "context" - "fmt" - "io" - "strings" - "testing" - - "github.com/flyteorg/flytectl/cmd/testutils" - - admin2 "github.com/flyteorg/flyte/flyteidl/clients/go/admin" - - cmdCore "github.com/flyteorg/flytectl/cmd/core" - "github.com/stretchr/testify/assert" - - "github.com/docker/docker/api/types" - "github.com/flyteorg/flytectl/pkg/docker" - "github.com/flyteorg/flytectl/pkg/docker/mocks" - "github.com/stretchr/testify/mock" -) - -func TestSandboxClusterExec(t *testing.T) { - mockDocker := &mocks.Docker{} - mockOutStream := new(io.Writer) - ctx := context.Background() - mockClient := admin2.InitializeMockClientset() - cmdCtx := cmdCore.NewCommandContext(mockClient, *mockOutStream) - reader := bufio.NewReader(strings.NewReader("test")) - - mockDocker.OnContainerList(ctx, types.ContainerListOptions{All: true}).Return([]types.Container{ - { - ID: docker.FlyteSandboxClusterName, - Names: []string{ - docker.FlyteSandboxClusterName, - }, - }, - }, nil) - docker.ExecConfig.Cmd = []string{"ls -al"} - mockDocker.OnContainerExecCreateMatch(ctx, mock.Anything, docker.ExecConfig).Return(types.IDResponse{}, nil) - mockDocker.OnContainerExecInspectMatch(ctx, mock.Anything).Return(types.ContainerExecInspect{}, nil) - mockDocker.OnContainerExecAttachMatch(ctx, mock.Anything, types.ExecStartCheck{}).Return(types.HijackedResponse{ - Reader: reader, - }, fmt.Errorf("Test")) - docker.Client = mockDocker - err := sandboxClusterExec(ctx, []string{"ls -al"}, cmdCtx) - - assert.NotNil(t, err) -} - -func TestSandboxClusterExecWithoutCmd(t *testing.T) { - mockDocker := &mocks.Docker{} - reader := bufio.NewReader(strings.NewReader("test")) - s := testutils.Setup() - ctx := s.Ctx - - mockDocker.OnContainerList(ctx, types.ContainerListOptions{All: true}).Return([]types.Container{ - { - ID: docker.FlyteSandboxClusterName, - Names: []string{ - docker.FlyteSandboxClusterName, - }, - }, - }, nil) - docker.ExecConfig.Cmd = []string{} - mockDocker.OnContainerExecCreateMatch(ctx, mock.Anything, docker.ExecConfig).Return(types.IDResponse{}, nil) - mockDocker.OnContainerExecInspectMatch(ctx, mock.Anything).Return(types.ContainerExecInspect{}, nil) - mockDocker.OnContainerExecAttachMatch(ctx, mock.Anything, types.ExecStartCheck{}).Return(types.HijackedResponse{ - Reader: reader, - }, fmt.Errorf("Test")) - docker.Client = mockDocker - err := sandboxClusterExec(ctx, []string{}, s.CmdCtx) - - assert.NotNil(t, err) -} diff --git a/cmd/sandbox/sandbox.go b/cmd/sandbox/sandbox.go deleted file mode 100644 index 0e20df43..00000000 --- a/cmd/sandbox/sandbox.go +++ /dev/null @@ -1,70 +0,0 @@ -package sandbox - -import ( - sandboxCmdConfig "github.com/flyteorg/flytectl/cmd/config/subcommand/sandbox" - cmdcore "github.com/flyteorg/flytectl/cmd/core" - "github.com/spf13/cobra" -) - -// Long descriptions are whitespace sensitive when generating docs using sphinx. -const ( - sandboxShort = `Helps with sandbox interactions like start, teardown, status, and exec.` - sandboxLong = ` -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 - -` -) - -// CreateSandboxCommand will return sandbox command -func CreateSandboxCommand() *cobra.Command { - sandbox := &cobra.Command{ - Use: "sandbox", - Short: sandboxShort, - Long: sandboxLong, - } - - sandboxResourcesFuncs := map[string]cmdcore.CommandEntry{ - "start": {CmdFunc: startSandboxCluster, Aliases: []string{}, ProjectDomainNotRequired: true, - Short: startShort, - Long: startLong, PFlagProvider: sandboxCmdConfig.DefaultConfig, DisableFlyteClient: true}, - "teardown": {CmdFunc: teardownSandboxCluster, Aliases: []string{}, ProjectDomainNotRequired: true, - Short: teardownShort, - Long: teardownLong, DisableFlyteClient: true}, - "status": {CmdFunc: sandboxClusterStatus, Aliases: []string{}, ProjectDomainNotRequired: true, - Short: statusShort, - Long: statusLong}, - "exec": {CmdFunc: sandboxClusterExec, Aliases: []string{}, ProjectDomainNotRequired: true, - Short: execShort, - Long: execLong, DisableFlyteClient: true}, - } - - cmdcore.AddCommands(sandbox, sandboxResourcesFuncs) - - return sandbox -} diff --git a/cmd/sandbox/sandbox_test.go b/cmd/sandbox/sandbox_test.go deleted file mode 100644 index 0692a089..00000000 --- a/cmd/sandbox/sandbox_test.go +++ /dev/null @@ -1,39 +0,0 @@ -package sandbox - -import ( - "fmt" - "sort" - "testing" - - "gotest.tools/assert" -) - -func TestCreateSandboxCommand(t *testing.T) { - sandboxCommand := CreateSandboxCommand() - assert.Equal(t, sandboxCommand.Use, "sandbox") - assert.Equal(t, sandboxCommand.Short, "Helps with sandbox interactions like start, teardown, status, and exec.") - fmt.Println(sandboxCommand.Commands()) - assert.Equal(t, len(sandboxCommand.Commands()), 4) - cmdNouns := sandboxCommand.Commands() - // Sort by Use value. - sort.Slice(cmdNouns, func(i, j int) bool { - return cmdNouns[i].Use < cmdNouns[j].Use - }) - - assert.Equal(t, cmdNouns[0].Use, "exec") - assert.Equal(t, cmdNouns[0].Short, execShort) - assert.Equal(t, cmdNouns[0].Long, execLong) - - assert.Equal(t, cmdNouns[1].Use, "start") - assert.Equal(t, cmdNouns[1].Short, startShort) - assert.Equal(t, cmdNouns[1].Long, startLong) - - assert.Equal(t, cmdNouns[2].Use, "status") - assert.Equal(t, cmdNouns[2].Short, statusShort) - assert.Equal(t, cmdNouns[2].Long, statusLong) - - assert.Equal(t, cmdNouns[3].Use, "teardown") - assert.Equal(t, cmdNouns[3].Short, teardownShort) - assert.Equal(t, cmdNouns[3].Long, teardownLong) - -} diff --git a/cmd/sandbox/start.go b/cmd/sandbox/start.go deleted file mode 100644 index 1996a7f1..00000000 --- a/cmd/sandbox/start.go +++ /dev/null @@ -1,84 +0,0 @@ -package sandbox - -import ( - "context" - - sandboxCmdConfig "github.com/flyteorg/flytectl/cmd/config/subcommand/sandbox" - cmdCore "github.com/flyteorg/flytectl/cmd/core" - "github.com/flyteorg/flytectl/pkg/sandbox" -) - -const ( - startShort = "Starts the Flyte sandbox cluster." - startLong = ` -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 -` -) - -func startSandboxCluster(ctx context.Context, args []string, cmdCtx cmdCore.CommandContext) error { - sandboxDefaultConfig := sandboxCmdConfig.DefaultConfig - return sandbox.StartSandboxCluster(ctx, args, sandboxDefaultConfig) -} diff --git a/cmd/sandbox/start_test.go b/cmd/sandbox/start_test.go deleted file mode 100644 index 3bee1abd..00000000 --- a/cmd/sandbox/start_test.go +++ /dev/null @@ -1 +0,0 @@ -package sandbox diff --git a/cmd/sandbox/status.go b/cmd/sandbox/status.go deleted file mode 100644 index 69476a43..00000000 --- a/cmd/sandbox/status.go +++ /dev/null @@ -1,32 +0,0 @@ -package sandbox - -import ( - "context" - - "github.com/flyteorg/flytectl/pkg/sandbox" - - cmdCore "github.com/flyteorg/flytectl/cmd/core" - "github.com/flyteorg/flytectl/pkg/docker" -) - -const ( - statusShort = "Gets the status of the sandbox environment." - statusLong = ` -Retrieves the status of the sandbox environment. Currently, Flyte sandbox runs as a local Docker container. - -Usage -:: - - flytectl sandbox status - -` -) - -func sandboxClusterStatus(ctx context.Context, args []string, cmdCtx cmdCore.CommandContext) error { - cli, err := docker.GetDockerClient() - if err != nil { - return err - } - - return sandbox.PrintStatus(ctx, cli) -} diff --git a/cmd/sandbox/status_test.go b/cmd/sandbox/status_test.go deleted file mode 100644 index e38cfb02..00000000 --- a/cmd/sandbox/status_test.go +++ /dev/null @@ -1,39 +0,0 @@ -package sandbox - -import ( - "testing" - - "github.com/flyteorg/flytectl/cmd/testutils" - - "github.com/docker/docker/api/types" - "github.com/flyteorg/flytectl/pkg/docker" - "github.com/flyteorg/flytectl/pkg/docker/mocks" - "github.com/stretchr/testify/assert" -) - -func TestSandboxStatus(t *testing.T) { - t.Run("Sandbox status with zero result", func(t *testing.T) { - mockDocker := &mocks.Docker{} - s := testutils.Setup() - mockDocker.OnContainerList(s.Ctx, types.ContainerListOptions{All: true}).Return([]types.Container{}, nil) - docker.Client = mockDocker - err := sandboxClusterStatus(s.Ctx, []string{}, s.CmdCtx) - assert.Nil(t, err) - }) - t.Run("Sandbox status with running sandbox", func(t *testing.T) { - s := testutils.Setup() - ctx := s.Ctx - mockDocker := &mocks.Docker{} - mockDocker.OnContainerList(ctx, types.ContainerListOptions{All: true}).Return([]types.Container{ - { - ID: docker.FlyteSandboxClusterName, - Names: []string{ - docker.FlyteSandboxClusterName, - }, - }, - }, nil) - docker.Client = mockDocker - err := sandboxClusterStatus(ctx, []string{}, s.CmdCtx) - assert.Nil(t, err) - }) -} diff --git a/cmd/sandbox/teardown.go b/cmd/sandbox/teardown.go deleted file mode 100644 index 4b2fcd04..00000000 --- a/cmd/sandbox/teardown.go +++ /dev/null @@ -1,32 +0,0 @@ -package sandbox - -import ( - "context" - - "github.com/flyteorg/flytectl/pkg/docker" - "github.com/flyteorg/flytectl/pkg/sandbox" - - sandboxCmdConfig "github.com/flyteorg/flytectl/cmd/config/subcommand/sandbox" - cmdCore "github.com/flyteorg/flytectl/cmd/core" -) - -const ( - teardownShort = "Cleans up the sandbox environment" - teardownLong = ` -Removes the Sandbox cluster and all the Flyte config created by 'sandbox start': -:: - - flytectl sandbox teardown - - -Usage -` -) - -func teardownSandboxCluster(ctx context.Context, args []string, cmdCtx cmdCore.CommandContext) error { - cli, err := docker.GetDockerClient() - if err != nil { - return err - } - return sandbox.Teardown(ctx, cli, sandboxCmdConfig.DefaultTeardownFlags) -} diff --git a/cmd/sandbox/teardown_test.go b/cmd/sandbox/teardown_test.go deleted file mode 100644 index 63509c22..00000000 --- a/cmd/sandbox/teardown_test.go +++ /dev/null @@ -1,34 +0,0 @@ -package sandbox - -import ( - "testing" - - "github.com/docker/docker/api/types" - "github.com/flyteorg/flytectl/cmd/testutils" - "github.com/flyteorg/flytectl/pkg/configutil" - "github.com/flyteorg/flytectl/pkg/docker" - "github.com/flyteorg/flytectl/pkg/docker/mocks" - "github.com/flyteorg/flytectl/pkg/k8s" - k8sMocks "github.com/flyteorg/flytectl/pkg/k8s/mocks" - "github.com/flyteorg/flytectl/pkg/util" - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/mock" -) - -func TestTearDownClusterFunc(t *testing.T) { - var containers []types.Container - _ = util.SetupFlyteDir() - _ = util.WriteIntoFile([]byte("data"), configutil.FlytectlConfig) - s := testutils.Setup() - ctx := s.Ctx - mockDocker := &mocks.Docker{} - mockDocker.OnContainerList(ctx, types.ContainerListOptions{All: true}).Return(containers, nil) - mockDocker.OnContainerRemove(ctx, mock.Anything, types.ContainerRemoveOptions{Force: true}).Return(nil) - mockK8sContextMgr := &k8sMocks.ContextOps{} - mockK8sContextMgr.OnRemoveContext(mock.Anything).Return(nil) - k8s.ContextMgr = mockK8sContextMgr - - docker.Client = mockDocker - err := teardownSandboxCluster(ctx, []string{}, s.CmdCtx) - assert.Nil(t, err) -} From fce0445eda914b2d1b265988ccf37927fe1c80fa Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Wed, 14 Feb 2024 11:56:27 -0800 Subject: [PATCH 2/5] 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= From 06c21195176d60e3a3bc105b26a93d434da26a18 Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Wed, 14 Feb 2024 12:30:34 -0800 Subject: [PATCH 3/5] Remove sandbox from docs Signed-off-by: Kevin Su --- README.md | 2 +- docs/source/sandbox.rst | 12 ------------ 2 files changed, 1 insertion(+), 13 deletions(-) delete mode 100644 docs/source/sandbox.rst diff --git a/README.md b/README.md index b7676ec8..ca3248b1 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Flytectl was designed as a portable and lightweight command-line interface to wo 3. Start Sandbox using Flytectl. ```bash - $ flytectl sandbox start + $ flytectl demo start ``` 4. Register examples. diff --git a/docs/source/sandbox.rst b/docs/source/sandbox.rst deleted file mode 100644 index f7d7bbc4..00000000 --- a/docs/source/sandbox.rst +++ /dev/null @@ -1,12 +0,0 @@ -Sandbox -------- -It specifies the actions to be performed on the 'sandbox' resource. - -.. toctree:: - :maxdepth: 1 - :caption: Sandbox - - gen/flytectl_sandbox_start - gen/flytectl_sandbox_status - gen/flytectl_sandbox_teardown - gen/flytectl_sandbox_exec From 1f2bdf2db14a02f1ad1a3478f4df02aa8ddb40e6 Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Wed, 14 Feb 2024 12:42:04 -0800 Subject: [PATCH 4/5] fix tests Signed-off-by: Kevin Su --- .github/workflows/checks.yml | 2 +- docs/source/nouns.rst | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 211a7aab..81d14caf 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -91,7 +91,7 @@ jobs: - name: Register cookbook run: bin/flytectl register examples -d development -p flytesnacks - name: Teardown Sandbox cluster - run: bin/flytectl sandbox teardown + run: bin/flytectl demo teardown bump_version: name: Bump Version diff --git a/docs/source/nouns.rst b/docs/source/nouns.rst index 150d3cab..0304a1f0 100644 --- a/docs/source/nouns.rst +++ b/docs/source/nouns.rst @@ -22,5 +22,4 @@ Flytectl nouns specify the resource on which the action needs to be performed. E examples files config - sandbox demo From 659723fa167a238efd597860176f2a5e2d9e9ead Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Wed, 14 Feb 2024 12:58:06 -0800 Subject: [PATCH 5/5] remove sandbox from verb Signed-off-by: Kevin Su --- docs/source/verbs.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/verbs.rst b/docs/source/verbs.rst index 403a96ec..6db897ed 100644 --- a/docs/source/verbs.rst +++ b/docs/source/verbs.rst @@ -15,7 +15,6 @@ Flytectl verbs specify the actions to be performed on the resources. Example: cr gen/flytectl_register gen/flytectl_config gen/flytectl_compile - gen/flytectl_sandbox gen/flytectl_demo gen/flytectl_version gen/flytectl_upgrade