Added enableSchedule option on registration and linked missing docs (f…

…lyteorg#324) * Added enableSchedule option on registration Signed-off-by: Prafulla Mahindrakar <[email protected]> * Added docs and linked missing docs Signed-off-by: Prafulla Mahindrakar <[email protected]>
austin362667 · May 7, 2024 · cd55089 · cd55089
1 parent 8eed043
commit cd55089
Show file tree

Hide file tree

Showing 69 changed files with 125 additions and 6 deletions.
diff --git a/flytectl/cmd/completion.go b/flytectl/cmd/completion.go
@@ -35,11 +35,13 @@ var completionCmd = &cobra.Command{
 	To load completions for each session:
 
 	- Linux
+
 	::
 
 	$ flytectl completion bash > /etc/bash_completion.d/flytectl
 
 	- macOS
+
 	::
 
 	$ flytectl completion bash > /usr/local/etc/bash_completion.d/flytectl
@@ -61,6 +63,7 @@ var completionCmd = &cobra.Command{
 		Start a new shell for this setup to take effect.
 
 - fish
+
 	::
 
 	$ flytectl completion fish | source
@@ -72,6 +75,7 @@ var completionCmd = &cobra.Command{
 	$ flytectl completion fish > ~/.config/fish/completions/flytectl.fish
 
 - PowerShell
+
 	::
 
 	 PS> flytectl completion powershell | Out-String | Invoke-Expression

diff --git a/flytectl/cmd/config/subcommand/register/files_config.go b/flytectl/cmd/config/subcommand/register/files_config.go
@@ -26,6 +26,7 @@ type FilesConfig struct {
 	DeprecatedSourceUploadPath string `json:"sourceUploadPath" pflag:",Deprecated: Update flyte admin to avoid having to configure storage access from flytectl."`
 	DestinationDirectory       string `json:"destinationDirectory" pflag:",Location of source code in container."`
 	DryRun                     bool   `json:"dryRun" pflag:",Execute command without making any modifications."`
+	EnableSchedule             bool   `json:"enableSchedule" pflag:",Enable the schedule if the files contain schedulable launchplan."`
 }
 
 func GetConfig() *FilesConfig {

diff --git a/flytectl/cmd/config/subcommand/register/filesconfig_flags.go b/flytectl/cmd/config/subcommand/register/filesconfig_flags.go
diff --git a/flytectl/cmd/config/subcommand/register/filesconfig_flags_test.go b/flytectl/cmd/config/subcommand/register/filesconfig_flags_test.go
diff --git a/flytectl/cmd/get/execution.go b/flytectl/cmd/get/execution.go
@@ -93,6 +93,7 @@ var hundredChars = 100
 var executionColumns = []printer.Column{
 	{Header: "Name", JSONPath: "$.id.name"},
 	{Header: "Launch Plan Name", JSONPath: "$.spec.launchPlan.name"},
+	{Header: "Version", JSONPath: "$.spec.launchPlan.version"},
 	{Header: "Type", JSONPath: "$.spec.launchPlan.resourceType"},
 	{Header: "Phase", JSONPath: "$.closure.phase"},
 	{Header: "Scheduled Time", JSONPath: "$.spec.metadata.scheduledAt"},

diff --git a/flytectl/cmd/register/files.go b/flytectl/cmd/register/files.go
@@ -102,6 +102,12 @@ Override Destination dir of source code in container during registration:
 ::
 
  flytectl register file  _pb_output/* -d development  -p flytesnacks --continueOnError --version v2 --destinationDirectory "/root" 
+
+Enable schedule for the launchplans part of the serialized protobuf files:
+
+::
+
+ flytectl register file  _pb_output/* -d development  -p flytesnacks --version v2 --enableSchedule
 	
 Usage
 `

diff --git a/flytectl/cmd/register/files_test.go b/flytectl/cmd/register/files_test.go
@@ -31,6 +31,7 @@ func TestRegisterFromFiles(t *testing.T) {
 		s.MockAdminClient.OnCreateTaskMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateWorkflowMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
+		s.MockAdminClient.OnUpdateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		err := registerFromFilesFunc(s.Ctx, args, s.CmdCtx)
 		assert.Nil(t, err)
 	})
@@ -52,7 +53,7 @@ func TestRegisterFromFiles(t *testing.T) {
 		s.MockAdminClient.OnCreateTaskMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateWorkflowMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
-
+		s.MockAdminClient.OnUpdateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		mockDataProxy := s.MockClient.DataProxyClient().(*mocks.DataProxyServiceClient)
 		mockDataProxy.OnCreateUploadLocationMatch(s.Ctx, mock.Anything).Return(&service.CreateUploadLocationResponse{}, nil)
 
@@ -75,6 +76,7 @@ func TestRegisterFromFiles(t *testing.T) {
 		s.MockAdminClient.OnCreateTaskMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateWorkflowMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
+		s.MockAdminClient.OnUpdateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockClient.DataProxyClient().(*mocks.DataProxyServiceClient).OnCreateUploadLocationMatch(mock.Anything, mock.Anything).Return(&service.CreateUploadLocationResponse{}, nil)
 		err = Register(s.Ctx, args, config.GetConfig(), s.CmdCtx)
 		assert.Nil(t, err)
@@ -95,6 +97,7 @@ func TestRegisterFromFiles(t *testing.T) {
 		s.MockAdminClient.OnCreateTaskMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateWorkflowMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
+		s.MockAdminClient.OnUpdateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		err = registerFromFilesFunc(s.Ctx, args, s.CmdCtx)
 		assert.NotNil(t, err)
 	})
@@ -163,6 +166,7 @@ func TestRegisterFromFiles(t *testing.T) {
 		s.MockAdminClient.OnCreateTaskMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateWorkflowMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockAdminClient.OnCreateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
+		s.MockAdminClient.OnUpdateLaunchPlanMatch(mock.Anything, mock.Anything).Return(nil, nil)
 		s.MockClient.DataProxyClient().(*mocks.DataProxyServiceClient).OnCreateUploadLocationMatch(mock.Anything, mock.Anything).Return(&service.CreateUploadLocationResponse{}, nil)
 		err = registerFromFilesFunc(s.Ctx, args, s.CmdCtx)
 		assert.Nil(t, err)

diff --git a/flytectl/cmd/register/register_util.go b/flytectl/cmd/register/register_util.go
@@ -125,7 +125,7 @@ func unMarshalContents(ctx context.Context, fileContents []byte, fname string) (
 
 }
 
-func register(ctx context.Context, message proto.Message, cmdCtx cmdCore.CommandContext, dryRun bool) error {
+func register(ctx context.Context, message proto.Message, cmdCtx cmdCore.CommandContext, dryRun, enableSchedule bool) error {
 	switch v := message.(type) {
 	case *admin.LaunchPlan:
 		launchPlan := message.(*admin.LaunchPlan)
@@ -144,7 +144,23 @@ func register(ctx context.Context, message proto.Message, cmdCtx cmdCore.Command
 				},
 				Spec: launchPlan.Spec,
 			})
-		return err
+		if err != nil {
+			return err
+		}
+		// Activate the launchplan
+		if enableSchedule {
+			_, err = cmdCtx.AdminClient().UpdateLaunchPlan(ctx, &admin.LaunchPlanUpdateRequest{
+				Id: &core.Identifier{
+					Project: config.GetConfig().Project,
+					Domain:  config.GetConfig().Domain,
+					Name:    launchPlan.Id.Name,
+					Version: launchPlan.Id.Version,
+				},
+				State: admin.LaunchPlanState_ACTIVE,
+			})
+			return err
+		}
+		return nil
 	case *admin.WorkflowSpec:
 		workflowSpec := message.(*admin.WorkflowSpec)
 		if dryRun {
@@ -581,7 +597,7 @@ func registerFile(ctx context.Context, fileName string, registerResults []Result
 		registerResults = append(registerResults, registerResult)
 		return registerResults, err
 	}
-	if err := register(ctx, spec, cmdCtx, config.DryRun); err != nil {
+	if err := register(ctx, spec, cmdCtx, config.DryRun, config.EnableSchedule); err != nil {
 		// If error is AlreadyExists then dont consider this to be an error but just a warning state
 		if grpcError := status.Code(err); grpcError == codes.AlreadyExists {
 			registerResult = Result{Name: fileName, Status: "Success", Info: fmt.Sprintf("%v", grpcError.String())}

diff --git a/flytectl/cmd/register/register_util_test.go b/flytectl/cmd/register/register_util_test.go
@@ -62,6 +62,7 @@ func registerFilesSetup() {
 	rconfig.DefaultFilesConfig.AssumableIamRole = ""
 	rconfig.DefaultFilesConfig.K8sServiceAccount = ""
 	rconfig.DefaultFilesConfig.OutputLocationPrefix = ""
+	rconfig.DefaultFilesConfig.EnableSchedule = true
 }
 
 func TestGetSortedArchivedFileWithParentFolderList(t *testing.T) {
@@ -476,7 +477,7 @@ func TestRegister(t *testing.T) {
 		s := setup()
 		registerFilesSetup()
 		node := &admin.NodeExecution{}
-		err := register(s.Ctx, node, s.CmdCtx, rconfig.DefaultFilesConfig.DryRun)
+		err := register(s.Ctx, node, s.CmdCtx, rconfig.DefaultFilesConfig.DryRun, rconfig.DefaultFilesConfig.EnableSchedule)
 		assert.NotNil(t, err)
 	})
 }

diff --git a/flytectl/docs/source/config.rst b/flytectl/docs/source/config.rst
diff --git a/flytectl/docs/source/execution.rst b/flytectl/docs/source/execution.rst
diff --git a/flytectl/docs/source/gen/flytectl.rst b/flytectl/docs/source/gen/flytectl.rst
diff --git a/flytectl/docs/source/gen/flytectl_completion.rst b/flytectl/docs/source/gen/flytectl_completion.rst
diff --git a/flytectl/docs/source/gen/flytectl_config.rst b/flytectl/docs/source/gen/flytectl_config.rst
diff --git a/flytectl/docs/source/gen/flytectl_config_discover.rst b/flytectl/docs/source/gen/flytectl_config_discover.rst
diff --git a/flytectl/docs/source/gen/flytectl_config_docs.rst b/flytectl/docs/source/gen/flytectl_config_docs.rst
diff --git a/flytectl/docs/source/gen/flytectl_config_init.rst b/flytectl/docs/source/gen/flytectl_config_init.rst
diff --git a/flytectl/docs/source/gen/flytectl_config_validate.rst b/flytectl/docs/source/gen/flytectl_config_validate.rst
diff --git a/flytectl/docs/source/gen/flytectl_create.rst b/flytectl/docs/source/gen/flytectl_create.rst
diff --git a/flytectl/docs/source/gen/flytectl_create_execution.rst b/flytectl/docs/source/gen/flytectl_create_execution.rst
diff --git a/flytectl/docs/source/gen/flytectl_create_project.rst b/flytectl/docs/source/gen/flytectl_create_project.rst
diff --git a/flytectl/docs/source/gen/flytectl_delete.rst b/flytectl/docs/source/gen/flytectl_delete.rst
diff --git a/flytectl/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst b/flytectl/docs/source/gen/flytectl_delete_cluster-resource-attribute.rst
-Original file line number
+Diff line change
@@ Expand Up @@
     ::
      flytectl register file  _pb_output/* -d development  -p flytesnacks --continueOnError --version v2 --destinationDirectory "/root"
+    Enable schedule for the launchplans part of the serialized protobuf files:
+    ::
+     flytectl register file  _pb_output/* -d development  -p flytesnacks --version v2 --enableSchedule
     Usage
     `
@@ Expand Down @@