Skip to content

New dotnet sdk versioning proposals #400

Closed
@tg123

Description

@tg123
Member

The problem

New version format should:

Proposals and solutions

draft some proposals for open discussion

Align with other client SDKs, Python, Java.

  • Update Major version for every single Minor kubernetes version.
  • Per Semantic Versioning, Major SDK update may introduce breaking changes

Java SDK solution https://github.com/kubernetes-client/java/blob/master/README.md#compatibility

|  client version  | 1.11      | 1.12     | 1.13     |  1.14     |  1.15    |
|------------------|-----------|----------|----------|-----------|----------|
|  3.0.0           |  ✓        |  -       |  -       | -         | -        |
|  4.0.0           |  +        |  ✓       |  -       | -         | -        |
|  5.0.0           |  +        |  +       |  ✓       | -         | -        |
|  6.0.1           |  +        |  +       |  +       | ✓         | -        |
|  7.0.0           |  +        |  +       |  +       | +         | ✓        |

Key: 

* `✓` Exactly the same features / API objects in both java-client and the Kubernetes
version.
* `+` java-client has features or api objects that may not be present in the
Kubernetes cluster, but everything they have in common will work.
* `-` The Kubernetes cluster has features the java-client library can't use
(additional API objects, etc).

Pack kubernetes version into SDK version

  • Like the solution above, the dotnet SDK version would be <Kubernetes Major>.<Kubernetes Minor>.<SDK updates>

such convention would help users understand better, but which doe

  • A workaround for issue above is to pack Major and Minor into one number, like <Kubernetes Major Kubernetes Minor (6 digits padding)>.<SDK update>.<SDK patch>

Docker image tag like Suffix

In additional to solutions above, also provide multiple branches build with suffix. (version with suffix will be treated as prerelease in nuget)

  • <Major>.<Minor>.<Patch> <- this one should be equal to last but without any suffix
  • <Major>.<Minor>.<Patch>-K1.14
  • <Major>.<Minor>.<Patch>-K1.15
  • <Major>.<Minor>.<Patch>-K1.16

Upgrade to new version format

Current version is 1.6.x, new version format should be Semantic Newer

Activity

tg123

tg123 commented on Apr 4, 2020

@tg123
MemberAuthor

I, personally, prefer solution 2 + solution 3.
This is an open discussion, any comments are welcomed.

brendandburns

brendandburns commented on Apr 6, 2020

@brendandburns
Contributor

Hrm, I think it's tricky, the trouble with encoding the Kubernetes version is that you either lose data (e.g. no opportunity for C# patch releases) or you end up with N different libraries (1.1.1-k1.14, 1.1.1-k1.15, etc)

That's why we went with the scheme that we use for the Java library.

I'm not 100% wedded to it, but it's what I would vote for (but I'm biased)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

        Participants

        @tg123@brendandburns

        Issue actions

          New dotnet sdk versioning proposals · Issue #400 · kubernetes-client/csharp