diff --git a/README.md b/README.md index e74139e5..b07c6d78 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/ReleaseStructure.md b/docs/ReleaseStructure.md new file mode 100644 index 00000000..46582250 --- /dev/null +++ b/docs/ReleaseStructure.md @@ -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) \ No newline at end of file diff --git a/docs/cbt_release_structure.png b/docs/cbt_release_structure.png new file mode 100644 index 00000000..4fe163b7 Binary files /dev/null and b/docs/cbt_release_structure.png differ