Participation of Microcks in LFX mentorship Term 01 - 2025 March - May

[Harsh4902]

Hello Microcks team!

As a part of CNCF, Microcks can take part in LFX mentorship program. Proposal submissions for organizations has been started, so we should start discussion on possible project ideas which can take part in this term.

Mentorship Details

• For the organizations, project submission time (as of now) is 8th January 2025 - 4th February 2025
• Other than that, all other necessary timelines are given here.
• To take part in this program, we have to submit our proposal by raising a PR to CNCF Mentoring Project Ideas. The template for the PR is here.

[yada]

Hi @Harsh4902,
Thank you for opening this discussion as agreed during the latest community meeting (ref: https://www.youtube.com/live/KXfyuIR2WAs?si=SLELWwqAgz8iRCaD&t=827).

Let's brainstorm here and see who would like to participate in this activity.
We all think it is an important and very valuable initiative 🙌

[Harsh4902]

Project Idea 1 : Improving Microcks CLI or creating some microcks utility likemksctl

• As we already have a command line tool for microcks, we can integrate some CLI framework like Cobra CLI to improve our CLI tool.
• @JulienBreux have started some work on creating a utility tool called mksctl here, so we can take it further.

I think @JulienBreux can provide more guidance on this, @lbroudoux and @yada please provide your suggestions.

[lbroudoux]

The base of mksctl has also been reversed into the 1.x branch of the microcks-cli repo here

To me, the main goals of a new CLI version are:

• Provide the same interface for exiting test and import commands
• Provide a way to easily install this tool via integration with packet manager (brew, apt or others)
• Allow developers to easily start new Microcks instances with mksctl start and mksctl stop for example
• Allow to quickly add new commands like import from url, or import all the files from a directory, create job, list jobs and so on...

Moving to standard tools like Cobra CLI is a way to make it more scalable for people to contribute to it and add the features they want.

[ashish111333]

@lbroudoux Would like to work on this, I previously used cobra to create clis for cyclops, now I am involved in mesheryctl for meshery project.

[lbroudoux]

Project Idea 2 : Contribute to Microcks UI refactoring

• As introduced by this discussion we have troubles with the current frontend stack used by Microcks
• We started a POC on re-implementing it using Svelte Kit and like to get some insights from this experience
• We're looking for talented people regarding UI design dans frontend and would be happy to help them contributing

[DeshDeepakKant]

I am eager to contribute to the this project. This initiative aligns perfectly with my skillset and interests, particularly in frontend development and UI design. I have experience with JavaScript frameworks and tools and am excited about working with Svelte Kit to address the current frontend challenges.

Please let me know how I can get started and if there are any specific guidelines or resources I should refer to.

[yada]

This project has been started, and we are unsure if it will be relevant (as it is already in progress) for LFX mentorship or GSoC: TBD.
But contributions are welcome, @DeshDeepakKant, please join the conversation here: https://github.com/orgs/microcks/discussions/1458

[DeshDeepakKant]

Thank you for the update, @yada! I’ve joined the discussion and am eager to contribute.

As I plan to participate in the LFX Mentorship Program this time, could you please share the list of projects the Microcks community is considering for it? I’d love to explore and contribute to a suitable project.

[Harsh4902]

@DeshDeepakKant Thank you for your interest. Still, we are discussing the potential project ideas, so you can keep eyes on this discussion.

[lbroudoux]

Hey @DeshDeepakKant
I think this topic has already started and is maybe too advanced (in the sense of progress not skills) for the mentorship program... But we can still redefine some scoped parts! Feel free to jump into the discussion #1458 and have a look at the PoC we started.

[lbroudoux]

Project Idea 3 : Update the Microcks Hub frontend and make it deployable on-premises

• Microcks Hub is a community driven Hub to aggregate standards or product-related API mocks and test suites.
• It was created a long time ago with a technology stack we should refresh (Angular 8 at the moment). We're looking for talented people regarding UI design dans frontend and would be happy to help them contributing
• It was designed at first to be only deployable in a single public instance but there are requests to make it deployable on-premises. We're looking for contribution on this part - helping in development of Docker Compose files, Kubernetes Helm Charts or whatever make sense.
• The code base is hosted on https://github.com/microcks/hub.microcks.io

[PranjaliBhardwaj]

Hi @yada @lbroudoux ,
I would like to work on this project as I have great experience in frontend development with several internships, also I have knowledge of designing, frontend development react & angular and with cloud-docker & Kubernetes . I also have ideas for Microcks readme and familiar with its blogs and docs. I would love to work with Microcks team through LFX!
I am in connected in community through discord and linkedin.

[yada]

Project Idea 4 : Microcks Hub: Expanding Sandbox and Mocking Capabilities for Key Industry APIs

This project aims to enhance the Microcks Hub by updating the existing sandbox environment or adding new hub entries to mock key APIs IT industry leaders use. The goal is to make it easier for developers to test and prototype integrations with popular APIs like GitHub, Twilio, Stripe, or Salesforce using Microcks.

Participants can choose to focus on one or both of the following aspects:

1. Update and Refresh the Existing Sandbox:

• Improve the sandbox environment provided by Microcks Hub for existing mock APIs.
• Ensure compliance with the latest versions of existing APIs.
• Enhance documentation, usability, and deployment mechanisms.

2. Add New Hub Entries for Key Industry APIs:

• Develop mock entries for leading APIs like GitHub, Twilio, Stripe, or Salesforce, but we welcome any ideas...
• Ensure the mocks cover essential endpoints and realistic request-response pairs.
• Provide detailed examples and use cases to support integration testing.

PS: BTW, maybe we can also submit the same topics to GSoC 2025 👉 Application period: January 27 – Feb 11

[yada]

Project Idea 2: Contribute to Microcks UI refactoring: TBD, as it may be too late (already engaged).

We’ve gathered new ideas and identified needs based on community feedback and recent issues.
See new project ideas in this thread 👇

[yada]

Project Idea 5 : Expanding Microcks community documentation for advanced installations

Microcks depends on community contributions to address installation, setup, and infrastructure maintenance topics that fall outside the scope of the core project. This project aims to enhance the Microcks Community Repository by providing detailed guides to help users with advanced and production-grade setups.

Examples (Feel free to share any setup ideas or configurations you use and would like to contribute to the list):

• Documenting how to secure mock endpoints using authentication mechanisms (e.g., OAuth, API keys), see: APIs and their respective documentation are publicly accessible without the need for authentication #1471
• Providing architectural guidelines and resource sizing strategies for Kubernetes deployments to manage diverse workloads.
• Explaining the integration of external services like Keycloak and MongoDB using custom Helm charts or operators.
• Offering step-by-step instructions to configure Microcks with corporate IDPs or SSO systems as alternatives to Keycloak.

This project will empower the community with practical and actionable knowledge for deploying and managing Microcks in complex environments, ensuring accessibility and scalability for diverse use cases.

[lbroudoux]

IMHO the project here is not to create the documentation but rather to define the framework for:

• Fostering community members to share their technical knowledge on those topics,
• Making contributions easy and straightforward - easily gathering this knowledge
• Promoting contributed content with new access from the documentation, improved integration with our social communications, etc...

The Project Idea 7 is dedicated to the production of documentation content for standard Cloud Providers options.

[yada]

Project Idea 6 : Improving Microcks delivery and validation with GitHub Actions CI deployment tests

This project focuses on enhancing the reliability and quality of Microcks releases by introducing comprehensive CI deployment tests and validations using GitHub Actions. While the project already includes unit and integration tests, recent issues (ex: #1470 and https://bugs.openjdk.org/browse/JDK-8345296) with dependencies have underscored the need for end-to-end validation to ensure new integrations do not introduce bugs or regressions.

Participants will develop workflows for building and deploying Microcks and running automated tests to confirm its functionality under real-world scenarios. This will help prevent edge cases and dependency-related issues affecting the Microcks community and adopters.

This project improves the delivery process to ensure that Microcks releases meet the community's expectations for quality and reliability.

[lbroudoux]

Workflows encompass a bunch of deployment tests:

• Testing of container images (with docker, with podman, on different architectures, ...)
• Testing of common docker-compose configurations
• Testing of Helm chart with different setup options
• ...

[yada]

Project Idea 7 : Building Community-Driven documentation for deploying Microcks in cloud production environments

This project aims to support the growing Microcks adopter community by fostering a collaborative effort to document production-grade deployment strategies for cloud environments. While the core Microcks maintainers focus on features, security, and enhancements, the adopters are responsible for production setups. However, a shared repository of best practices can help users learn from one another in a true open-source spirit.

Participants will contribute to the Microcks community repository by documenting deployment workflows for popular cloud providers, such as AWS, GCP, and Azure, as well as other providers like OVH, Oracle, Scaleway, or Koyeb. Deliverables will include guides on utilizing cloud-native services (e.g., PostgreSQL, MongoDB, IDP) to create robust and scalable Microcks installations ideally on managed Kubernetes services from the provider.

This project will empower the community to deploy Microcks confidently in diverse cloud environments, fostering collaboration and sharing of expertise among adopters.

[yada]

Project Idea 8: Streamlining Microcks Deployment on AWS Marketplace

This project focuses on creating a validated and repeatable SaaS architecture for deploying Microcks on AWS, with the ultimate goal of listing it on the AWS Marketplace through the AWS Partner Network Co-Sell program. By addressing the community's frequent demand, this initiative will simplify Microcks' adoption while leveraging a complete suite of AWS services to ensure scalability, security, and ease of deployment.

Like for project idea 7: The core Microcks maintainers focus on features, security, and enhancements, the adopters are responsible for production setups. However, a shared repository of best practices can help users learn from one another in a true open-source spirit. Participants will contribute to the Microcks community repository by documenting the AWS Marketplace deployment.

Key objectives include:

• Designing and validating a SaaS architecture compliant with AWS Foundational Technical Review (FTR).
• Utilizing AWS-native services such as EKS, Aurora (PostgreSQL), DocumentDB, API Gateway, IAM, and CloudFormation for an end-to-end deployment.
• Streamlining deployment workflows to create an open source, community-maintained solution that organizations can quickly adopt.

This project will enable Microcks adopters to confidently deploy production-ready setups on AWS, ensuring the scalability and reliability needed for enterprise environments. By integrating Microcks into the AWS Marketplace, the project will further enhance its visibility and adoption within the AWS ecosystem.

[Harsh4902]

@lbroudoux @yada Deadline for the submission of project ideas is near. I think we should finalize the project ideas and scope.

[yada]

+1 @Harsh4902
It's time to wrap up and submit our projects; thanks for the reminder! 🙌

So, the projects we can submit based on the list above are:

• Project Idea 1 : Improving Microcks CLI or creating some microcks utility likemksctl
• Project Idea 3 : Update the Microcks Hub frontend and make it deployable on-premises
• Project Idea 4 : Microcks Hub: Expanding Sandbox and Mocking Capabilities for Key Industry APIs
• Project Idea 5 : Expanding Microcks community documentation for advanced installations. But this will be modified to focus on community enrolment and engagement, templates... rather than content delivery.
• Project Idea 6 : Improving Microcks delivery and validation with GitHub Actions CI deployment tests
• Project Idea 7 : Building Community-Driven documentation for deploying Microcks in cloud production environments
• Project Idea 8: Streamlining Microcks Deployment on AWS Marketplace

Is everyone okay with this? There's still time to share feedback or suggest new projects.

For each project:

1. I'll initiate an issue in the corresponding repositories (we will refer to old or previous issues later):

• [Project Idea 1] -> Improving Microcks CLI or creating some microcks utility like mksctl microcks-cli#97
• [Project Idea 3] -> Update the Microcks Hub frontend and make it deployable on-premises hub.microcks.io#76
• [Project Idea 4] -> Microcks Hub: Expanding Sandbox and Mocking Capabilities for Key Industry APIs hub.microcks.io#77
• [Project Idea 5] -> Help to expand Microcks community documentation for advanced installations community#34
• [Project Idea 6] -> Improving Microcks delivery and validation with GitHub Actions CI deployment tests #1480
• [Project Idea 7] -> Building Community-Driven documentation for deploying Microcks in cloud production environments community#32
• [Project Idea 8] -> Streamlining Microcks Deployment on AWS Marketplace community#33

2. Next, we must submit a project idea using the LFX template. With the upstream issue (ref 1.) and mentors:

Important

I you want to be a mentor for a project, please let us know:
we need some help and will appreciate your support on this initiative.

• [Project Idea 1] -> https://mentorship.lfx.linuxfoundation.org/project/7ceac2ef-6290-4e2a-87aa-db93d909b27b
• [Project Idea 3] -> https://mentorship.lfx.linuxfoundation.org/project/faccb875-1d96-44f5-aef7-95c53403d636
• [Project Idea 4] -> https://mentorship.lfx.linuxfoundation.org/project/04da9d38-b9f8-435f-9200-8359f55ccf92
• [Project Idea 5] -> https://mentorship.lfx.linuxfoundation.org/project/6b4c516d-fc01-4ab3-8147-13273fcde76b
• [Project Idea 6] -> https://mentorship.lfx.linuxfoundation.org/project/0c667baa-94bf-405c-ada6-c2bea3bf3e56
• [Project Idea 7] -> https://mentorship.lfx.linuxfoundation.org/project/1b766ba2-3de6-4eb4-8e0d-f79105b000b0
• [Project Idea 8] -> https://mentorship.lfx.linuxfoundation.org/project/51c0d803-95ea-48c1-b966-5946b8599662

[Harsh4902]

@yada I think we can't submit all of them. We have to select 2-3 project ideas because we have to assign mentors to each project. Maybe we can work on other projects during upcoming terms or GSoC.

[yada]

I have not seen any limitations (WasmEdge has submitted 4 ideas).
To be sure, I asked here: cncf/mentoring#1317

[yada]

My 2 cents: Let's create the issues on our side and decide after the ideas we focus on in the LFX template.

[yada]

All issues created ✅

To all:
Please comment and help to make projects and ideas descriptions more relevant if necessary by selecting the ideas of your choice above and contributing to the issue(s) 🙌

[Harsh4902]

@lbroudoux @yada, I think we should raise a PR now. One mentor can mentor more than one project, so it's okay to mention both of your names as mentors.

[yada]

Yep, I will do it today, and we will see.

[yada]

Hi all,
PR done, see: cncf/mentoring#1338
PS: Please give some love to it ;) and let's see the next steps.

[yada]

Hi all,
So, our 7 projects are now online on the LFX mentorship Term 1 (Mar 2025 - May 2025) dedicated website, see: https://mentorship.lfx.linuxfoundation.org/#projects_all

We will update the mentor profiles asap, and mentees can now register and apply.

🙏 We need more mentors and count on you, the Microcks community (existing contributors), to apply as mentors (create a profile and select the Microcks project you want to work on as a mentor).

Thanks and let's follow up 🚀

[nate-double-u]

Here's the full list of your Microcks specific projects:

• https://mentorship.lfx.linuxfoundation.org/project/7ceac2ef-6290-4e2a-87aa-db93d909b27b
• https://mentorship.lfx.linuxfoundation.org/project/faccb875-1d96-44f5-aef7-95c53403d636
• https://mentorship.lfx.linuxfoundation.org/project/04da9d38-b9f8-435f-9200-8359f55ccf92
• https://mentorship.lfx.linuxfoundation.org/project/6b4c516d-fc01-4ab3-8147-13273fcde76b
• https://mentorship.lfx.linuxfoundation.org/project/0c667baa-94bf-405c-ada6-c2bea3bf3e56
• https://mentorship.lfx.linuxfoundation.org/project/1b766ba2-3de6-4eb4-8e0d-f79105b000b0
• https://mentorship.lfx.linuxfoundation.org/project/51c0d803-95ea-48c1-b966-5946b8599662

[yada]

Hi all,
Join us on Discord (https://microcks.io/discord-invite) if you have any questions.
We have created a dedicated channel, #lfx-mentorship-2025, for this purpose.
Regards,
Yacine

[Himanshityagii24]

Hi @yada,

I’m excited to see that the Microcks project is part of the LFX Mentorship Term 1 (Mar 2025 - May 2025), and I would love to contribute as a mentee!

I have hands-on experience working on real-world projects using Next.js, Node.js, MongoDB, Stripe integrations, and more. I’ve built and contributed to various applications, including payment systems, real-time collaboration tools, and browser extensions. My experience with full-stack development, APIs, makes me eager to learn and grow within the Microcks community.

I am highly motivated to deepen my knowledge in API testing and mocking while contributing meaningful improvements to the project. I’m confident that my technical background, problem-solving skills, and commitment to open-source development make me a strong candidate for this mentorship.

I’d love to connect and discuss how I can contribute as a mentee. Looking forward to your response!

Best regards,
Himanshi Tyagi,
https://www.linkedin.com/in/himanshityagi24/

[yada]

@Himanshityagii24 ,
Thank you for being so interested, and welcome to the Microcks community.
Please check the comments above to join and chat on Discord.
Regards,
Yacine

[yada]

Hi all,
We already have mentees listed / interested in our 7 projects, we are very glad and thanks all.
Please check the tasks you need to perform to finalize your application(s) (REMINDER: the deadline is Feb 18) before the review period.
Regards,
Yacine

[yada]

Note

Regarding GSoC (deadline is today...) via CNCF (ref): Given the enthusiasm around the LFX mentorship and the lack of available mentor volunteers so far, we believe it’s more reasonable to postpone GSoC to next year and focus on LFX in 2025.

[Harsh4902]

@yada As per my knowledge this timeline is for Orgs to register themselves. At the time of registering the org, we don't have to specify the on which project we want to work on. That's why you can see there are fewer projects submitted to CNCF repo for GSoC. Actually We have two options, either we can take part in GSoC under CNCF or we can register Microcks as a separate organization.

[Harsh4902]

As far as the GSoC is concerned, I am ready to become a mentor.