GSoC 2023 Final Evaluation Report

report.md

GSoC 2023: Making Teuthology Friendly

Personal Information

• Name: Devansh Singh
• Email: devanshamity@gmail.com
• GitHub: @Devansh3712
• University: Jaypee Institute of Information Technology, India

Project Information

• Organization: Ceph
• Mentors: Aishwarya Mathuria, Zack Cerza, Kamoltat Sirivadhna
• Repositories:
  • pulpito-ng
  • teuthology-api

Summary

Teuthology is the automation framework for Ceph, it remotely orchestrates operations on remote hosts over SSH. Pulpito is a dashboard for monitoring the Teuthology test infrastructure, which includes the test runs, queues and available nodes.

In this project, we aimed to create a new version of Pulpito which includes an user interface for scheduling and killing job(s) using an API for Teuthology. Following are the main features on which we worked during this period:

• GitHub User Authentication
  • A Ceph developer must be authenticated in order to schedule or kill jobs.
• Scheduling Jobs
  • Schedule a Teuthology job run
• Killing Jobs
  • Kill a whole run
• Teuthology API Documentation
  • Document the endpoints of the Teuthology API using FastAPI swagger UI

Contributions

We worked on developing a new user interface for Pulpito using React. The project is containerized using Docker along with other dependencies such as Teuthology API and Paddles (REST API to store and report back on Ceph test results).

Code in Review

• ceph/pulpito-ng#51
  • Implement a button for killing all jobs in a run
• ceph/teuthology-api#16
  • Update deprecated .dict() to .model_dump() for pydantic's BaseModel class
• ceph/teuthology-api#17
  • Write documentation for API endpoints and example response body for pydantic schemas

Merged Code

• ceph/pulpito-ng#50
  • Add a check to validate the start time of a run
• ceph/teuthology-api#11
  • Create a CI to check whether a commit was signed or not
• ceph/pulpito-ng#35
  • Add VITE_ prefix to all environment variables
• ceph/teuthology-api#4
  • Update from pydantic to pydantic-settings for config file
• ceph/pulpito-ng#20
  • Update the favicon to the old Pulpito icon
• ceph/pulpito-ng#15
  • Change date formatting

Future Work

A Paddles rewrite using FastAPI, as the current framework it uses (pecan) is no longer maintained. Other than that, work on the UI and UX of pulpito-ng and add more user-centered features. Working on the teuthology-api and pulpito-ng was amazing, and I will keep contributing to the projects.

Acknowledgements

I want like to express my gratitude to Google, the Ceph community and my mentors for giving me the opportunity to work on this project. The mentors helped me throughout the coding period, and solved any doubts that I had. They were very supportive till the end, I really appreciate them for the same and would love to work with them again.