Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# CBT - The Ceph Benchmarking Tool

---
> ⚠️ **IMPORTANT NOTICE**
>
> This current branch (`master`) is **frozen**. Please refer to
> the [**`main` branch**](https://github.com/ceph/cbt/tree/main)
> which contains the latest features and code for CBT.
>
> Also see information about the new [release structure](docs/ReleaseStructure.md) for CBT
> following the release of Ceph v21.x (Umbrella).
---

## INTRODUCTION

CBT is a testing harness written in python that can automate a variety of tasks
Expand Down
22 changes: 22 additions & 0 deletions docs/ReleaseStructure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# CBT Release Structure

## Proposal

From Ceph v21.x (Umbrella) onwards, there will be specific
branches of CBT that tie to each major Ceph release.
Depnding on the version of Ceph which teuthology is running
against, the corresponding branch of CBT will be used.

## Branches
- The `main` branch is the new default branch for ongoing CBT
development. It is also used for standalone CBT deployments.

- The `master` branch will be retained for backwards compatibility
with older Ceph versions. This branch is frozen and will receive
no further updates.

- For each new Ceph release, a new CBT branch for that release
will be created. These branches are exclusively for running
teuthology for a specific Ceph release.

![CBT Release diagram](./cbt_release_structure.png)
Binary file added docs/cbt_release_structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.