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
|
package kubernetes
import (
"fmt"
"regexp"
"strings"
api "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
"gitlab.com/gitlab-org/gitlab-runner/common"
)
const (
// NamespaceOverwriteVariableName is the key for the JobVariable containing user overwritten Namespace
NamespaceOverwriteVariableName = "KUBERNETES_NAMESPACE_OVERWRITE"
// ServiceAccountOverwriteVariableName is the key for the JobVariable containing user overwritten ServiceAccount
ServiceAccountOverwriteVariableName = "KUBERNETES_SERVICE_ACCOUNT_OVERWRITE"
// BearerTokenOverwriteVariableValue is the key for the JobVariable containing user overwritten BearerToken
BearerTokenOverwriteVariableValue = "KUBERNETES_BEARER_TOKEN"
// PodAnnotationsOverwriteVariablePrefix is the prefix for all the JobVariable keys containing
// user overwritten PodAnnotations
PodAnnotationsOverwriteVariablePrefix = "KUBERNETES_POD_ANNOTATIONS_"
// CPULimitOverwriteVariableValue is the key for the JobVariable containing user overwritten cpu limit
CPULimitOverwriteVariableValue = "KUBERNETES_CPU_LIMIT"
// CPURequestOverwriteVariableValue is the key for the JobVariable containing user overwritten cpu limit
CPURequestOverwriteVariableValue = "KUBERNETES_CPU_REQUEST"
// MemoryLimitOverwriteVariableValue is the key for the JobVariable containing user overwritten memory limit
MemoryLimitOverwriteVariableValue = "KUBERNETES_MEMORY_LIMIT"
// MemoryRequestOverwriteVariableValue is the key for the JobVariable containing user overwritten memory limit
MemoryRequestOverwriteVariableValue = "KUBERNETES_MEMORY_REQUEST"
// EphemeralStorageLimitOverwriteVariableValue is the key for the JobVariable containing user overwritten
// ephemeral storage limit
EphemeralStorageLimitOverwriteVariableValue = "KUBERNETES_EPHEMERAL_STORAGE_LIMIT"
// EphemeralStorageRequestOverwriteVariableValue is the key for the JobVariable containing user overwritten
// ephemeral storage limit
EphemeralStorageRequestOverwriteVariableValue = "KUBERNETES_EPHEMERAL_STORAGE_REQUEST"
// ServiceCPULimitOverwriteVariableValue is the key for the JobVariable containing user overwritten service cpu
// limit
ServiceCPULimitOverwriteVariableValue = "KUBERNETES_SERVICE_CPU_LIMIT"
// ServiceCPURequestOverwriteVariableValue is the key for the JobVariable containing user overwritten service cpu
// limit
ServiceCPURequestOverwriteVariableValue = "KUBERNETES_SERVICE_CPU_REQUEST"
// ServiceMemoryLimitOverwriteVariableValue is the key for the JobVariable containing user overwritten service
// memory limit
ServiceMemoryLimitOverwriteVariableValue = "KUBERNETES_SERVICE_MEMORY_LIMIT"
// ServiceMemoryRequestOverwriteVariableValue is the key for the JobVariable containing user overwritten service
// memory limit
ServiceMemoryRequestOverwriteVariableValue = "KUBERNETES_SERVICE_MEMORY_REQUEST"
// ServiceEphemeralStorageLimitOverwriteVariableValue is the key for the JobVariable containing user overwritten
// service ephemeral storage
ServiceEphemeralStorageLimitOverwriteVariableValue = "KUBERNETES_SERVICE_EPHEMERAL_STORAGE_LIMIT"
// ServiceEphemeralStorageRequestOverwriteVariableValue is the key for the JobVariable containing user overwritten
// service ephemeral storage
ServiceEphemeralStorageRequestOverwriteVariableValue = "KUBERNETES_SERVICE_EPHEMERAL_STORAGE_REQUEST"
// HelperCPULimitOverwriteVariableValue is the key for the JobVariable containing user overwritten helper cpu limit
HelperCPULimitOverwriteVariableValue = "KUBERNETES_HELPER_CPU_LIMIT"
// HelperCPURequestOverwriteVariableValue is the key for the JobVariable containing user overwritten helper cpu
// limit
HelperCPURequestOverwriteVariableValue = "KUBERNETES_HELPER_CPU_REQUEST"
// HelperMemoryLimitOverwriteVariableValue is the key for the JobVariable containing user overwritten helper memory
// limit
HelperMemoryLimitOverwriteVariableValue = "KUBERNETES_HELPER_MEMORY_LIMIT"
// HelperMemoryRequestOverwriteVariableValue is the key for the JobVariable containing user overwritten helper
// memory limit
HelperEphemeralStorageRequestOverwriteVariableValue = "KUBERNETES_HELPER_EPHEMERAL_STORAGE_REQUEST"
// HelperEphemeralStorageLimitOverwriteVariableValue is the key for the JobVariable containing user overwritten
// helper ephemeral storage
HelperEphemeralStorageLimitOverwriteVariableValue = "KUBERNETES_HELPER_EPHEMERAL_STORAGE_LIMIT"
// HelperEphemeralStorageRequestOverwriteVariableValue is the key for the JobVariable containing user overwritten
// ephemeral storage
HelperMemoryRequestOverwriteVariableValue = "KUBERNETES_HELPER_MEMORY_REQUEST"
)
type overwriteTooHighError struct {
resource string
max string
overwrite string
}
func (o *overwriteTooHighError) Error() string {
return fmt.Sprintf("the resource %q requested %q is higher than limit allowed %q", o.resource, o.overwrite, o.max)
}
func (o *overwriteTooHighError) Is(err error) bool {
_, ok := err.(*overwriteTooHighError)
return ok
}
type malformedOverwriteError struct {
value string
pattern string
}
func (m *malformedOverwriteError) Error() string {
return fmt.Sprintf("provided value %q does not match %q", m.value, m.pattern)
}
func (m *malformedOverwriteError) Is(err error) bool {
_, ok := err.(*malformedOverwriteError)
return ok
}
type overwrites struct {
namespace string
serviceAccount string
bearerToken string
podAnnotations map[string]string
buildLimits api.ResourceList
serviceLimits api.ResourceList
helperLimits api.ResourceList
buildRequests api.ResourceList
serviceRequests api.ResourceList
helperRequests api.ResourceList
}
//nolint:funlen
func createOverwrites(
config *common.KubernetesConfig,
variables common.JobVariables,
logger common.BuildLogger,
) (*overwrites, error) {
var err error
o := &overwrites{}
variables = variables.Expand()
namespaceOverwrite := variables.Get(NamespaceOverwriteVariableName)
o.namespace, err = o.evaluateOverwrite(
"Namespace",
config.Namespace,
config.NamespaceOverwriteAllowed,
namespaceOverwrite,
logger,
)
if err != nil {
return nil, err
}
serviceAccountOverwrite := variables.Get(ServiceAccountOverwriteVariableName)
o.serviceAccount, err = o.evaluateOverwrite(
"ServiceAccount",
config.ServiceAccount,
config.ServiceAccountOverwriteAllowed,
serviceAccountOverwrite,
logger,
)
if err != nil {
return nil, err
}
bearerTokenOverwrite := variables.Get(BearerTokenOverwriteVariableValue)
o.bearerToken, err = o.evaluateBoolControlledOverwrite(
"BearerToken",
config.BearerToken,
config.BearerTokenOverwriteAllowed,
bearerTokenOverwrite,
logger,
)
if err != nil {
return nil, err
}
o.podAnnotations, err = o.evaluateMapOverwrite(
"PodAnnotations",
config.PodAnnotations,
config.PodAnnotationsOverwriteAllowed,
variables,
PodAnnotationsOverwriteVariablePrefix,
logger,
)
if err != nil {
return nil, err
}
err = o.evaluateMaxBuildResourcesOverwrite(config, variables, logger)
if err != nil {
return nil, err
}
err = o.evaluateMaxServiceResourcesOverwrite(config, variables, logger)
if err != nil {
return nil, err
}
err = o.evaluateMaxHelperResourcesOverwrite(config, variables, logger)
if err != nil {
return nil, err
}
return o, nil
}
func (o *overwrites) evaluateMaxBuildResourcesOverwrite(
config *common.KubernetesConfig,
variables common.JobVariables,
logger common.BuildLogger,
) (err error) {
o.buildRequests, err = o.evaluateMaxResourceListOverwrite(
"CPURequest",
"MemoryRequest",
"EphemeralStorageRequest",
config.CPURequest,
config.MemoryRequest,
config.EphemeralStorageRequest,
config.CPURequestOverwriteMaxAllowed,
config.MemoryRequestOverwriteMaxAllowed,
config.EphemeralStorageRequestOverwriteMaxAllowed,
variables.Get(CPURequestOverwriteVariableValue),
variables.Get(MemoryRequestOverwriteVariableValue),
variables.Get(EphemeralStorageRequestOverwriteVariableValue),
logger,
)
if err != nil {
return fmt.Errorf("invalid build requests specified: %w", err)
}
o.buildLimits, err = o.evaluateMaxResourceListOverwrite(
"CPULimit",
"MemoryLimit",
"EphemeralStorageLimit",
config.CPULimit,
config.MemoryLimit,
config.EphemeralStorageLimit,
config.CPULimitOverwriteMaxAllowed,
config.MemoryLimitOverwriteMaxAllowed,
config.EphemeralStorageLimitOverwriteMaxAllowed,
variables.Get(CPULimitOverwriteVariableValue),
variables.Get(MemoryLimitOverwriteVariableValue),
variables.Get(EphemeralStorageLimitOverwriteVariableValue),
logger,
)
if err != nil {
return fmt.Errorf("invalid build limits specified: %w", err)
}
return nil
}
func (o *overwrites) evaluateMaxServiceResourcesOverwrite(
config *common.KubernetesConfig,
variables common.JobVariables,
logger common.BuildLogger,
) (err error) {
o.serviceRequests, err = o.evaluateMaxResourceListOverwrite(
"ServiceCPURequest",
"ServiceMemoryRequest",
"ServiceEphemeralStorageRequest",
config.ServiceCPURequest,
config.ServiceMemoryRequest,
config.ServiceEphemeralStorageRequest,
config.ServiceCPURequestOverwriteMaxAllowed,
config.ServiceMemoryRequestOverwriteMaxAllowed,
config.ServiceEphemeralStorageRequestOverwriteMaxAllowed,
variables.Get(ServiceCPURequestOverwriteVariableValue),
variables.Get(ServiceMemoryRequestOverwriteVariableValue),
variables.Get(ServiceEphemeralStorageRequestOverwriteVariableValue),
logger,
)
if err != nil {
return fmt.Errorf("invalid service requests specified: %w", err)
}
o.serviceLimits, err = o.evaluateMaxResourceListOverwrite(
"ServiceCPULimit",
"ServiceMemoryLimit",
"ServiceEphemeralStorageLimit",
config.ServiceCPULimit,
config.ServiceMemoryLimit,
config.ServiceEphemeralStorageLimit,
config.ServiceCPULimitOverwriteMaxAllowed,
config.ServiceMemoryLimitOverwriteMaxAllowed,
config.ServiceEphemeralStorageLimitOverwriteMaxAllowed,
variables.Get(ServiceCPULimitOverwriteVariableValue),
variables.Get(ServiceMemoryLimitOverwriteVariableValue),
variables.Get(ServiceEphemeralStorageLimitOverwriteVariableValue),
logger,
)
if err != nil {
return fmt.Errorf("invalid service limits specified: %w", err)
}
return nil
}
func (o *overwrites) evaluateMaxHelperResourcesOverwrite(
config *common.KubernetesConfig,
variables common.JobVariables,
logger common.BuildLogger,
) (err error) {
o.helperRequests, err = o.evaluateMaxResourceListOverwrite(
"HelperCPURequest",
"HelperMemoryRequest",
"HelperEphemeralStorageRequest",
config.HelperCPURequest,
config.HelperMemoryRequest,
config.HelperEphemeralStorageRequest,
config.HelperCPURequestOverwriteMaxAllowed,
config.HelperMemoryRequestOverwriteMaxAllowed,
config.HelperEphemeralStorageRequestOverwriteMaxAllowed,
variables.Get(HelperCPURequestOverwriteVariableValue),
variables.Get(HelperMemoryRequestOverwriteVariableValue),
variables.Get(HelperEphemeralStorageRequestOverwriteVariableValue),
logger,
)
if err != nil {
return fmt.Errorf("invalid helper requests specified: %w", err)
}
o.helperLimits, err = o.evaluateMaxResourceListOverwrite(
"HelperCPULimit",
"HelperMemoryLimit",
"HelperEphemeralStorageLimit",
config.HelperCPULimit,
config.HelperMemoryLimit,
config.HelperEphemeralStorageLimit,
config.HelperCPULimitOverwriteMaxAllowed,
config.HelperMemoryLimitOverwriteMaxAllowed,
config.HelperEphemeralStorageLimitOverwriteMaxAllowed,
variables.Get(HelperCPULimitOverwriteVariableValue),
variables.Get(HelperMemoryLimitOverwriteVariableValue),
variables.Get(HelperEphemeralStorageLimitOverwriteVariableValue),
logger,
)
if err != nil {
return fmt.Errorf("invalid helper limits specified: %w", err)
}
return nil
}
func (o *overwrites) evaluateBoolControlledOverwrite(
fieldName, value string,
canOverride bool,
overwriteValue string,
logger common.BuildLogger,
) (string, error) {
if canOverride {
return o.evaluateOverwrite(fieldName, value, ".+", overwriteValue, logger)
}
return o.evaluateOverwrite(fieldName, value, "", overwriteValue, logger)
}
func (o *overwrites) evaluateOverwrite(
fieldName, value, regex, overwriteValue string,
logger common.BuildLogger,
) (string, error) {
if regex == "" {
logger.Debugln("Regex allowing overrides for", fieldName, "is empty, disabling override.")
return value, nil
}
if overwriteValue == "" {
return value, nil
}
if err := overwriteRegexCheck(regex, overwriteValue); err != nil {
return value, err
}
logValue := overwriteValue
if fieldName == "BearerToken" {
logValue = "XXXXXXXX..."
}
logger.Println(fmt.Sprintf("%q overwritten with %q", fieldName, logValue))
return overwriteValue, nil
}
func overwriteRegexCheck(regex, value string) error {
var err error
var r *regexp.Regexp
if r, err = regexp.Compile(regex); err != nil {
return err
}
if match := r.MatchString(value); !match {
return &malformedOverwriteError{value: value, pattern: regex}
}
return nil
}
// splitMapOverwrite splits provided string on the first "=" and returns (key, value, nil).
// If the argument cannot be split an error is returned
func splitMapOverwrite(str string) (string, string, error) {
if split := strings.SplitN(str, "=", 2); len(split) > 1 {
return split[0], split[1], nil
}
return "", "", &malformedOverwriteError{value: str, pattern: "k=v"}
}
func (o *overwrites) evaluateMapOverwrite(
fieldName string,
values map[string]string,
regex string,
variables common.JobVariables,
variablesSelector string,
logger common.BuildLogger,
) (map[string]string, error) {
if regex == "" {
logger.Debugln("Regex allowing overrides for", fieldName, "is empty, disabling override.")
return values, nil
}
finalValues := make(map[string]string)
for k, v := range values {
finalValues[k] = v
}
for _, variable := range variables {
if !strings.HasPrefix(variable.Key, variablesSelector) {
continue
}
if err := overwriteRegexCheck(regex, variable.Value); err != nil {
return nil, err
}
key, value, err := splitMapOverwrite(variable.Value)
if err != nil {
return nil, err
}
finalValues[key] = value
logger.Println(fmt.Sprintf("%q %q overwritten with %q", fieldName, key, value))
}
return finalValues, nil
}
func (o *overwrites) evaluateMaxResourceListOverwrite(
cpuFieldName,
memoryFieldName,
ephemeralStorageFieldName,
currentCPU,
currentMemory,
currentEphemeralStorage,
maxCPU,
maxMemory,
maxEphemeralStorage,
overwriteCPU,
overwriteMemory string,
overwriteEphemeralStorage string,
logger common.BuildLogger,
) (api.ResourceList, error) {
cpu, err := o.evaluateMaxResourceOverwrite(cpuFieldName, currentCPU, maxCPU, overwriteCPU, logger)
if err != nil {
return nil, err
}
memory, err := o.evaluateMaxResourceOverwrite(memoryFieldName, currentMemory, maxMemory, overwriteMemory, logger)
if err != nil {
return nil, err
}
ephemeralStorage, err := o.evaluateMaxResourceOverwrite(
ephemeralStorageFieldName,
currentEphemeralStorage,
maxEphemeralStorage,
overwriteEphemeralStorage,
logger,
)
if err != nil {
return nil, err
}
return createResourceList(cpu, memory, ephemeralStorage)
}
func (o *overwrites) evaluateMaxResourceOverwrite(
fieldName,
value,
maxResource,
overwriteValue string,
logger common.BuildLogger,
) (string, error) {
if maxResource == "" {
logger.Debugln("setting allowing overrides for", fieldName, "is empty, disabling override.")
return value, nil
}
if overwriteValue == "" {
return value, nil
}
var rMaxResource, rOverwriteValue resource.Quantity
var err error
if rMaxResource, err = resource.ParseQuantity(maxResource); err != nil {
return value, fmt.Errorf("parsing resource limit: %q", err.Error())
}
if rOverwriteValue, err = resource.ParseQuantity(overwriteValue); err != nil {
return value, fmt.Errorf("parsing resource limit: %q", err.Error())
}
cmp := rOverwriteValue.Cmp(rMaxResource)
if cmp == 1 {
return "", &overwriteTooHighError{
resource: fieldName,
max: maxResource,
overwrite: overwriteValue,
}
}
logger.Println(fmt.Sprintf("%q overwritten with %q", fieldName, overwriteValue))
return overwriteValue, nil
}
|