Skip to content

feat: add batch size option to certificate retirement API call #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Akanshu-2u merged 2 commits into from
May 14, 2026
+10 −5
Merged

feat: add batch size option to certificate retirement API call #341

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a006ff3
feat: add batch size option to certificate retirement API call
ttak-apphelix May 14, 2026
944f28a
fix: update batch size validation and dry-run option type in certific…
ttak-apphelix May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions util/jenkins/retired_user_cert_remover/retired_user_cert_remover.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def _request():
sys.exit(1)


def call_retire_certs_api(lms_host, token, dry_run):
def call_retire_certs_api(lms_host, token, dry_run, batch_size=0):
"""
Call POST /api/certificates/v1/retire_certs_s3 on the LMS.

Expand All @@ -88,7 +88,11 @@ def call_retire_certs_api(lms_host, token, dry_run):
Exits with code 2 if the call returns 207 (partial failure).
"""
url = f'{lms_host.rstrip("/")}/api/certificates/v1/retire_certs_s3'
params = {'dry_run': 'true'} if dry_run else {}
params = {}
if dry_run:
params['dry_run'] = 'true'
if batch_size > 0:
params['batch_size'] = batch_size
headers = {'Authorization': f'JWT {token}', 'Content-Type': 'application/json'}

@backoff.on_exception(backoff.expo, requests.RequestException, max_tries=MAX_API_ATTEMPTS)
Expand Down Expand Up @@ -134,10 +138,11 @@ def _request():
@click.option('--lms-host', required=True, help='Base URL of the LMS (e.g. https://lms.edx.org)')
@click.option('--client-id', envvar='LMS_CLIENT_ID', required=True, help='OAuth DOT client id')
@click.option('--client-secret', envvar='LMS_CLIENT_SECRET', required=True, help='OAuth DOT client secret')
@click.option('--dry-run', is_flag=True, help='Run in dry-run mode without making any changes')
def controller(lms_host, client_id, client_secret, dry_run):
@click.option('--dry-run', default=True, type=click.BOOL, help='Run in dry-run mode without making any changes (true/false)')
@click.option('--batch-size', default=0, type=int, help='Max certificates to process per run (0 = no limit)')
def controller(lms_host, client_id, client_secret, dry_run, batch_size):
jwt_token = get_jwt_token(lms_host, client_id, client_secret)
call_retire_certs_api(lms_host, jwt_token, dry_run)
call_retire_certs_api(lms_host, jwt_token, dry_run, batch_size)


if __name__ == '__main__':
Expand Down
Loading