Skip to content

Commit 1cb61b8

Browse files
cgoodfredmaskarb
cgoodfred
and
maskarb
authored
[COST-4572] Add Django management command to cleanup AWS bills and a job for running it in the clowdapp (#4875)
* use cascade_delete to cleanup null payer account bills * change bill cleanup to a management command, add new job in clowdapp for running management commands * cleanup and iterate over dates first then providers * make whole command configurable with a base command of an echo * initialize unleash client --------- Co-authored-by: maskarb <[email protected]>
1 parent 9c2b130 commit 1cb61b8

File tree

3 files changed

+233
-1
lines changed

3 files changed

+233
-1
lines changed

‎deploy/clowdapp.yaml

+62
Original file line numberDiff line numberDiff line change
@@ -4207,6 +4207,29 @@ objects:
42074207
requests:
42084208
cpu: ${KOKU_MIGRATIONS_CPU_REQUEST}
42094209
memory: ${KOKU_MIGRATIONS_MEMORY_REQUEST}
4210+
- name: management-command-cji-${MGMT_IMAGE_TAG}-${MGMT_INVOCATION}
4211+
podSpec:
4212+
args:
4213+
- /bin/bash
4214+
- -c
4215+
- ${MGMT_COMMAND}
4216+
env:
4217+
- name: CLOWDER_ENABLED
4218+
value: ${CLOWDER_ENABLED}
4219+
- name: DEVELOPMENT
4220+
value: ${DEVELOPMENT}
4221+
- name: MGMT_IMAGE
4222+
value: ${MGMT_IMAGE}
4223+
- name: MGMT_IMAGE_TAG
4224+
value: ${MGMT_IMAGE_TAG}
4225+
image: ${MGMT_IMAGE}:${MGMT_IMAGE_TAG}
4226+
resources:
4227+
limits:
4228+
cpu: ${KOKU_MGMT_CPU_LIMIT}
4229+
memory: ${KOKU_MGMT_MEMORY_LIMIT}
4230+
requests:
4231+
cpu: ${KOKU_MGMT_CPU_REQUEST}
4232+
memory: ${KOKU_MGMT_MEMORY_REQUEST}
42104233
kafkaTopics:
42114234
- topicName: platform.sources.event-stream
42124235
- topicName: platform.upload.announce
@@ -4229,6 +4252,14 @@ objects:
42294252
appName: koku
42304253
jobs:
42314254
- db-migrate-cji-${DBM_IMAGE_TAG}-${DBM_INVOCATION}
4255+
- apiVersion: cloud.redhat.com/v1alpha1
4256+
kind: ClowdJobInvocation
4257+
metadata:
4258+
name: management-command-cji-${MGMT_IMAGE_TAG}-${MGMT_INVOCATION}
4259+
spec:
4260+
appName: koku
4261+
jobs:
4262+
- management-command-cji-${MGMT_IMAGE_TAG}-${MGMT_INVOCATION}
42324263
- apiVersion: v1
42334264
data:
42344265
django-secret-key: ${SECRET_KEY}
@@ -4394,6 +4425,37 @@ parameters:
43944425
- name: TENANT_MULTIPROCESSING_CHUNKS
43954426
required: true
43964427
value: "2"
4428+
- description: Management Command Image Tag
4429+
name: MGMT_IMAGE_TAG
4430+
required: true
4431+
value: latest
4432+
- description: Management Command Image
4433+
name: MGMT_IMAGE
4434+
required: true
4435+
value: quay.io/cloudservices/koku
4436+
- description: Management Command Invocation Iterator
4437+
name: MGMT_INVOCATION
4438+
required: true
4439+
value: "00"
4440+
- description: Management Command
4441+
name: MGMT_COMMAND
4442+
value: echo 'No Command to Run'
4443+
- displayName: Memory Request
4444+
name: KOKU_MGMT_MEMORY_REQUEST
4445+
required: true
4446+
value: 20Mi
4447+
- displayName: Memory Limit
4448+
name: KOKU_MGMT_MEMORY_LIMIT
4449+
required: true
4450+
value: 20Mi
4451+
- displayName: CPU Request
4452+
name: KOKU_MGMT_CPU_REQUEST
4453+
required: true
4454+
value: 10m
4455+
- displayName: CPU Limit
4456+
name: KOKU_MGMT_CPU_LIMIT
4457+
required: true
4458+
value: 10m
43974459
- displayName: App domain
43984460
name: APP_DOMAIN
43994461
value: project-koku.com

‎deploy/kustomize/base/base.yaml

+70-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,32 @@ objects:
8989
value: ${TENANT_MULTIPROCESSING_MAX_PROCESSES}
9090
- name: TENANT_MULTIPROCESSING_CHUNKS
9191
value: ${TENANT_MULTIPROCESSING_CHUNKS}
92-
92+
# ====================================================
93+
# koku Management Command Job
94+
# ====================================================
95+
- name: management-command-cji-${MGMT_IMAGE_TAG}-${MGMT_INVOCATION}
96+
podSpec:
97+
image: ${MGMT_IMAGE}:${MGMT_IMAGE_TAG}
98+
resources:
99+
limits:
100+
cpu: ${KOKU_MGMT_CPU_LIMIT}
101+
memory: ${KOKU_MGMT_MEMORY_LIMIT}
102+
requests:
103+
cpu: ${KOKU_MGMT_CPU_REQUEST}
104+
memory: ${KOKU_MGMT_MEMORY_REQUEST}
105+
args:
106+
- /bin/bash
107+
- -c
108+
- ${MGMT_COMMAND}
109+
env:
110+
- name: CLOWDER_ENABLED
111+
value: ${CLOWDER_ENABLED}
112+
- name: DEVELOPMENT
113+
value: ${DEVELOPMENT}
114+
- name: MGMT_IMAGE
115+
value: ${MGMT_IMAGE}
116+
- name: MGMT_IMAGE_TAG
117+
value: ${MGMT_IMAGE_TAG}
93118
# The bulk of your App. This is where your running apps will live
94119
deployments:
95120
-
@@ -106,6 +131,18 @@ objects:
106131
jobs:
107132
- db-migrate-cji-${DBM_IMAGE_TAG}-${DBM_INVOCATION}
108133

134+
# ====================================================
135+
# koku Management CJI
136+
# ====================================================
137+
- apiVersion: cloud.redhat.com/v1alpha1
138+
kind: ClowdJobInvocation
139+
metadata:
140+
name: management-command-cji-${MGMT_IMAGE_TAG}-${MGMT_INVOCATION}
141+
spec:
142+
appName: koku
143+
jobs:
144+
- management-command-cji-${MGMT_IMAGE_TAG}-${MGMT_INVOCATION}
145+
109146
- apiVersion: v1
110147
kind: Secret # For ephemeral/local environment only
111148
metadata:
@@ -279,6 +316,38 @@ parameters:
279316
required: True
280317
value: "2"
281318

319+
- description: Management Command Image Tag
320+
name: MGMT_IMAGE_TAG
321+
required: true
322+
value: latest
323+
- description: Management Command Image
324+
name: MGMT_IMAGE
325+
required: true
326+
value: quay.io/cloudservices/koku
327+
- description: Management Command Invocation Iterator
328+
name: MGMT_INVOCATION
329+
required: true
330+
value: "00"
331+
- description: Management Command
332+
name: MGMT_COMMAND
333+
value: "echo 'No Command to Run'"
334+
- displayName: Memory Request
335+
name: KOKU_MGMT_MEMORY_REQUEST
336+
required: true
337+
value: 20Mi
338+
- displayName: Memory Limit
339+
name: KOKU_MGMT_MEMORY_LIMIT
340+
required: true
341+
value: 20Mi
342+
- displayName: CPU Request
343+
name: KOKU_MGMT_CPU_REQUEST
344+
required: true
345+
value: "10m"
346+
- displayName: CPU Limit
347+
name: KOKU_MGMT_CPU_LIMIT
348+
required: true
349+
value: "10m"
350+
282351
- displayName: App domain
283352
name: APP_DOMAIN
284353
value: project-koku.com

‎koku/masu/management/commands/aws_null_bill_cleanup.py

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
from __future__ import annotations
2+
3+
import argparse
4+
import logging
5+
from datetime import datetime
6+
from typing import Any
7+
8+
from dateutil.relativedelta import relativedelta
9+
from django.conf import settings
10+
from django.core.management.base import BaseCommand
11+
from django_tenants.utils import schema_context
12+
13+
from api.provider.models import Provider
14+
from koku.database import cascade_delete
15+
from koku.feature_flags import UNLEASH_CLIENT
16+
from masu.processor import is_customer_large
17+
from masu.processor.tasks import PRIORITY_QUEUE
18+
from masu.processor.tasks import PRIORITY_QUEUE_XL
19+
from masu.processor.tasks import update_summary_tables
20+
from reporting.models import AWSCostEntryBill
21+
22+
LOG = logging.getLogger(__name__)
23+
DATE_FORMAT = "%Y-%m-%d"
24+
DATETIMES = (
25+
datetime(2024, 1, 1, tzinfo=settings.UTC),
26+
datetime(2023, 12, 1, tzinfo=settings.UTC),
27+
datetime(2023, 11, 1, tzinfo=settings.UTC),
28+
datetime(2023, 10, 1, tzinfo=settings.UTC),
29+
datetime(2023, 9, 1, tzinfo=settings.UTC),
30+
)
31+
32+
33+
class Command(BaseCommand):
34+
help = "Delete AWS Bills and with a NULL payer_account_id and all FK references for a given month."
35+
36+
def add_arguments(self, parser: argparse.ArgumentParser) -> None:
37+
parser.add_argument(
38+
"--delete",
39+
action="store_true",
40+
default=False,
41+
help="Actually delete the cost entry bills.",
42+
)
43+
44+
def handle(self, *args: Any, delete: bool, **kwargs: Any) -> None:
45+
LOG.info("Initializing UNLEASH_CLIENT for bill cleanup.")
46+
UNLEASH_CLIENT.initialize_client()
47+
if delete:
48+
LOG.info(msg="DELETING BILLS (--delete passed)")
49+
else:
50+
LOG.info(msg="In dry run mode (--delete not passed)")
51+
52+
total_cleaned_bills = cleanup_aws_bills(delete)
53+
54+
if delete:
55+
LOG.info(f"{total_cleaned_bills} bills deleted.")
56+
else:
57+
LOG.info(f"DRY RUN: {total_cleaned_bills} bills would be deleted.")
58+
59+
60+
def cleanup_aws_bills(delete: bool) -> int:
61+
"""Deletes AWS Bills with a null payer account ID."""
62+
total_cleaned_bills = 0
63+
providers = Provider.objects.filter(type__in=[Provider.PROVIDER_AWS, Provider.PROVIDER_AWS_LOCAL])
64+
for start_date in DATETIMES:
65+
end_date = start_date + relativedelta(day=31)
66+
67+
for prov in providers:
68+
schema = prov.customer.schema_name
69+
provider_uuid = prov.uuid
70+
71+
with schema_context(schema):
72+
if bills := AWSCostEntryBill.objects.filter(
73+
provider_id=provider_uuid,
74+
payer_account_id=None,
75+
billing_period_start=start_date,
76+
):
77+
queue_name = PRIORITY_QUEUE_XL if is_customer_large(schema) else PRIORITY_QUEUE
78+
total_cleaned_bills += len(bills)
79+
if delete:
80+
formatted_start = start_date.strftime(DATE_FORMAT)
81+
formatted_end = end_date.strftime(DATE_FORMAT)
82+
cascade_delete(bills.query.model, bills)
83+
async_result = update_summary_tables.s(
84+
schema,
85+
prov.type,
86+
provider_uuid,
87+
formatted_start,
88+
end_date=formatted_end,
89+
queue_name=queue_name,
90+
ocp_on_cloud=True,
91+
).apply_async(queue=queue_name)
92+
LOG.info(
93+
f"Deletes completed and summary triggered for provider {provider_uuid} "
94+
f"with start {formatted_start} and end {formatted_end}, task_id: {async_result.id}"
95+
)
96+
97+
else:
98+
bill_ids = [bill.id for bill in bills]
99+
LOG.info(f"bills {bill_ids} would be deleted for provider: {provider_uuid}")
100+
101+
return total_cleaned_bills

0 commit comments

Comments
 (0)