Skip to content

what is krkn-hub section #80

@tejugang

Description

@tejugang

Currently:
Background on what is the krkn-hub github repository

Instead:
Background on the krkn-hub github repository

Currently:
“Hosts container images and wrapper for running scenarios supported by Krkn, a chaos testing tool for Kubernetes clusters to ensure it is resilient to failures. All we need to do is run the containers with the respective environment variables defined as supported by the scenarios without having to maintain and tweak files!”

Instead:
The krkn-hub GitHub repository serves as the central hub for containerized chaos scenarios supported by Krkn, a chaos testing tool for Kubernetes clusters. It hosts ready to use container images and their execution configurations (wrappers) designed to ensure cluster resilience to failures. krkn-hub significantly simplifies chaos scenario execution: users can directly run these containers, configuring scenarios through environment variables, thereby eliminating the need to manually maintain and tweak complex files.

Currently:
“The Library contains Classes, Models and helper functions used in Kraken to interact with Kubernetes, Openshift and other external APIS. The goal of this library is to give to developers the building blocks to realize new Chaos Scenarios and to increase the testability and the modularity of the Krkn codebase.”

Instead:
“krkn-lib is the foundational library for the Krkn chaos and resiliency testing tool. It contains essential Classes, Data Models, and helper functions that enable Krkn to interact with Kubernetes, OpenShift, and other external APIs. The primary goal of krkn-lib is to provide developers with reusable building blocks to:
Create new Chaos Scenarios: Accelerate the development of new chaos tests.
Enhance Testability and Modularity: Improve the overall structure and maintainability of the Krkn codebase.

Currently:
“The Library documentation of available functions is here. The documentation is automatically generated by Sphinx on top of the reStructuredText Docstring Format comments present in the code.”

Instead:
The comprehensive documentation for krkn-lib's available functions is available here and is automatically generated by Sphinx, based on the reStructuredText Docstring Format comments within the code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions