-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
1242 lines (1083 loc) · 50.1 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This file is part of the KubeVirt project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright 2017 Red Hat, Inc.
*
*/
package v1
//go:generate swagger-doc
//go:generate deepcopy-gen -i . --go-header-file ../../../hack/boilerplate/boilerplate.go.txt
//go:generate defaulter-gen -i . --go-header-file ../../../hack/boilerplate/boilerplate.go.txt
//go:generate openapi-gen -i . --output-package=kubevirt.io/kubevirt/pkg/api/v1 --go-header-file ../../../hack/boilerplate/boilerplate.go.txt
/*
ATTENTION: Rerun code generators when comments on structs or fields are modified.
*/
import (
"encoding/json"
"fmt"
cdiv1 "kubevirt.io/containerized-data-importer/pkg/apis/core/v1alpha1"
"github.com/kunalkushwaha/go-sdk/precond"
v1 "k8s.io/api/autoscaling/v1"
k8sv1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/runtime/serializer"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/kubernetes/scheme"
)
// GroupName is the group name use in this package
const GroupName = "kubevirt.io"
const SubresourceGroupName = "subresources.kubevirt.io"
const DefaultGracePeriodSeconds int64 = 30
// GroupVersion is group version used to register these objects
var GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha3"}
// GroupVersion is group version used to register these objects
var SubresourceGroupVersion = schema.GroupVersion{Group: SubresourceGroupName, Version: "v1alpha3"}
// GroupVersionKind
var VirtualMachineInstanceGroupVersionKind = schema.GroupVersionKind{Group: GroupName, Version: GroupVersion.Version, Kind: "VirtualMachineInstance"}
var VirtualMachineInstanceReplicaSetGroupVersionKind = schema.GroupVersionKind{Group: GroupName, Version: GroupVersion.Version, Kind: "VirtualMachineInstanceReplicaSet"}
var VirtualMachineInstancePresetGroupVersionKind = schema.GroupVersionKind{Group: GroupName, Version: GroupVersion.Version, Kind: "VirtualMachineInstancePreset"}
var VirtualMachineGroupVersionKind = schema.GroupVersionKind{Group: GroupName, Version: GroupVersion.Version, Kind: "VirtualMachine"}
var VirtualMachineInstanceMigrationGroupVersionKind = schema.GroupVersionKind{Group: GroupName, Version: GroupVersion.Version, Kind: "VirtualMachineInstanceMigration"}
var KubeVirtGroupVersionKind = schema.GroupVersionKind{Group: GroupName, Version: GroupVersion.Version, Kind: "KubeVirt"}
// Adds the list of known types to api.Scheme.
func addKnownTypes(scheme *runtime.Scheme) error {
scheme.AddKnownTypes(GroupVersion,
&VirtualMachineInstance{},
&VirtualMachineInstanceList{},
&metav1.ListOptions{},
&metav1.DeleteOptions{},
&VirtualMachineInstanceReplicaSet{},
&VirtualMachineInstanceReplicaSetList{},
&VirtualMachineInstancePreset{},
&VirtualMachineInstancePresetList{},
&VirtualMachineInstanceMigration{},
&VirtualMachineInstanceMigrationList{},
&metav1.GetOptions{},
&VirtualMachine{},
&VirtualMachineList{},
&KubeVirt{},
&KubeVirtList{},
)
scheme.AddKnownTypes(metav1.Unversioned,
&metav1.Status{},
)
scheme.AddKnownTypes(schema.GroupVersion{Group: "autoscaling", Version: "v1"},
&v1.Scale{},
)
return nil
}
var (
Scheme = runtime.NewScheme()
Codecs = serializer.NewCodecFactory(Scheme)
ParameterCodec = runtime.NewParameterCodec(Scheme)
SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
AddToScheme = SchemeBuilder.AddToScheme
)
func init() {
AddToScheme(Scheme)
AddToScheme(scheme.Scheme)
}
// VirtualMachineInstance is *the* VirtualMachineInstance Definition. It represents a virtual machine in the runtime environment of kubernetes.
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstance struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
Spec VirtualMachineInstanceSpec `json:"spec,omitempty" valid:"required"`
// Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.
Status VirtualMachineInstanceStatus `json:"status,omitempty"`
}
func (v *VirtualMachineInstance) MarshalBinary() (data []byte, err error) {
return json.Marshal(*v)
}
func (v *VirtualMachineInstance) UnmarshalBinary(data []byte) error {
return json.Unmarshal(data, v)
}
// VirtualMachineInstanceList is a list of VirtualMachines
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstanceList struct {
metav1.TypeMeta `json:",inline"`
ListMeta metav1.ListMeta `json:"metadata,omitempty"`
Items []VirtualMachineInstance `json:"items"`
}
// +k8s:openapi-gen=true
type EvictionStrategy string
// VirtualMachineInstanceSpec is a description of a VirtualMachineInstance.
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceSpec struct {
// Specification of the desired behavior of the VirtualMachineInstance on the host.
Domain DomainSpec `json:"domain"`
// NodeSelector is a selector which must be true for the vmi to fit on a node.
// Selector which must match a node's labels for the vmi to be scheduled on that node.
// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
// +optional
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
// If affinity is specifies, obey all the affinity rules
Affinity *k8sv1.Affinity `json:"affinity,omitempty"`
// If toleration is specified, obey all the toleration rules.
Tolerations []k8sv1.Toleration `json:"tolerations,omitempty"`
// EvictionStrategy can be set to "LiveMigrate" if the VirtualMachineInstance should be
// migrated instead of shut-off in case of a node drain.
// ---
// +optional
EvictionStrategy *EvictionStrategy `json:"evictionStrategy,omitempty"`
// Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.
TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
// List of volumes that can be mounted by disks belonging to the vmi.
Volumes []Volume `json:"volumes,omitempty"`
// Periodic probe of VirtualMachineInstance liveness.
// VirtualmachineInstances will be stopped if the probe fails.
// Cannot be updated.
// More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
// +optional
LivenessProbe *Probe `json:"livenessProbe,omitempty"`
// Periodic probe of VirtualMachineInstance service readiness.
// VirtualmachineInstances will be removed from service endpoints if the probe fails.
// Cannot be updated.
// More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
// +optional
ReadinessProbe *Probe `json:"readinessProbe,omitempty"`
// Specifies the hostname of the vmi
// If not specified, the hostname will be set to the name of the vmi, if dhcp or cloud-init is configured properly.
// +optional
Hostname string `json:"hostname,omitempty"`
// If specified, the fully qualified vmi hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
// If not specified, the vmi will not have a domainname at all. The DNS entry will resolve to the vmi,
// no matter if the vmi itself can pick up a hostname.
// +optional
Subdomain string `json:"subdomain,omitempty"`
// List of networks that can be attached to a vm's virtual interface.
Networks []Network `json:"networks,omitempty"`
// Set DNS policy for the pod.
// Defaults to "ClusterFirst".
// Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.
// DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.
// To have DNS options set along with hostNetwork, you have to specify DNS policy
// explicitly to 'ClusterFirstWithHostNet'.
// +optional
DNSPolicy k8sv1.DNSPolicy `json:"dnsPolicy,omitempty" protobuf:"bytes,6,opt,name=dnsPolicy,casttype=DNSPolicy"`
// Specifies the DNS parameters of a pod.
// Parameters specified here will be merged to the generated DNS
// configuration based on DNSPolicy.
// +optional
DNSConfig *k8sv1.PodDNSConfig `json:"dnsConfig,omitempty" protobuf:"bytes,26,opt,name=dnsConfig"`
}
// VirtualMachineInstanceStatus represents information about the status of a VirtualMachineInstance. Status may trail the actual
// state of a system.
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceStatus struct {
// NodeName is the name where the VirtualMachineInstance is currently running.
NodeName string `json:"nodeName,omitempty"`
// A brief CamelCase message indicating details about why the VMI is in this state. e.g. 'NodeUnresponsive'
// +optional
Reason string `json:"reason,omitempty"`
// Conditions are specific points in VirtualMachineInstance's pod runtime.
Conditions []VirtualMachineInstanceCondition `json:"conditions,omitempty"`
// Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it.
Phase VirtualMachineInstancePhase `json:"phase,omitempty"`
// Interfaces represent the details of available network interfaces.
Interfaces []VirtualMachineInstanceNetworkInterface `json:"interfaces,omitempty"`
// Represents the status of a live migration
MigrationState *VirtualMachineInstanceMigrationState `json:"migrationState,omitempty"`
// Represents the method using which the vmi can be migrated: live migration or block migration
MigrationMethod VirtualMachineInstanceMigrationMethod `json:"migrationMethod,omitempty"`
}
// Required to satisfy Object interface
func (v *VirtualMachineInstance) GetObjectKind() schema.ObjectKind {
return &v.TypeMeta
}
// Required to satisfy ObjectMetaAccessor interface
func (v *VirtualMachineInstance) GetObjectMeta() metav1.Object {
return &v.ObjectMeta
}
func (v *VirtualMachineInstance) IsScheduling() bool {
return v.Status.Phase == Scheduling
}
func (v *VirtualMachineInstance) IsScheduled() bool {
return v.Status.Phase == Scheduled
}
func (v *VirtualMachineInstance) IsRunning() bool {
return v.Status.Phase == Running
}
func (v *VirtualMachineInstance) IsFinal() bool {
return v.Status.Phase == Failed || v.Status.Phase == Succeeded
}
func (v *VirtualMachineInstance) IsUnknown() bool {
return v.Status.Phase == Unknown
}
func (v *VirtualMachineInstance) IsUnprocessed() bool {
return v.Status.Phase == Pending || v.Status.Phase == VmPhaseUnset
}
// Checks if CPU pinning has been requested
func (v *VirtualMachineInstance) IsCPUDedicated() bool {
return v.Spec.Domain.CPU != nil && v.Spec.Domain.CPU.DedicatedCPUPlacement
}
// Required to satisfy Object interface
func (vl *VirtualMachineInstanceList) GetObjectKind() schema.ObjectKind {
return &vl.TypeMeta
}
// Required to satisfy ListMetaAccessor interface
func (vl *VirtualMachineInstanceList) GetListMeta() meta.List {
return &vl.ListMeta
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceConditionType string
// These are valid conditions of VMIs.
const (
// VMIReady means the pod is able to service requests and should be added to the
// load balancing pools of all matching services.
VirtualMachineInstanceReady VirtualMachineInstanceConditionType = "Ready"
// If there happens any error while trying to synchronize the VirtualMachineInstance with the Domain,
// this is reported as false.
VirtualMachineInstanceSynchronized VirtualMachineInstanceConditionType = "Synchronized"
// Reflects whether the QEMU guest agent is connected through the channel
VirtualMachineInstanceAgentConnected VirtualMachineInstanceConditionType = "AgentConnected"
// Indicates whether the VMI is live migratable
VirtualMachineInstanceIsMigratable VirtualMachineInstanceConditionType = "LiveMigratable"
// Reason means that VMI is not live migratioable because of it's disks collection
VirtualMachineInstanceReasonDisksNotMigratable = "DisksNotLiveMigratable"
)
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationConditionType string
// These are valid conditions of VMIs.
const (
// VirtualMachineInstanceMigrationAbortRequested indicates that live migration abort has been requested
VirtualMachineInstanceMigrationAbortRequested VirtualMachineInstanceMigrationConditionType = "migrationAbortRequested"
)
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceCondition struct {
Type VirtualMachineInstanceConditionType `json:"type"`
Status k8sv1.ConditionStatus `json:"status"`
LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
Reason string `json:"reason,omitempty"`
Message string `json:"message,omitempty"`
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationCondition struct {
Type VirtualMachineInstanceMigrationConditionType `json:"type"`
Status k8sv1.ConditionStatus `json:"status"`
LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
Reason string `json:"reason,omitempty"`
Message string `json:"message,omitempty"`
}
// The migration phase indicates that the job has completed
func (m *VirtualMachineInstanceMigration) IsFinal() bool {
return m.Status.Phase == MigrationFailed || m.Status.Phase == MigrationSucceeded
}
func (m *VirtualMachineInstanceMigration) IsRunning() bool {
switch m.Status.Phase {
case MigrationFailed, MigrationPending, MigrationPhaseUnset, MigrationSucceeded:
return false
}
return true
}
// The migration phase indicates that the target pod should have already been created
func (m *VirtualMachineInstanceMigration) TargetIsCreated() bool {
return m.Status.Phase != MigrationPhaseUnset &&
m.Status.Phase != MigrationPending
}
// The migration phase indicates that job has been handed off to the VMI controllers to complete.
func (m *VirtualMachineInstanceMigration) TargetIsHandedOff() bool {
return m.Status.Phase != MigrationPhaseUnset &&
m.Status.Phase != MigrationPending &&
m.Status.Phase != MigrationScheduling &&
m.Status.Phase != MigrationScheduled
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceNetworkInterface struct {
// IP address of a Virtual Machine interface
IP string `json:"ipAddress,omitempty"`
// Hardware address of a Virtual Machine interface
MAC string `json:"mac,omitempty"`
// Name of the interface, corresponds to name of the network assigned to the interface
// TODO: remove omitempty, when api breaking changes are allowed
Name string `json:"name,omitempty"`
// List of all IP addresses of a Virtual Machine interface
IPs []string `json:"ipAddresses,omitempty"`
// The interface name inside the Virtual Machine
InterfaceName string `json:"interfaceName,omitempty"`
}
type VirtualMachineInstanceMigrationState struct {
// The time the migration action began
StartTimestamp *metav1.Time `json:"startTimestamp,omitempty"`
// The time the migration action ended
EndTimestamp *metav1.Time `json:"endTimestamp,omitempty"`
// The Target Node has seen the Domain Start Event
TargetNodeDomainDetected bool `json:"targetNodeDomainDetected,omitempty"`
// The address of the target node to use for the migration
TargetNodeAddress string `json:"targetNodeAddress,omitempty"`
// The list of ports opened for live migration on the destination node
TargetDirectMigrationNodePorts map[int]int `json:"targetDirectMigrationNodePorts,omitempty"`
// The target node that the VMI is moving to
TargetNode string `json:"targetNode,omitempty"`
// The target pod that the VMI is moving to
TargetPod string `json:"targetPod,omitempty"`
// The source node that the VMI originated on
SourceNode string `json:"sourceNode,omitempty"`
// Indicates the migration completed
Completed bool `json:"completed,omitempty"`
// Indicates that the migration failed
Failed bool `json:"failed,omitempty"`
// Indicates that the migration has been requested to abort
AbortRequested bool `json:"abortRequested,omitempty"`
// Indicates the final status of the live migration abortion
AbortStatus MigrationAbortStatus `json:"abortStatus,omitempty"`
// The VirtualMachineInstanceMigration object associated with this migration
MigrationUID types.UID `json:"migrationUid,omitempty"`
}
// ---
// +k8s:openapi-gen=true
type MigrationAbortStatus string
const (
// MigrationAbortSucceeded means that the VirtualMachineInstance live migration has been aborted
MigrationAbortSucceeded MigrationAbortStatus = "Succeeded"
// MigrationAbortFailed means that the vmi live migration has failed to be abort
MigrationAbortFailed MigrationAbortStatus = "Failed"
// MigrationAbortInProgress mean that the vmi live migration is aborting
MigrationAbortInProgress MigrationAbortStatus = "Aborting"
)
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationMethod string
const (
// BlockMigration means that all VirtualMachineInstance disks should be copied over to the destination host
BlockMigration VirtualMachineInstanceMigrationMethod = "BlockMigration"
// LiveMigration means that VirtualMachineInstance disks will not be copied over to the destination host
LiveMigration VirtualMachineInstanceMigrationMethod = "LiveMigration"
)
// VirtualMachineInstancePhase is a label for the condition of a VirtualMachineInstance at the current time.
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstancePhase string
// These are the valid statuses of pods.
const (
//When a VirtualMachineInstance Object is first initialized and no phase, or Pending is present.
VmPhaseUnset VirtualMachineInstancePhase = ""
// Pending means the VirtualMachineInstance has been accepted by the system.
Pending VirtualMachineInstancePhase = "Pending"
// A target Pod exists but is not yet scheduled and in running state.
Scheduling VirtualMachineInstancePhase = "Scheduling"
// A target pod was scheduled and the system saw that Pod in runnig state.
// Here is where the responsibility of virt-controller ends and virt-handler takes over.
Scheduled VirtualMachineInstancePhase = "Scheduled"
// Running means the pod has been bound to a node and the VirtualMachineInstance is started.
Running VirtualMachineInstancePhase = "Running"
// Succeeded means that the VirtualMachineInstance stopped voluntarily, e.g. reacted to SIGTERM or shutdown was invoked from
// inside the VirtualMachineInstance.
Succeeded VirtualMachineInstancePhase = "Succeeded"
// Failed means that the vmi crashed, disappeared unexpectedly or got deleted from the cluster before it was ever started.
Failed VirtualMachineInstancePhase = "Failed"
// Unknown means that for some reason the state of the VirtualMachineInstance could not be obtained, typically due
// to an error in communicating with the host of the VirtualMachineInstance.
Unknown VirtualMachineInstancePhase = "Unknown"
)
const (
// This label marks resources that belong to KubeVirt. An optional value
// may indicate which specific KubeVirt component a resource belongs to.
AppLabel string = "kubevirt.io"
// This annotation is used to match virtual machine instances represented as
// libvirt XML domains with their pods. Among other things, the annotation is
// used to detect virtual machines with dead pods. Used on Pod.
DomainAnnotation string = "kubevirt.io/domain"
// Represents the name of the migration job this target pod is associated with
MigrationJobNameAnnotation string = "kubevirt.io/migrationJobName"
// This label is used to match virtual machine instance IDs with pods.
// Similar to kubevirt.io/domain. Used on Pod.
// Internal use only.
CreatedByLabel string = "kubevirt.io/created-by"
// This label is used to indicate that this pod is the target of a migration job.
MigrationJobLabel string = "kubevirt.io/migrationJobUID"
// This label describes which cluster node runs the virtual machine
// instance. Needed because with CRDs we can't use field selectors. Used on
// VirtualMachineInstance.
NodeNameLabel string = "kubevirt.io/nodeName"
// This label describes which cluster node runs the target Pod for a Virtual
// Machine Instance migration job. Needed because with CRDs we can't use field
// selectors. Used on VirtualMachineInstance.
MigrationTargetNodeNameLabel string = "kubevirt.io/migrationTargetNodeName"
// This label declares whether a particular node is available for
// scheduling virtual machine instances on it. Used on Node.
NodeSchedulable string = "kubevirt.io/schedulable"
// This annotation is regularly updated by virt-handler to help determine
// if a particular node is alive and hence should be available for new
// virtual machine instance scheduling. Used on Node.
VirtHandlerHeartbeat string = "kubevirt.io/heartbeat"
// This label will be set on all resources created by the operator
ManagedByLabel = "app.kubernetes.io/managed-by"
ManagedByLabelOperatorValue = "kubevirt-operator"
// This annotation represents the kubevirt version for an install strategy configmap.
InstallStrategyVersionAnnotation = "kubevirt.io/install-strategy-version"
// This annotation represents the kubevirt registry used for an install strategy configmap.
InstallStrategyRegistryAnnotation = "kubevirt.io/install-strategy-registry"
// This annotation represents that this object is for temporary use during updates
EphemeralBackupObject = "kubevirt.io/ephemeral-backup-object"
// This label indicates the object is a part of the install strategy retrieval process.
InstallStrategyLabel = "kubevirt.io/install-strategy"
VirtualMachineInstanceFinalizer string = "foregroundDeleteVirtualMachine"
VirtualMachineInstanceMigrationFinalizer string = "kubevirt.io/migrationJobFinalize"
CPUManager string = "cpumanager"
// This annotation is used to inject ignition data
// Used on VirtualMachineInstance.
IgnitionAnnotation string = "kubevirt.io/ignitiondata"
)
func NewVMI(name string, uid types.UID) *VirtualMachineInstance {
return &VirtualMachineInstance{
Spec: VirtualMachineInstanceSpec{},
ObjectMeta: metav1.ObjectMeta{
Name: name,
UID: uid,
Namespace: k8sv1.NamespaceDefault,
},
Status: VirtualMachineInstanceStatus{},
TypeMeta: metav1.TypeMeta{
APIVersion: GroupVersion.String(),
Kind: VirtualMachineInstanceGroupVersionKind.Kind,
},
}
}
// ---
// +k8s:openapi-gen=true
type SyncEvent string
const (
Created SyncEvent = "Created"
Deleted SyncEvent = "Deleted"
PresetFailed SyncEvent = "PresetFailed"
Override SyncEvent = "Override"
Started SyncEvent = "Started"
ShuttingDown SyncEvent = "ShuttingDown"
Stopped SyncEvent = "Stopped"
PreparingTarget SyncEvent = "PreparingTarget"
Migrating SyncEvent = "Migrating"
Migrated SyncEvent = "Migrated"
SyncFailed SyncEvent = "SyncFailed"
Resumed SyncEvent = "Resumed"
)
func (s SyncEvent) String() string {
return string(s)
}
func NewMinimalVMI(vmiName string) *VirtualMachineInstance {
return NewMinimalVMIWithNS(k8sv1.NamespaceDefault, vmiName)
}
func NewMinimalVMIWithNS(namespace string, vmiName string) *VirtualMachineInstance {
precond.CheckNotEmpty(vmiName)
vmi := NewVMIReferenceFromNameWithNS(namespace, vmiName)
vmi.Spec = VirtualMachineInstanceSpec{Domain: NewMinimalDomainSpec()}
vmi.TypeMeta = metav1.TypeMeta{
APIVersion: GroupVersion.String(),
Kind: "VirtualMachineInstance",
}
return vmi
}
// TODO Namespace could be different, also store it somewhere in the domain, so that we can report deletes on handler startup properly
func NewVMIReferenceFromName(name string) *VirtualMachineInstance {
return NewVMIReferenceFromNameWithNS(k8sv1.NamespaceDefault, name)
}
func NewVMIReferenceFromNameWithNS(namespace string, name string) *VirtualMachineInstance {
vmi := &VirtualMachineInstance{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: namespace,
SelfLink: fmt.Sprintf("/apis/%s/namespaces/%s/virtualmachineinstances/%s", GroupVersion.String(), namespace, name),
},
}
vmi.SetGroupVersionKind(schema.GroupVersionKind{Group: GroupVersion.Group, Kind: "VirtualMachineInstance", Version: GroupVersion.Version})
return vmi
}
func NewVMIReferenceWithUUID(namespace string, name string, uuid types.UID) *VirtualMachineInstance {
vmi := NewVMIReferenceFromNameWithNS(namespace, name)
vmi.UID = uuid
return vmi
}
type VMISelector struct {
// Name of the VirtualMachineInstance to migrate
Name string `json:"name" valid:"required"`
}
// Given a VirtualMachineInstance, update all NodeSelectorTerms with anti-affinity for that VirtualMachineInstance's node.
// This is useful for the case when a migration away from a node must occur.
// This method returns the full Affinity structure updated the anti affinity terms
func UpdateAntiAffinityFromVMINode(pod *k8sv1.Pod, vmi *VirtualMachineInstance) *k8sv1.Affinity {
if pod.Spec.Affinity == nil {
pod.Spec.Affinity = &k8sv1.Affinity{}
}
if pod.Spec.Affinity.NodeAffinity == nil {
pod.Spec.Affinity.NodeAffinity = &k8sv1.NodeAffinity{}
}
if pod.Spec.Affinity.NodeAffinity.RequiredDuringSchedulingIgnoredDuringExecution == nil {
pod.Spec.Affinity.NodeAffinity.RequiredDuringSchedulingIgnoredDuringExecution = &k8sv1.NodeSelector{}
}
selector := pod.Spec.Affinity.NodeAffinity.RequiredDuringSchedulingIgnoredDuringExecution
terms := selector.NodeSelectorTerms
if len(terms) == 0 {
selector.NodeSelectorTerms = append(terms, k8sv1.NodeSelectorTerm{})
terms = selector.NodeSelectorTerms
}
for idx, term := range terms {
if term.MatchExpressions == nil {
term.MatchExpressions = []k8sv1.NodeSelectorRequirement{}
}
term.MatchExpressions = append(term.MatchExpressions, PrepareVMINodeAntiAffinitySelectorRequirement(vmi))
selector.NodeSelectorTerms[idx] = term
}
return pod.Spec.Affinity
}
// Given a VirtualMachineInstance, create a NodeSelectorTerm with anti-affinity for that VirtualMachineInstance's node.
// This is useful for the case when a migration away from a node must occur.
func PrepareVMINodeAntiAffinitySelectorRequirement(vmi *VirtualMachineInstance) k8sv1.NodeSelectorRequirement {
return k8sv1.NodeSelectorRequirement{
Key: "kubernetes.io/hostname",
Operator: k8sv1.NodeSelectorOpNotIn,
Values: []string{vmi.Status.NodeName},
}
}
// VirtualMachineInstance is *the* VirtualMachineInstance Definition. It represents a virtual machine in the runtime environment of kubernetes.
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstanceReplicaSet struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
Spec VirtualMachineInstanceReplicaSetSpec `json:"spec,omitempty" valid:"required"`
// Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.
Status VirtualMachineInstanceReplicaSetStatus `json:"status,omitempty"`
}
// VMIList is a list of VMIs
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstanceReplicaSetList struct {
metav1.TypeMeta `json:",inline"`
ListMeta metav1.ListMeta `json:"metadata,omitempty"`
Items []VirtualMachineInstanceReplicaSet `json:"items"`
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceReplicaSetSpec struct {
// Number of desired pods. This is a pointer to distinguish between explicit
// zero and not specified. Defaults to 1.
// +optional
Replicas *int32 `json:"replicas,omitempty"`
// Label selector for pods. Existing ReplicaSets whose pods are
// selected by this will be the ones affected by this deployment.
Selector *metav1.LabelSelector `json:"selector" valid:"required"`
// Template describes the pods that will be created.
Template *VirtualMachineInstanceTemplateSpec `json:"template" valid:"required"`
// Indicates that the replica set is paused.
// +optional
Paused bool `json:"paused,omitempty" protobuf:"varint,7,opt,name=paused"`
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceReplicaSetStatus struct {
// Total number of non-terminated pods targeted by this deployment (their labels match the selector).
// +optional
Replicas int32 `json:"replicas,omitempty" protobuf:"varint,2,opt,name=replicas"`
// The number of ready replicas for this replica set.
// +optional
ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,4,opt,name=readyReplicas"`
Conditions []VirtualMachineInstanceReplicaSetCondition `json:"conditions,omitempty" optional:"true"`
// Canonical form of the label selector for HPA which consumes it through the scale subresource.
LabelSelector string `json:"labelSelector,omitempty"`
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceReplicaSetCondition struct {
Type VirtualMachineInstanceReplicaSetConditionType `json:"type"`
Status k8sv1.ConditionStatus `json:"status"`
LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
Reason string `json:"reason,omitempty"`
Message string `json:"message,omitempty"`
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceReplicaSetConditionType string
const (
// VirtualMachineInstanceReplicaSetReplicaFailure is added in a replica set when one of its vmis
// fails to be created due to insufficient quota, limit ranges, pod security policy, node selectors,
// etc. or deleted due to kubelet being down or finalizers are failing.
VirtualMachineInstanceReplicaSetReplicaFailure VirtualMachineInstanceReplicaSetConditionType = "ReplicaFailure"
// VirtualMachineInstanceReplicaSetReplicaPaused is added in a replica set when the replica set got paused by the controller.
// After this condition was added, it is safe to remove or add vmis by hand and adjust the replica count by hand.
VirtualMachineInstanceReplicaSetReplicaPaused VirtualMachineInstanceReplicaSetConditionType = "ReplicaPaused"
)
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceTemplateSpec struct {
ObjectMeta metav1.ObjectMeta `json:"metadata,omitempty"`
// VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
Spec VirtualMachineInstanceSpec `json:"spec,omitempty" valid:"required"`
}
// Required to satisfy Object interface
func (v *VirtualMachineInstanceReplicaSet) GetObjectKind() schema.ObjectKind {
return &v.TypeMeta
}
// Required to satisfy ObjectMetaAccessor interface
func (v *VirtualMachineInstanceReplicaSet) GetObjectMeta() metav1.Object {
return &v.ObjectMeta
}
// Required to satisfy Object interface
func (vl *VirtualMachineInstanceReplicaSetList) GetObjectKind() schema.ObjectKind {
return &vl.TypeMeta
}
// Required to satisfy ListMetaAccessor interface
func (vl *VirtualMachineInstanceReplicaSetList) GetListMeta() meta.List {
return &vl.ListMeta
}
// VirtualMachineInstanceMigration represents the object tracking a VMI's migration
// to another host in the cluster
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigration struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec VirtualMachineInstanceMigrationSpec `json:"spec,omitempty" valid:"required"`
Status VirtualMachineInstanceMigrationStatus `json:"status,omitempty"`
}
// Required to satisfy Object interface
func (v *VirtualMachineInstanceMigration) GetObjectKind() schema.ObjectKind {
return &v.TypeMeta
}
// Required to satisfy ObjectMetaAccessor interface
func (v *VirtualMachineInstanceMigration) GetObjectMeta() metav1.Object {
return &v.ObjectMeta
}
// VirtualMachineInstanceMigrationList is a list of VirtualMachineMigrations
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationList struct {
metav1.TypeMeta `json:",inline"`
ListMeta metav1.ListMeta `json:"metadata,omitempty"`
Items []VirtualMachineInstanceMigration `json:"items"`
}
// Required to satisfy Object interface
func (vl *VirtualMachineInstanceMigrationList) GetObjectKind() schema.ObjectKind {
return &vl.TypeMeta
}
// Required to satisfy ListMetaAccessor interface
func (vl *VirtualMachineInstanceMigrationList) GetListMeta() meta.List {
return &vl.ListMeta
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationSpec struct {
// The name of the VMI to perform the migration on. VMI must exist in the migration objects namespace
VMIName string `json:"vmiName,omitempty" valid:"required"`
}
// VirtualMachineInstanceMigration reprents information pertaining to a VMI's migration.
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationStatus struct {
Phase VirtualMachineInstanceMigrationPhase `json:"phase,omitempty"`
Conditions []VirtualMachineInstanceMigrationCondition `json:"conditions,omitempty"`
}
// VirtualMachineInstanceMigrationPhase is a label for the condition of a VirtualMachineInstanceMigration at the current time.
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstanceMigrationPhase string
// These are the valid migration phases
const (
MigrationPhaseUnset VirtualMachineInstanceMigrationPhase = ""
// The migration is accepted by the system
MigrationPending VirtualMachineInstanceMigrationPhase = "Pending"
// The migration's target pod is being scheduled
MigrationScheduling VirtualMachineInstanceMigrationPhase = "Scheduling"
// The migration's target pod is running
MigrationScheduled VirtualMachineInstanceMigrationPhase = "Scheduled"
// The migration's target pod is being prepared for migration
MigrationPreparingTarget VirtualMachineInstanceMigrationPhase = "PreparingTarget"
// The migration's target pod is prepared and ready for migration
MigrationTargetReady VirtualMachineInstanceMigrationPhase = "TargetReady"
// The migration is in progress
MigrationRunning VirtualMachineInstanceMigrationPhase = "Running"
// The migration passed
MigrationSucceeded VirtualMachineInstanceMigrationPhase = "Succeeded"
// The migration failed
MigrationFailed VirtualMachineInstanceMigrationPhase = "Failed"
)
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstancePreset struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// VirtualMachineInstance Spec contains the VirtualMachineInstance specification.
Spec VirtualMachineInstancePresetSpec `json:"spec,omitempty" valid:"required"`
}
// Required to satisfy Object interface
func (v *VirtualMachineInstancePreset) GetObjectKind() schema.ObjectKind {
return &v.TypeMeta
}
// Required to satisfy ObjectMetaAccessor interface
func (v *VirtualMachineInstancePreset) GetObjectMeta() metav1.Object {
return &v.ObjectMeta
}
// VirtualMachineInstancePresetList is a list of VirtualMachinePresets
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineInstancePresetList struct {
metav1.TypeMeta `json:",inline"`
ListMeta metav1.ListMeta `json:"metadata,omitempty"`
Items []VirtualMachineInstancePreset `json:"items"`
}
// ---
// +k8s:openapi-gen=true
type VirtualMachineInstancePresetSpec struct {
// Selector is a label query over a set of VMIs.
// Required.
Selector metav1.LabelSelector `json:"selector"`
// Domain is the same object type as contained in VirtualMachineInstanceSpec
Domain *DomainSpec `json:"domain,omitempty"`
}
func NewVirtualMachinePreset(name string, selector metav1.LabelSelector) *VirtualMachineInstancePreset {
return &VirtualMachineInstancePreset{
Spec: VirtualMachineInstancePresetSpec{
Selector: selector,
Domain: &DomainSpec{},
},
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: k8sv1.NamespaceDefault,
},
TypeMeta: metav1.TypeMeta{
APIVersion: GroupVersion.String(),
Kind: VirtualMachineInstancePresetGroupVersionKind.Kind,
},
}
}
// Required to satisfy Object interface
func (vl *VirtualMachineInstancePresetList) GetObjectKind() schema.ObjectKind {
return &vl.TypeMeta
}
// Required to satisfy ListMetaAccessor interface
func (vl *VirtualMachineInstancePresetList) GetListMeta() meta.List {
return &vl.ListMeta
}
// VirtualMachine handles the VirtualMachines that are not running
// or are in a stopped state
// The VirtualMachine contains the template to create the
// VirtualMachineInstance. It also mirrors the running state of the created
// VirtualMachineInstance in its status.
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachine struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec contains the specification of VirtualMachineInstance created
Spec VirtualMachineSpec `json:"spec,omitempty"`
// Status holds the current state of the controller and brief information
// about its associated VirtualMachineInstance
Status VirtualMachineStatus `json:"status,omitempty"`
}
// Return the current runStrategy for the VirtualMachine
// if vm.spec.running is set, that will be mapped to runStrategy:
// false: RunStrategyHalted
// true: RunStrategyAlways
func (vm *VirtualMachine) RunStrategy() (VirtualMachineRunStrategy, error) {
if vm.Spec.Running != nil && vm.Spec.RunStrategy != nil {
return RunStrategyUnknown, fmt.Errorf("running and runstrategy are mutually exclusive")
}
RunStrategy := RunStrategyHalted
if vm.Spec.Running != nil {
if (*vm.Spec.Running) == true {
RunStrategy = RunStrategyAlways
}
} else if vm.Spec.RunStrategy != nil {
RunStrategy = *vm.Spec.RunStrategy
}
return RunStrategy, nil
}
// VirtualMachineList is a list of virtualmachines
// ---
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +k8s:openapi-gen=true
type VirtualMachineList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
// Items is a list of VirtualMachines
Items []VirtualMachine `json:"items"`
}
// VirtualMachineRunStrategy is a label for the requested VirtualMachineInstance Running State at the current time.
// ---
// +k8s:openapi-gen=true
type VirtualMachineRunStrategy string
// These are the valid VMI run strategies
const (
// Placeholder. Not a valid RunStrategy.
RunStrategyUnknown VirtualMachineRunStrategy = ""
// VMI should always be running.
RunStrategyAlways VirtualMachineRunStrategy = "Always"
// VMI should never be running.
RunStrategyHalted VirtualMachineRunStrategy = "Halted"
// VMI can be started/stopped using API endpoints.
RunStrategyManual VirtualMachineRunStrategy = "Manual"
// VMI will initially be running--and restarted if a failure occurs.
// It will not be restarted upon successful completion.
RunStrategyRerunOnFailure VirtualMachineRunStrategy = "RerunOnFailure"
)
// VirtualMachineSpec describes how the proper VirtualMachine
// should look like
// ---
// +k8s:openapi-gen=true
type VirtualMachineSpec struct {
// Running controls whether the associatied VirtualMachineInstance is created or not
// Mutually exclusive with RunStrategy
Running *bool `json:"running,omitempty" optional:"true"`
// Running state indicates the requested running state of the VirtualMachineInstance
// mutually exclusive with Running
RunStrategy *VirtualMachineRunStrategy `json:"runStrategy,omitempty" optional:"true"`
// Template is the direct specification of VirtualMachineInstance
Template *VirtualMachineInstanceTemplateSpec `json:"template"`
// dataVolumeTemplates is a list of dataVolumes that the VirtualMachineInstance template can reference.
// DataVolumes in this list are dynamically created for the VirtualMachine and are tied to the VirtualMachine's life-cycle.
DataVolumeTemplates []cdiv1.DataVolume `json:"dataVolumeTemplates,omitempty"`
}
// StateChangeRequestType represents the existing state change requests that are possible
// ---
// +k8s:openapi-gen=true
type StateChangeRequestAction string