|
| 1 | +package buildrequest |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + |
| 6 | + mcfgv1 "github.com/openshift/api/machineconfiguration/v1" |
| 7 | + corev1 "k8s.io/api/core/v1" |
| 8 | + "k8s.io/apimachinery/pkg/api/resource" |
| 9 | +) |
| 10 | + |
| 11 | +type resourceAnnotationKey string |
| 12 | + |
| 13 | +// Resource request and limit annotation keys |
| 14 | +const ( |
| 15 | + cpuResourceRequestAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/cpu-request" |
| 16 | + cpuResourceLimitAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/cpu-limit" |
| 17 | + memoryResourceRequestAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/memory-request" |
| 18 | + memoryResourceLimitAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/memory-limit" |
| 19 | + storageResourceRequestAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/storage-request" |
| 20 | + storageResourceLimitAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/storage-limit" |
| 21 | + ephemeralStorageResourceRequestAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/ephemeral-storage-request" |
| 22 | + ephemeralStorageResourceLimitAnnotationKey resourceAnnotationKey = "machineconfiguration.openshift.io/ephemeral-storage-limit" |
| 23 | + |
| 24 | + // Default CPU request value. Taken from the machine-os-builder deployment |
| 25 | + // spec. |
| 26 | + defaultCPURequest string = "20m" |
| 27 | + // Default memory request value. Taken from the machine-os-builder deployment |
| 28 | + // spec. |
| 29 | + defaultMemoryRequest string = "50Mi" |
| 30 | +) |
| 31 | + |
| 32 | +// Holds all of the functions required for getting the resource requests. This |
| 33 | +// allows to keep these functions cleanly separated while simultaneously |
| 34 | +// allowing a single linear path through them. |
| 35 | +type resources struct { |
| 36 | + mosc *mcfgv1.MachineOSConfig |
| 37 | +} |
| 38 | + |
| 39 | +// The finalized resource requirements for both the builder container as well |
| 40 | +// as the waiting container. |
| 41 | +type resourceRequirements struct { |
| 42 | + builder *corev1.ResourceRequirements |
| 43 | + defaults *corev1.ResourceRequirements |
| 44 | +} |
| 45 | + |
| 46 | +// The main entrypoint into getting the resource requirements for the |
| 47 | +// BuildRequest. |
| 48 | +func getResourceRequirements(mosc *mcfgv1.MachineOSConfig) (*resourceRequirements, error) { |
| 49 | + r := &resources{mosc: mosc} |
| 50 | + |
| 51 | + builder, err := r.getResourceRequirements() |
| 52 | + if err != nil { |
| 53 | + return nil, fmt.Errorf("could not get builder resource requirements: %w", err) |
| 54 | + } |
| 55 | + |
| 56 | + defaults, err := r.getDefaultResourceRequirements() |
| 57 | + if err != nil { |
| 58 | + return nil, fmt.Errorf("could not get default resource requirements: %w", err) |
| 59 | + } |
| 60 | + |
| 61 | + return &resourceRequirements{ |
| 62 | + builder: builder, |
| 63 | + defaults: defaults, |
| 64 | + }, nil |
| 65 | +} |
| 66 | + |
| 67 | +// Gets the resource requirements for the build pod from the MachineOSConfig |
| 68 | +// annotations or falls back to the default hard-coded values we specified. |
| 69 | +func (r *resources) getResourceRequirements() (*corev1.ResourceRequirements, error) { |
| 70 | + defaults, err := r.getDefaultResourceRequirements() |
| 71 | + if err != nil { |
| 72 | + return nil, err |
| 73 | + } |
| 74 | + |
| 75 | + userProvided, err := r.getUserProvidedResourceRequirements() |
| 76 | + if err != nil { |
| 77 | + return nil, err |
| 78 | + } |
| 79 | + |
| 80 | + // User-provided requests and limits override the defaults. |
| 81 | + for key, val := range userProvided.Requests { |
| 82 | + defaults.Requests[key] = val |
| 83 | + } |
| 84 | + |
| 85 | + for key, val := range userProvided.Limits { |
| 86 | + defaults.Limits[key] = val |
| 87 | + } |
| 88 | + |
| 89 | + return defaults, nil |
| 90 | +} |
| 91 | + |
| 92 | +// Gets the default resource requirements. |
| 93 | +func (r *resources) getDefaultResourceRequirements() (*corev1.ResourceRequirements, error) { |
| 94 | + qtys, err := getResourceList(map[corev1.ResourceName]string{ |
| 95 | + corev1.ResourceCPU: defaultCPURequest, |
| 96 | + corev1.ResourceMemory: defaultMemoryRequest, |
| 97 | + }) |
| 98 | + |
| 99 | + if err != nil { |
| 100 | + return nil, err |
| 101 | + } |
| 102 | + |
| 103 | + return &corev1.ResourceRequirements{ |
| 104 | + Requests: qtys, |
| 105 | + Limits: corev1.ResourceList{}, |
| 106 | + }, nil |
| 107 | +} |
| 108 | + |
| 109 | +// Gets the user-provided resource requirements, if any. |
| 110 | +func (r *resources) getUserProvidedResourceRequirements() (*corev1.ResourceRequirements, error) { |
| 111 | + userProvidedRequests, err := r.getResourceListFromAnnotations(map[corev1.ResourceName]resourceAnnotationKey{ |
| 112 | + corev1.ResourceCPU: cpuResourceRequestAnnotationKey, |
| 113 | + corev1.ResourceMemory: memoryResourceRequestAnnotationKey, |
| 114 | + corev1.ResourceStorage: storageResourceRequestAnnotationKey, |
| 115 | + corev1.ResourceEphemeralStorage: ephemeralStorageResourceRequestAnnotationKey, |
| 116 | + }) |
| 117 | + |
| 118 | + if err != nil { |
| 119 | + return nil, err |
| 120 | + } |
| 121 | + |
| 122 | + userProvidedLimits, err := r.getResourceListFromAnnotations(map[corev1.ResourceName]resourceAnnotationKey{ |
| 123 | + corev1.ResourceCPU: cpuResourceLimitAnnotationKey, |
| 124 | + corev1.ResourceMemory: memoryResourceLimitAnnotationKey, |
| 125 | + corev1.ResourceStorage: storageResourceLimitAnnotationKey, |
| 126 | + corev1.ResourceEphemeralStorage: ephemeralStorageResourceLimitAnnotationKey, |
| 127 | + }) |
| 128 | + |
| 129 | + if err != nil { |
| 130 | + return nil, err |
| 131 | + } |
| 132 | + |
| 133 | + return &corev1.ResourceRequirements{ |
| 134 | + Requests: userProvidedRequests, |
| 135 | + Limits: userProvidedLimits, |
| 136 | + }, nil |
| 137 | +} |
| 138 | + |
| 139 | +// Gets the ResourceList from the MachineOSConfig annotation. |
| 140 | +func (r *resources) getResourceListFromAnnotations(in map[corev1.ResourceName]resourceAnnotationKey) (corev1.ResourceList, error) { |
| 141 | + out := corev1.ResourceList{} |
| 142 | + |
| 143 | + for name, annoKey := range in { |
| 144 | + val, ok := r.mosc.Annotations[string(annoKey)] |
| 145 | + if !ok { |
| 146 | + continue |
| 147 | + } |
| 148 | + |
| 149 | + parsed, err := resource.ParseQuantity(val) |
| 150 | + if err != nil { |
| 151 | + return nil, fmt.Errorf("could not parse resource annotation %q value %q: %w", annoKey, val, err) |
| 152 | + } |
| 153 | + |
| 154 | + out[name] = parsed |
| 155 | + } |
| 156 | + |
| 157 | + return out, nil |
| 158 | +} |
| 159 | + |
| 160 | +// Parses the resource string for each resource name into a resource.Quantity |
| 161 | +// and inserts it into a ResourceList. This is needed because the |
| 162 | +// resource.Quantity values are private. |
| 163 | +func getResourceList(in map[corev1.ResourceName]string) (corev1.ResourceList, error) { |
| 164 | + out := corev1.ResourceList{} |
| 165 | + |
| 166 | + for name, qtyString := range in { |
| 167 | + qty, err := resource.ParseQuantity(qtyString) |
| 168 | + if err != nil { |
| 169 | + return nil, err |
| 170 | + } |
| 171 | + |
| 172 | + out[name] = qty |
| 173 | + } |
| 174 | + |
| 175 | + return out, nil |
| 176 | +} |
0 commit comments