scylladb / local-csi-driver

ScyllaDB local volume provisioner for Kubernetes based on CSI
Apache License 2.0
8 stars 6 forks source link

Unify binary, repo and image naming #39

Closed tnozicka closed 4 months ago

tnozicka commented 11 months ago

We should unify the packages, binary and image name for consistency.

At this point the difference is confusing (caused by historical reasons when requesting the repo name): repo name: github.com/scylladb/k8s-local-volume-provisioner image name: docker.io/scylladb/k8s-local-volume-provisioner binary name: local-csi-driver

scylla-operator-bot[bot] commented 4 months ago

The Scylla Operator project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

/lifecycle stale

tnozicka commented 4 months ago

/remove-lifecycle stale /triage accepted

zimnx commented 4 months ago

I collected pros and cons behind few options we discussed, here's a summary:


Change k8s-local-volume-provisioner to local-csi-driver

What needs to be done afterwards:

Change local-csi-driver to k8s-local-volume-provisioner

What needs to be done afterwards:

Change k8s-local-volume-provisioner to scylladb-local-csi(-driver)

What needs to be done afterwards:


I had a meeting with @ylebi where we discussed them, and we are align on opting to the first option. @tnozicka what do you think?

tnozicka commented 4 months ago

Thanks for writing this down.

I'd generally be in favour of using scylla- prefix for our namespace

(con) nothing is related to scylla, we are just the maintainers

Kind of, but the name is generic enough for other people writing a CSI driver to pick the same name and conflict with us. Having such prefix is pretty common practice to avoid collisions on naming. Both our GH repo and the container registry already have the prefix in the organization part, so this is meant only for the namespace.

That said, going for the first option Change k8s-local-volume-provisioner to local-csi-driver is fine with me, the non-prefixed namespace is already there, this won't make it worse and it can be done separately later, if we decide to go there.

But please start by renaming the repo, so the opinionated part (which is how this discrepancy came to be) will be sorted out.