Added docs for demo and updated docs for workflow execution config wi…

…th more details (flyteorg#316)
robert-ulbrich-mercedes-benz · Jul 2, 2024 · 8f6543e · 8f6543e
1 parent cee5a53
commit 8f6543e
Show file tree

Hide file tree

Showing 12 changed files with 155 additions and 11 deletions.
diff --git a/flytectl/cmd/delete/matchable_workflow_execution_config.go b/flytectl/cmd/delete/matchable_workflow_execution_config.go
@@ -34,6 +34,9 @@ For example, here's the config file wec.yaml:
     domain: development
     project: flytectldemo
     max_parallelism: 5
+	security_context:
+  		run_as:
+    		k8s_service_account: demo
 
 Max_parallelism is optional in the file as it is unread during the delete command but can be retained since the same file can be used for get, update and delete commands.
 

diff --git a/flytectl/cmd/get/matchable_workflow_execution_config.go b/flytectl/cmd/get/matchable_workflow_execution_config.go
@@ -69,6 +69,56 @@ Example: content of wec.yaml:
     project: flytectldemo
     max_parallelism: 5
 
+Generate a sample workflow execution config file to be used for creating a new workflow execution config at project domain
+
+::
+	flytectl get workflow-execution-config -p flytesnacks -d development --attrFile wec.yaml --gen
+
+
+.. code-block:: yaml
+
+	annotations:
+	  values:
+		cliAnnotationKey: cliAnnotationValue
+	domain: development
+	labels:
+	  values:
+		cliLabelKey: cliLabelValue
+	max_parallelism: 10
+	project: flytesnacks
+	raw_output_data_config:
+	  output_location_prefix: cliOutputLocationPrefix
+	security_context:
+	  run_as:
+		k8s_service_account: default
+
+
+
+Generate a sample workflow execution config file to be used for creating a new workflow execution config at project domain workflow level
+
+::
+	flytectl get workflow-execution-config -p flytesnacks -d development --attrFile wec.yaml flytectl get workflow-execution-config --gen
+
+
+.. code-block:: yaml
+
+	annotations:
+	  values:
+		cliAnnotationKey: cliAnnotationValue
+	domain: development
+	labels:
+	  values:
+		cliLabelKey: cliLabelValue
+	max_parallelism: 10
+	project: flytesnacks
+	workflow: k8s_spark.dataframe_passing.my_smart_structured_dataset
+	raw_output_data_config:
+	  output_location_prefix: cliOutputLocationPrefix
+	security_context:
+	  run_as:
+		k8s_service_account: default
+
+
 Usage
 `
 )

diff --git a/flytectl/cmd/update/matchable_workflow_execution_config.go b/flytectl/cmd/update/matchable_workflow_execution_config.go
@@ -27,6 +27,9 @@ Example: content of wec.yaml:
     domain: development
     project: flytectldemo
     max_parallelism: 5
+	security_context:
+	  run_as:
+		k8s_service_account: demo
 
 ::
 
@@ -42,6 +45,9 @@ For workflow 'core.control_flow.run_merge_sort.merge_sort' in flytectldemo proje
     project: flytectldemo
     workflow: core.control_flow.run_merge_sort.merge_sort
     max_parallelism: 5
+	security_context:
+	  run_as:
+		k8s_service_account: mergesortsa
 
 ::
 

diff --git a/flytectl/docs/source/demo.rst b/flytectl/docs/source/demo.rst
diff --git a/flytectl/docs/source/gen/flytectl_delete_workflow-execution-config.rst b/flytectl/docs/source/gen/flytectl_delete_workflow-execution-config.rst
diff --git a/flytectl/docs/source/gen/flytectl_demo_start.rst b/flytectl/docs/source/gen/flytectl_demo_start.rst
diff --git a/flytectl/docs/source/gen/flytectl_get_workflow-execution-config.rst b/flytectl/docs/source/gen/flytectl_get_workflow-execution-config.rst
diff --git a/flytectl/docs/source/gen/flytectl_get_workflow.rst b/flytectl/docs/source/gen/flytectl_get_workflow.rst
diff --git a/flytectl/docs/source/gen/flytectl_sandbox_start.rst b/flytectl/docs/source/gen/flytectl_sandbox_start.rst
diff --git a/flytectl/docs/source/gen/flytectl_update_workflow-execution-config.rst b/flytectl/docs/source/gen/flytectl_update_workflow-execution-config.rst
diff --git a/flytectl/docs/source/nouns.rst b/flytectl/docs/source/nouns.rst
diff --git a/flytectl/docs/source/verbs.rst b/flytectl/docs/source/verbs.rst