search

scottyhq / jupyter-cloud-scoped-creds

jupyter server extension to get temporary cloud provider credentials
0 stars 1 forks source link

Rename to `jupyter-cloud-creds` ? #5

Open consideRatio opened 1 year ago

consideRatio commented 1 year ago

I'm considering a name chance along with #4.

Let's breakdown the current name jupyter-cloud-scoped-creds:

  1. jupyter because its exposing the creds through a jupyter server (jupyter_server or notebook) Perfect!
  2. cloud and creds because it relates to extracting cloud providers' credentials Perfect!
  3. scoped I guess the name jupyter-cloud-scoped-creds was inspired by gh-scoped-creds, but I think the scoped part doesn't translate to this project well. In gh-scoped-creds, the project enables a github users permissions provided to be reduced in scope to only a repository etc, but in this project we just expose all the available credentials to various cloud providers - they are not scoped to something specific by this project.

This project does ensre that the crendeitlas are temporary, and this project can the expiry time to some degree. I think adding temp or temporary to the name would be a bit much though, and that it could be sufficient to document this clearly and not include in the name.

Proposals

  1. A project name change to jupyter-cloud-creds (from jupyter-cloud-scoped-creds)
  2. An endpoint name change to api/jupyter-cloud-creds/aws (from api/cloudcreds/aws) If the endpoint name includes this projects name, it becomes easier for users to understand directly that this project provided the endpoint. Consider for example a server admin or similar sees request to api/jupyter-cloud-creds/aws in some logs, then it would be easier for them to find their way to this project and learn more than if it was api/cloudcreds/aws.

@scottyhq and @yuvipanda what do you think?

scottyhq commented 1 year ago

A project name change to jupyter-cloud-creds (from jupyter-cloud-scoped-creds)

Fine by me. I agree the 'scoping' is set at the hub configuration level, rather than by this API.

An endpoint name change to api/jupyter-cloud-creds/aws

I'm on the fence with this. I mostly think of it from a users perspective where short and simple is ideal and I dislike hyphens in URLs for no particularly good reason :) But I think you make a good point about clarity of admins @consideRatio so I would not be opposed to the change!

yuvipanda commented 1 year ago

As it is against my religious beliefs to have naming opinions, I am perfectly & truly happy for it to be whatever it is you want. THANK YOU for picking this up!