LFX mentorship (2025/Term-1): Enhancing CI/CD Integration for LitmusChaos - SDK Development and Chaos-CI-Lib Revamp

[S-ayanide]

Description

This project aims to improve the CI/CD experience for LitmusChaos by developing a dedicated SDK that integrates seamlessly with existing CI libraries. The revamped Chaos CI Library will align with Litmus 3.x, eliminating outdated installation steps and enabling direct invocation of prebuilt chaos experiments. Additionally, CI action templates will be refined to optimize tunables, ensuring a smoother and more efficient workflow for users leveraging GitHub and GitLab pipelines.

Prerequisites (preferred but not mandatory):

• Experience with LitmusChaos and its CI/CD workflows.
• Familiarity with GitHub Actions and GitLab CI/CD.
• Knowledge of SDK development and API integrations.
• Experience with Go and Kubernetes Operator Patterns.

Schedule: 3rd March, 2025 - 30th May, 2025

Previous Works & References:

• Chaos CI Library Repository: litmuschaos/chaos-ci-lib
• GitHub Chaos Actions Repository: litmuschaos/github-chaos-actions
• GitLab Remote Template Repository: litmuschaos/gitlab-remote-template

What You Will Do:

1. Develop the Chaos CI SDK

• Create an SDK to be used with the Chaos CI Library, supporting integration with Terraform.
• Implement authentication and experiment execution APIs in the SDK.
• Ensure compatibility with LitmusChaos 3.x for seamless execution of chaos tests.

2. Revamp Chaos CI Library

• Modify the existing Chaos CI Library to remove installation steps used in 1.x.
• Enable direct invocation of prebuilt experiments instead of traditional installation flows.
• Utilize the new SDK image for chaos execution in CI pipelines.

3. Update CI Action Templates & Parameters

• Adjust GitHub Chaos Action and GitLab Remote Template to align with the new CI SDK.
• Optimize tunable parameters in CI templates to improve flexibility and usability.

Mentors

• @ispeakc0de
• @Jonsy13

This task is ideal for those interested in enhancing DevOps workflows, improving cloud-native CI/CD resilience, and contributing to LitmusChaos’s automation ecosystem.

[Mayank77maruti]

Hey @S-ayanide I want to work on this issue.
I am well versed with CI/CD pipelines(I am working on CI/CD piplines of oppia.org) and would love to help, if this issue is open.

[shashank666]

Hi @S-ayanide ,

I’m really interested in this project and would love to contribute. I have experience with Go, Kubernetes, and CI/CD automation, along with working on SDK development and API integrations. I’ve previously worked on improving DevOps workflows and integrating Terraform with cloud deployments, which aligns well with the goals of this project.

I’d like to help in:

Developing the Chaos CI SDK, ensuring seamless execution of chaos tests in LitmusChaos 3.x.
Enhancing the Chaos CI Library by removing outdated installation steps and enabling direct experiment execution.
Refining GitHub & GitLab CI templates to optimize parameters for better flexibility.

Looking forward to contributing and learning from the community!

[SkySingh04]

Hey @S-ayanide , This is Sky here. I have worked with Keploy for my GSOC 2024 and have been working with CICD pipelines and GOlang for over a year now.

This sounds like an amazing and interesting project, looking forward to building this!

[PranjaliBhardwaj]

Hi @S-ayanide
I'm really excited about this initiative to enhance the CI/CD experience for LitmusChaos! I have experience working with, CI/CD pipelines GitLab CI/CD; Additionally, I'm proficient in Go, Kubernetes Operator Patterns, and API integrations, which align well with the project's requirements.

I’d love to contribute into this project with everyone!

[dikshant182004]

hi @@ispeakc0de ,
this link -> https://github.com/litmuschaos/gitlab-remote-template
is not working properly . can u provide us the different one .

[Jonsy13]

Hi @dikshant182004 Thanks for let us know, Here is the updated link - https://github.com/litmuschaos/gitlab-remote-templates

[harshsennnn]

Hey @Jonsy13 When modifying the chaos-ci-lib to eliminate the 1.x installation steps, should we aim for backward compatibility, or can we exclusively optimize for LitmusChaos 3.x and prebuilt experiments