Add virtctl to tekton task #244

opokornyy · 2023-04-25T12:22:29Z

What this PR does / why we need it:

This PR adds functionality to create-vm-from-manifest task to allow user to create vm with virtctl command.

Release note:

0xFelix

Good start! I added some comments and one further question: Can the task return the name of the VM? This leaves it open to create a VM with a random name.

0xFelix · 2023-04-26T07:30:06Z

modules/create-vm/cmd/create-vm/main.go

@@ -51,8 +50,8 @@ func main() {
 	if err := vmCreator.OwnVolumes(vm); err != nil {
 		exit.ExitFromError(OwnVolumesErrorExitCode, err)
 	}
-	runStrategy := cliOptions.GetRunStrategy()


Why drop this check?

We can specify the RunStrategy either through virtctl parameters or directly in a manifest. The runStrategy checked in this condition is specified separately in the task spec. If we don't use the RunStrategy parameter of a task the string will be empty and it will depend only on StartVM flag. Also StartVM should not perform any action if runStrategy of a created VM is already set to Always. - https://kubevirt.io/user-guide/virtual_machines/run_strategies/#virtctl

So this always tries to start the VM and mightt return an error from the API?

It only tries to start the VM when StartVM param is specified. It should not return error, when the VM is already running nothing happens.

0xFelix · 2023-04-26T07:30:58Z

modules/create-vm/go.mod

 	go.uber.org/zap v1.19.1
 	k8s.io/api v0.25.2
 	k8s.io/apimachinery v0.25.2
 	k8s.io/client-go v12.0.0+incompatible
-	kubevirt.io/api v0.59.0
-	kubevirt.io/client-go v0.59.0
+	kubevirt.io/api v0.60.0-alpha.0


Can we stay on stable?

Ondrej selected this tag, because there was something missing in 0.59. @opokornyy can you please confirm? This tag will be changed when v0.60 is officially released

Yes, the stable tag does not contain all of the virtctl functionality that is needed.

For the latest fixes you potentially want to pin the version to a specific commit. E.g. to include kubevirt/kubevirt#9651

You might want to update this to v1.0.0-alpha.0 to have kubevirt/kubevirt#9651 included.

0xFelix · 2023-04-26T07:31:56Z

modules/create-vm/pkg/utils/parse/clioptions.go

@@ -35,6 +36,7 @@ type CLIOptions struct {
 	RunStrategy               string            `arg:"--run-strategy,env:RUN_STRATEGY" help:"Set run strategy to vm"`
 	Output                    output.OutputType `arg:"-o" placeholder:"FORMAT" help:"Output format. One of: yaml|json"`
 	Debug                     bool              `arg:"--debug" help:"Sets DEBUG log level"`
+	Virtctl                   string            `arg:"--virtctl,env:VIRTCTL" placeholder:"VIRTCTL" help:"Specifies a virtctl create vm params to be used to create VirtualMachine."`


s/params/command/?

In this task param should be specified only the parameters, that will be used with the virtctl command like this for example --name vm-test --run-strategy Always. So maybe it is beter to use params instead of a command?

If you could improve the help text that's fine.

0xFelix · 2023-04-26T07:32:41Z

modules/create-vm/pkg/utils/parse/clioptions_test.go

-		Entry("no mode", "one of vm-manifest, template-name should be specified", &parse.CLIOptions{}),
-		Entry("both modes", "only one of vm-manifest, template-name should be specified", &parse.CLIOptions{
+		Entry("no mode", "only one of vm-manifest, template-name or virtctl should be specified", &parse.CLIOptions{}),
+		Entry("both modes", "only one of vm-manifest, template-name or virtctl should be specified", &parse.CLIOptions{


s/both/multiple/?

0xFelix · 2023-04-26T07:36:42Z

modules/create-vm/pkg/vm/vm-provider.go

@@ -21,9 +23,9 @@ func NewVirtualMachineProvider(client kubevirtcliv1.KubevirtClient) VirtualMachi
 }

 func (v *virtualMachineProvider) Create(namespace string, vm *kubevirtv1.VirtualMachine) (*kubevirtv1.VirtualMachine, error) {
-	return v.client.VirtualMachine(namespace).Create(vm)
+	return v.client.VirtualMachine(namespace).Create(context.TODO(), vm)


Are we ever going to change the context? Might use context.Background()?

0xFelix · 2023-04-26T07:38:30Z

modules/create-vm/pkg/vmcreator/vm-creator.go

+	namespace := v.targetNamespace
+	if namespace == "" {
+		if namespace, err = env.GetActiveNamespace(); err != nil {
+			return nil, zerrors.NewMissingRequiredError("can't get active namespace: %v", err.Error())


0xFelix · 2023-04-26T07:40:44Z

modules/create-vm/pkg/vmcreator/vm-creator.go

+	var vm kubevirtv1.VirtualMachine
+	output := &bytes.Buffer{}
+
+	cmd := createCommand(v.cliOptions.Virtctl, output)


Create command like it is done here? https://github.com/kubevirt/kubevirt/blob/3c25c8606e8aac1fcb31a73a3f444ebfffb27d20/tests/clientcmd/virtctl.go#L53

0xFelix · 2023-04-26T07:44:27Z

modules/tests/test/create_vm_from_manifest_test.go

+					ExpectedLogs:   ExpectedSuccessfulVMCreation,
+				},
+				TaskData: testconfigs.CreateVMTaskData{
+					Virtctl: fmt.Sprintf("--name %s --run-strategy=Halted", vmName),


Use same way to specify flags? Either with = or space.

0xFelix · 2023-04-26T07:44:35Z

modules/tests/test/create_vm_from_manifest_test.go

+					ExpectedLogs:   ExpectedSuccessfulVMCreation,
+				},
+				TaskData: testconfigs.CreateVMTaskData{
+					Virtctl: fmt.Sprintf("--name %s --run-strategy=Halted --instancetype %s", vmName, instancetypeName),


Same as above.

0xFelix · 2023-04-26T07:45:57Z

modules/tests/test/create_vm_from_manifest_test.go

+				ExpectLogs(config.GetAllExpectedLogs()...)
+		})
+
+		DescribeTable("should fail creating VM", func(config *testconfigs.CreateVMTestConfig) {


Isn't this more of a general test case that affects every creation mode? I would have placed it on a higher level.

ksimon1 · 2023-04-26T07:57:12Z

Please improve commit messages and PR description.
Please use https://www.conventionalcommits.org/en/v1.0.0/

opokornyy · 2023-04-26T09:44:37Z

Good start! I added some comments and one further question: Can the task return the name of the VM? This leaves it open to create a VM with a random name.

The task is just creating a VM and it does not return its name. It depends on a user if he specifies a name of a VM, if he does not for virtctl command, then the created VM will have a random name.

0xFelix · 2023-04-27T07:52:33Z

modules/create-vm/cmd/create-vm/main.go

@@ -51,8 +50,8 @@ func main() {
 	if err := vmCreator.OwnVolumes(vm); err != nil {
 		exit.ExitFromError(OwnVolumesErrorExitCode, err)
 	}
-	runStrategy := cliOptions.GetRunStrategy()


So this always tries to start the VM and mightt return an error from the API?

0xFelix · 2023-04-27T07:57:06Z

modules/tests/test/create_vm_from_manifest_test.go

+			deleteInstancetype(f, instancetypeName)
+		})
+
+		DescribeTable("should fail creating VM", func(config *testconfigs.CreateVMTestConfig) {


Merge this into taskrun fails and no VM is created?

0xFelix · 2023-04-27T07:59:38Z

@opokornyy Tasks can have return values, so why not return the name/namespace of the created VM? Other tasks (e.g. creating DataVolumes) do the same.

opokornyy · 2023-04-27T11:46:43Z

@opokornyy Tasks can have return values, so why not return the name/namespace of the created VM? Other tasks (e.g. creating DataVolumes) do the same.

I have to correct myself here, the task already have a return values with name/namespace of the VM that was created.

kubevirt-tekton-tasks/templates/create-vm-from-manifest/manifests/create-vm.yaml

Line 85 in 9cfaf98

results:

opokornyy · 2023-05-02T11:52:09Z

/retest

0xFelix · 2023-05-02T12:09:37Z

modules/tests/test/create_vm_from_manifest_test.go

+					ExpectedLogs:   ExpectedSuccessfulVMCreation,
+				},
+				TaskData: testconfigs.CreateVMTaskData{
+					Virtctl: fmt.Sprintf("--name %s --run-strategy Halted", vmName),


Use random name returned by task instead?

0xFelix · 2023-05-02T12:09:47Z

modules/tests/test/create_vm_from_manifest_test.go

+					ExpectedLogs:   ExpectedSuccessfulVMCreation,
+				},
+				TaskData: testconfigs.CreateVMTaskData{
+					Virtctl: fmt.Sprintf("--name %s --instancetype %s", vmName, instancetypeName),


Same as above.

0xFelix · 2023-05-02T12:09:58Z

modules/tests/test/create_vm_from_manifest_test.go

+					ExpectedLogs:   ExpectedSuccessfulVMCreation,
+				},
+				TaskData: testconfigs.CreateVMTaskData{
+					Virtctl: fmt.Sprintf("--name %s --run-strategy Halted --instancetype %s", vmName, instancetypeName),


Same as above.

opokornyy · 2023-05-02T18:59:43Z

/retest

ksimon1 · 2023-05-03T06:56:50Z

/retest

opokornyy · 2023-05-03T11:33:23Z

/retest

opokornyy · 2023-05-03T13:05:42Z

/retest

0xFelix · 2023-05-04T07:16:57Z

modules/create-vm/cmd/create-vm/main.go

-		if err != nil {
+
+	if cliOptions.GetStartVMFlag() &&
+		(vm.Spec.RunStrategy == nil || *vm.Spec.RunStrategy != kubevirtv1.RunStrategyAlways) {


What happens if spec.running is already true, i.e. the VM is already running?

It caused an error and should be fixed now.

0xFelix · 2023-05-04T07:18:28Z

modules/create-vm/go.mod

 	go.uber.org/zap v1.19.1
 	k8s.io/api v0.25.2
 	k8s.io/apimachinery v0.25.2
 	k8s.io/client-go v12.0.0+incompatible
-	kubevirt.io/api v0.59.0
-	kubevirt.io/client-go v0.59.0
+	kubevirt.io/api v0.60.0-alpha.0


You might want to update this to v1.0.0-alpha.0 to have kubevirt/kubevirt#9651 included.

Signed-off-by: Ondrej Pokorny <opokorny@redhat.com>

This commit adds functionality to create-vm-from-manifest-task to create vm with virtctl create vm command. Signed-off-by: Ondrej Pokorny <opokorny@redhat.com>

ksimon1 · 2023-05-04T10:55:56Z

/lgtm

0xFelix

/approve

openshift-ci · 2023-05-05T06:20:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 0xFelix, opokornyy

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [0xFelix]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kubevirt-bot added dco-signoff: yes Indicates the PR's author has DCO signed all their commits. size/XXL labels Apr 25, 2023

openshift-ci bot requested review from 0xFelix and ksimon1 April 25, 2023 12:22

kubevirt-bot requested a review from akrejcir April 25, 2023 12:22

opokornyy force-pushed the tekton-virtctl branch from b561e36 to fecf87f Compare April 25, 2023 12:41

0xFelix reviewed Apr 26, 2023

View reviewed changes

opokornyy force-pushed the tekton-virtctl branch from fecf87f to 20b5e84 Compare April 26, 2023 09:33

0xFelix reviewed Apr 27, 2023

View reviewed changes

opokornyy force-pushed the tekton-virtctl branch 2 times, most recently from 15634f5 to dcd4263 Compare April 27, 2023 14:10

0xFelix reviewed May 2, 2023

View reviewed changes

opokornyy force-pushed the tekton-virtctl branch from dcd4263 to 8e5b5dd Compare May 2, 2023 14:17

opokornyy force-pushed the tekton-virtctl branch from 8e5b5dd to 2383f40 Compare May 3, 2023 09:42

0xFelix reviewed May 4, 2023

View reviewed changes

feat: Add changed vendor files

bf6bf03

Signed-off-by: Ondrej Pokorny <opokorny@redhat.com>

opokornyy force-pushed the tekton-virtctl branch from 2383f40 to ceb5639 Compare May 4, 2023 09:09

feat: Add functionality to allow user to create vm with virtctl

7257b78

This commit adds functionality to create-vm-from-manifest-task to create vm with virtctl create vm command. Signed-off-by: Ondrej Pokorny <opokorny@redhat.com>

opokornyy force-pushed the tekton-virtctl branch from ceb5639 to 7257b78 Compare May 4, 2023 09:44

openshift-ci bot assigned ksimon1 May 4, 2023

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 4, 2023

0xFelix approved these changes May 5, 2023

View reviewed changes

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 5, 2023

ksimon1 merged commit 83cd6e1 into kubevirt:main May 5, 2023
1 check passed

ksimon1 mentioned this pull request Jul 11, 2023

Align kubevirt tekton tasks with instance types #242

Closed

Add virtctl to tekton task #244

Add virtctl to tekton task #244

Conversation

opokornyy commented Apr 25, 2023

0xFelix left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksimon1 Apr 26, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksimon1 commented Apr 26, 2023

opokornyy commented Apr 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xFelix commented Apr 27, 2023

opokornyy commented Apr 27, 2023

opokornyy commented May 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

opokornyy commented May 2, 2023

ksimon1 commented May 3, 2023

opokornyy commented May 3, 2023

opokornyy commented May 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksimon1 commented May 4, 2023

0xFelix left a comment

Choose a reason for hiding this comment

openshift-ci bot commented May 5, 2023

ksimon1 Apr 26, 2023 •

edited