Skip to content

Commit

Permalink
Add a CFP for cilium/cilium#25694
Browse files Browse the repository at this point in the history
Signed-off-by: Michi Mutsuzaki <[email protected]>
  • Loading branch information
michi-covalent committed May 26, 2023
1 parent cad07c3 commit dd6e490
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions cilium/CFP-25694-move-cilium-cli-to-cilium-repo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# CFP-25694: Move cilium/cilium-cli code into cilium/cilium repository

**Code Name: Mega Ketchup**

**SIG: [sig-cilium-cli]**

**Begin Design Discussion:** 2023-05-25

**Cilium Release:** 1.15

**Authors:** Michi Mutsuzaki `<[email protected]>`

## Summary

Move [cilium/cilium-cli] code into [cilium/cilium] repository.

## Motivation

The main motivation for moving [cilium/cilium-cli] code into [cilium/cilium]
repository is to minimize the feature development overhead for:

- adding new tests to `cilium connectivity test`.
- adding new tasks to `cilium sysdump`.

## Goals

* Move [cilium/cilium-cli] code into [cilium/cilium] main branch under `cilium-cli/` directory.
* Establish a backporting process for changes inside `cilium-cli/` directory.
* Don't disrupt the cilium-cli development and release processes.

## Non-Goals

* Rename the name of the `cilium-cli` binary from `cilium` to something else.
* Release `cilium-cli` as a part of Cilium releases.

## Proposal

### Overview

### Releasing cilium-cli

We do not need to change the release process / cadence to accomplish the goals
defined in this CFP. Continue releasing `cilium-cli` from the main branch at its
own cadence using its own versioning that is independent of [cilium/cilium]
versioning as we have been doing in [cilium/cilium-cli] repository.

We need to come up with a git tag convention for cilium-cli releases to distinguish
tags for Cilium releases from tags for cilium-cli releases. My proposal to use
`cilium-cli/vX.Y.Z` for cilium-cli release tags.

### Backporting to stable branches

Starting in `v1.15`, we will need to backport bug fixes related to
`cilium connectivity test` command from `main` branch to affected stable
branches since these stable branches use their own copy of `cilium-cli/` to run
`cilium connectivity test`. Apply the same [backporting process] as the rest of
the Cilium codebase.

## Impacts / Key Questions

### Impact: Additional overhead for cilium-cli development

### Key Question: Do we lose cilium-cli git history when we move cilium-cli code into cilium/cilium repository?

## Alternatives to Consider

[sig-cilium-cli]: https://github.com/orgs/cilium/teams/sig-cilium-cli
[cilium/cilium]: https://github.com/cilium/cilium
[cilium/cilium-cli]: https://github.com/cilium/cilium-cli
[backporting process]: https://docs.cilium.io/en/stable/contributing/release/backports/

0 comments on commit dd6e490

Please sign in to comment.