Merge pull request #81 from samuel-esp/upscale-target-only

New Argument: Upscale Target Only

README.md

@@ -376,6 +376,17 @@ annotation `downscaler/uptime` on each deployment
 configured via environment variable `DEFAULT_DOWNTIME` or via the
 annotation `downscaler/downtime` on each deployment
 
+`--upscale-target-only`
+
+: When this optional argument is used, only the namespaces currently 
+ targeted by the downscaler will be upscaled during wake-up times. 
+ For instance, if your downscaler initially manages namespaces 
+ A, B, and C, but is later reconfigured to target only namespaces
+ B and C, namespace A will remain downscaled if it was downscaled
+ at the time of reconfiguration. If the parameter is not used, 
+ all previously downscaled namespaces may be upscaled, even if
+ they are no longer targeted by the downscaler.
+
 `--exclude-namespaces`
 
 : Exclude namespaces from downscaling (list of regex patterns,

kube_downscaler/cmd.py

@@ -44,6 +44,11 @@ def get_parser():
  parser.add_argument(
  "--interval", type=int, help="Loop interval (default: 30s)", default=30
  )
+ parser.add_argument(
+ "--upscale-target-only",
+ help="Upscale only resource in target when waking up namespaces",
+ action="store_true"
+ )
  parser.add_argument(
  "--namespace",
  help="Namespace",

kube_downscaler/main.py

@@ -40,6 +40,7 @@ def main(args=None):
  args.exclude_deployments,
  args.grace_period,
  args.interval,
+ args.upscale_target_only,
  args.dry_run,
  args.downtime_replicas,
  args.deployment_time_annotation,
@@ -61,6 +62,7 @@ def run_loop(
  exclude_deployments,
  grace_period,
  interval,
+ upscale_target_only,
  dry_run,
  downtime_replicas,
  deployment_time_annotation=None,
@@ -75,6 +77,7 @@ def run_loop(
 
  if len(namespaces) >= 1:
  constrained_downscaler = True
+ logging.info("Namespace argument is not empty, the downscaler will run in constrained mode")
  else:
  constrained_downscaler = False
 
@@ -86,6 +89,7 @@ def run_loop(
  downscale_period,
  default_uptime,
  default_downtime,
+ upscale_target_only,
  include_resources=frozenset(include_resources.split(",")),
  exclude_namespaces=frozenset(
  re.compile(pattern) for pattern in exclude_namespaces.split(",")

kube_downscaler/scaler.py

@@ -81,6 +81,18 @@ def parse_time(timestamp: str) -> datetime.datetime:
  f"time data '{timestamp}' does not match any format ({', '.join(TIMESTAMP_FORMATS)})"
  )
 
+
+# If the argument --upscale-target-only is present, resources from namespaces not in target won't be processed.
+# Otherwise all resources from all namespaces will be processed for scaling if the have original_replicas annotation
+def define_scope(exclude, original_replicas, upscale_target_only):
+ if upscale_target_only:
+ exclude_condition = exclude
+ else:
+ exclude_condition = exclude and not original_replicas
+
+ return exclude_condition
+
+
 def is_grace_period_annotation_integer(value):
  try:
  int(value) # Attempt to convert the string to an integer
@@ -834,6 +846,7 @@ def autoscale_resource(
  default_downtime: str,
  forced_uptime: bool,
  forced_downtime: bool,
+ upscale_target_only: bool,
  dry_run: bool,
  now: datetime.datetime,
  grace_period: int = 0,
@@ -858,7 +871,9 @@ def autoscale_resource(
  if downtime_replicas_from_annotation is not None:
  downtime_replicas = downtime_replicas_from_annotation
 
- if exclude:
+ exclude_condition = define_scope(exclude, original_replicas, upscale_target_only)
+
+ if exclude_condition:
  logger.debug(
  f"{resource.kind} {resource.namespace}/{resource.name} was excluded"
  )
@@ -973,6 +988,7 @@ def autoscale_resources(
  default_uptime: str,
  default_downtime: str,
  forced_uptime: bool,
+ upscale_target_only: bool,
  constrained_downscaler: bool,
  dry_run: bool,
  now: datetime.datetime,
@@ -1080,6 +1096,7 @@ def autoscale_resources(
  default_downtime_for_namespace,
  forced_uptime_for_namespace,
  forced_downtime_for_namespace,
+ upscale_target_only,
  dry_run,
  now,
  grace_period,
@@ -1308,6 +1325,7 @@ def scale(
  downscale_period: str,
  default_uptime: str,
  default_downtime: str,
+ upscale_target_only: bool,
  include_resources: FrozenSet[str],
  exclude_namespaces: FrozenSet[Pattern],
  exclude_deployments: FrozenSet[str],
@@ -1341,6 +1359,7 @@ def scale(
  default_uptime,
  default_downtime,
  forced_uptime,
+ upscale_target_only,
  constrained_downscaler,
  dry_run,
  now,