[Incubation] ChaosBlade Incubation Application

[MandssS]

ChaosBlade Incubation Application

v1.5
This template provides the project with a framework to inform the TOC of their conformance to the Incubation Level Criteria.

Project Repo(s): https://github.com/chaosblade-io/chaosblade
Project Site: https://chaosblade.io/
Sub-Projects:

• https://github.com/chaosblade-io/chaosblade
• https://github.com/chaosblade-io/chaosblade-spec-go
• https://github.com/chaosblade-io/chaosblade-exec-cri
• https://github.com/chaosblade-io/chaosblade-operator
• https://github.com/chaosblade-io/chaosblade-exec-os
• https://github.com/chaosblade-io/chaosblade-exec-middleware
• https://github.com/chaosblade-io/chaosblade-exec-cloud
• https://github.com/chaosblade-io/chaosblade-exec-jvm
• https://github.com/chaosblade-io/chaosblade-exec-cplus
• https://github.com/chaosblade-io/chaosblade-exec-golang
• https://github.com/chaosblade-io/chaosblade-box
• https://github.com/chaosblade-io/chaosblade-box-agent

Communication: https://slack.cncf.io/ (#chaosblade channel)

Project points of contacts: @MandssS , [email protected]

Incubation Criteria Summary for ChaosBlade

Adoption Assertion

The project has been adopted by the following organizations in a testing and integration or production capacity:
*

Application Process Principles

Suggested

N/A

Required

• Give a presentation and engage with the domain specific TAG(s) to increase awareness
• This was completed and occurred on 09-July-2024, and can be discovered at https://docs.google.com/document/d/1_QoF-njScSuGFI3Ge5zu-G8SbL6scQ8AzT1hq57bRoQ/edit#heading=h.8mxdc6k4u3xu

• TAG provides insight/recommendation of the project in the context of the landscape

• Done in the tag meeting above

• All project metadata and resources are vendor-neutral.

• Yes. ChaosBlade is utilizing CNCF provided vendor neutral resources for communication, testing , hosting and governance.

• Review and acknowledgement of expectations for Sandbox projects and requirements for moving forward through the CNCF Maturity levels.
• Met during Project's application on 28-04-2021.

• Due Diligence Review.

Completion of this due diligence document, resolution of concerns raised, and presented for public comment satisifies the Due Diligence Review criteria.

• Additional documentation as appropriate for project type, e.g.: installation documentation, end user documentation, reference implementation and/or code samples.
• Installation documentation : https://chaosblade.io/en/docs/getting-started/installation-and-deployment/
• End user documentation: https://chaosblade.io/en/docs/
• Blog posts: https://chaosblade.io/blog/

Governance and Maintainers

Note: this section may be augmented by the completion of a Governance Review from TAG Contributor Strategy.

Suggested

• Clear and discoverable project governance documentation.
• https://github.com/chaosblade-io/community/blob/main/Contributor_Ladder.md

• Governance has continuously been iterated upon by the project as a result of their experience applying it, with the governance history demonstrating evolution of maturity alongside the project's maturity evolution.
• ChaosBlade project Governance has iterated organically as it has gained experienced over the years. Contributor Roles and contributor ladder processes are streamlined over the past years as well as team member onboarding/offboarding process is well defined. The Project has currently 5 maintainers and it has received contributions from 149 contributors who come from 31 different companies.

• Governance is up to date with actual project activities, including any meetings, elections, leadership, or approval processes.

• Governance clearly documents vendor-neutrality of project direction.

• Document how the project makes decisions on leadership, contribution acceptance, requests to the CNCF, and changes to governance or project goals.

• Document how role, function-based members, or sub-teams are assigned, onboarded, and removed for specific teams (example: Security Response Committee).

• Documented in https://github.com/chaosblade-io/community/blob/main/Contributor_Ladder.md

• Document a complete maintainer lifecycle process (including roles, onboarding, offboarding, and emeritus status).

• The role promotion process is documented here

• Demonstrate usage of the maintainer lifecycle with outcomes, either through the addition or replacement of maintainers as project events have required.

• promotion maintainer chaosblade-io/community#12

• If the project has subprojects: subproject leadership, contribution, maturity status documented, including add/remove process.

• Documented in https://github.com/chaosblade-io/community/?tab=readme-ov-file#governance

Required

• Document complete list of current maintainers, including names, contact information, domain of responsibility, and affiliation.

• ChaosBlade maintainers

• A number of active maintainers which is appropriate to the size and scope of the project.

• ChaosBlade has 5 active maintainers

• Code and Doc ownership in Github and elsewhere matches documented governance roles.

• Contributor Guide

• DCO

• Document agreement that project will adopt CNCF Code of Conduct.

• ChaosBlade follows CNCF Code of Conduct

• CNCF Code of Conduct is cross-linked from other governance documents.

• Yes, https://github.com/chaosblade-io/chaosblade/blob/master/GOVERNANCE.md

• All subprojects, if any, are listed.

Contributors and Community

Note: this section may be augmented by the completion of a Governance Review from TAG Contributor Strategy.

Suggested

• Contributor ladder with multiple roles for contributors.
• contributor ladder

Required

• Clearly defined and discoverable process to submit issues or changes.

• PR Submission Guidelines

• Issue submission and handling specifications

• Project must have, and document, at least one public communications channel for users and/or contributors.

• List and document all project communication channels, including subprojects (mail list/slack/etc.). List any non-public communications channels and what their special purpose is.

• Communication channels

• Up-to-date public meeting schedulers and/or integration with CNCF calendar.

• This is completed as no-op, as the project has no sync meeting due to timezone diversity

• Documentation of how to contribute, with increasing detail as the project matures.

• PR Submission Guidelines

• Java contribution guide

• Demonstrate contributor activity and recruitment.

• The ChaosBlade devstats page and dashboards can be found here

  • Number of contributors: 149
  • Github stars: 5400+
  • Github forks: 900+
  • Contributing organizations: 31

Engineering Principles

Suggested

• Roadmap change process is documented.

• https://github.com/chaosblade-io/community/blob/main/roadmap.md

• History of regular, quality releases.

• ChaosBlade currently follows quarterly release, see therelease history

Required

• Document project goals and objectives that illustrate the project’s differentiation in the Cloud Native landscape as well as outlines how this project fulfills an outstanding need and/or solves a problem differently.

• ChaosBlade project goals and objectives

• Document what the project does, and why it does it - including viable cloud native use cases.

• ChaosBlade What and Why

• Document and maintain a public roadmap or other forward looking planning document or tracking mechanism.

• ChaosBlade Roadmap

• Document overview of project architecture and software design that demonstrates viable cloud native use cases, as part of the project's documentation.

• ChaosBlade Overview

• ChaosBlade-Box Platform Introduction

• ChaosBlade Execution Tools Introduction

• Document the project's release process.

• Release-Process

Security

Note: this section may be augemented by a joint-assessment performed by TAG Security.

Suggested

N/A

Required

• Clearly defined and discoverable process to report security issues.

• Documented in Security

• Enforcing Access Control Rules to secure the code base against attacks (Example: two factor authentication enforcement, and/or use of ACL tools.)

• All the Committers have 2FA enabled

• Document assignment of security response roles and how reports are handled.

• Documented in https://github.com/chaosblade-io/chaosblade/blob/master/SECURITY.md

• Document Security Self-Assessment.

• Achieve the Open Source Security Foundation (OpenSSF) Best Practices passing badge.
• OpenSSF best practice passing badge

Ecosystem

Suggested

N/A

Required

• Publicly documented list of adopters, which may indicate their adoption level (dev/trialing, prod, etc.)

• ChaosBlade Adopters are tracked here https://github.com/chaosblade-io/community/blob/main/ADOPTERS.md

• Used in appropriate capacity by at least 3 independent + indirect/direct adopters, (these are not required to be in the publicly documented list of adopters)

The project provided the TOC with a list of adopters for verification of use of the project at the level expected, i.e. production use for graduation, dev/test for incubation.

• TOC verification of adopters.

Refer to the Adoption portion of this document.

• Clearly documented integrations and/or compatibility with other CNCF projects as well as non-CNCF projects.
• Support for chaos on containerd (CNCF Graduated) runtime. ChaosBlade-Box can use prometheus to help users monitor chaos experiments. ChaosBlade can be used with Docker, Kubernetes, and other container engines too.

Additional Information

N/A