Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename K6 CRD to TestRun #226

Open
yorugac opened this issue May 4, 2023 · 2 comments
Open

Rename K6 CRD to TestRun #226

yorugac opened this issue May 4, 2023 · 2 comments
Assignees
Labels
breaking change Breaking change can impact some existing workflows. PLZ
Milestone

Comments

@yorugac
Copy link
Collaborator

yorugac commented May 4, 2023

In order to improve readability of our interfaces, we should rename the K6 CRD from:

kind: K6

To:

kind: TestRun

Why? kind: K6 is not very descriptive as from the first glance, it might mean a lot of things. If we add new CRDs (see #191), we should try to remove the confusing names as well.

This is a breaking change for existing setups so consider supporting both names for some period of time.

@yorugac yorugac added breaking change Breaking change can impact some existing workflows. PLZ labels May 4, 2023
@yorugac yorugac self-assigned this Aug 22, 2023
@yorugac
Copy link
Collaborator Author

yorugac commented Aug 22, 2023

It appears that general Kubernetes guideline is to make "roundtrip convertible" CRD types which more commonly would mean making them backwards compatible. In our case, we should probably try to be backwards compatible with K6 resources at least for some time so TestRun should be added as a new CRD, with conversions.

Additionally, we could use this as opportunity to switch from v1alpha1 to v1beta1 for TestRun specifically. Drawback: there are a few issues related to API stability that would be good to resolve first:

@yorugac
Copy link
Collaborator Author

yorugac commented Sep 25, 2023

TestRun CRD has been added as a duplicate of K6 CRD with the latter being marked as deprecated in #286
Missing dependency: #273

We'll support both K6 and TestRun for some time, to give people the opportunity to switch. But afterwards K6 will be removed. IOW, we didn't get to the "breaking" part yet.

I'm leaving this issue open for now. What is left:

  • updating documentation
  • removing K6 CRD in the future™

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Breaking change can impact some existing workflows. PLZ
Projects
None yet
Development

No branches or pull requests

1 participant