Add kube profile spawner #137

gsemet · 2018-03-01T15:54:29Z

Reference #135

Adds profile_list parameter to KubeSpawner allowing override of one or several parameter (ex: cpu_limit, image_spec, or any other KubeSpawner parameter)

Here an example:

c.JupyterHub.spawner_class = 'kubespawner.KubeSpawner'
c.KubeSpawner.namespace = ...
c.KubeSpawner.start_timeout = ...
c.KubeSpawner.singleuser_image_spec = ...
c.KubeSpawner.singleuser_extra_labels = ...
c.KubeSpawner.singleuser_uid = ...
...
c.KubeSpawner.profile_list = [
    {
        'display_name': 'Training Env - Python',
        'kubespawner_override': {
            'singleuser_image_spec': 'training/python:label',
            'cpu_limit': 1,
        }
    },
    {   
        'display_name': 'Training Env - Datascience',
        'kubespawner_override': {
            'singleuser_image_spec': 'training/datascience:label',
            'cpu_limit': 4,
        }
    }, {
        'display_name': 'DataScience - Small instance',
        'kubespawner_override': {
            'singleuser_image_spec': 'datascience/small:label',
            'cpu_limit': 10,
        }
    }, {
        'display_name': 'DataScience - Medium instance',
        'kubespawner_override': {
            'singleuser_image_spec': 'datascience/medium:label',
            'cpu_limit': 48,
        }
    }, {
        'display_name': 'DataScience - Medium instance (GPUx2)',
        'kubespawner_override': {
            'singleuser_image_spec': 'datascience/medium:label',
            'cpu_limit': 48,
            'extra_resource_guarantees': {"nvidia.com/gpu": "2"},
        }
    }
]

I have not fully tested this version, and if we agree, this class can be merged into KubeSpawner ultimately.

Screenshot:

yuvipanda · 2018-03-07T07:30:34Z

Hey, @gsemet! Apologies for the late review!

This actually looks good to me as is! Can you merge it into KubeSpawner itself, rather than having it be a separate spawner? I think we can merge it afterwards...

gsemet · 2018-03-07T07:42:42Z

Sure. I just have one issue. When the container is pending stop and you want to restart it it shows a 400 error “pending stop”, I do not remember seeing it with the normal kubespawner, it was just waiting.
If it is ok for you, I’ll merge it.

gsemet · 2018-03-09T10:23:32Z

I have a few change to update (I'll do is asap) before this PR being ready to merge

ah- · 2018-03-11T16:17:27Z

kubespawner/__init__.py


-__all__ = [KubeSpawner]
+__all__ = [KubeSpawner, KubeProfileSpawner]


Can probably remove KubeProfileSpawner from here now?

gsemet · 2018-03-11T16:17:46Z

updated my PR. I'll be happy if someone can test it

gsemet · 2018-03-11T16:50:53Z

I'll test it tomorow on our baremetal kube cluster

sylus · 2018-03-15T12:48:35Z

I took a look at this by adding the following to forked requirements.txt hub docker image:

git+git://github.com/gsemet/kubespawner@profile_spawner#egg=jupyterhub-kubespawner

And then in my config.yaml helm chart

  image:
    name: govcloud/zero-to-jupyterhub-k8s
    tag: v0.6
  extraConfig: |
    c.KubeSpawner.single_user_profile_list = [
        {
            'display_name': 'Training Env - Python',
            'kubespawner_overrride': {
                'image_spec': 'jupyterhub/python:0.8',
                'cpu_limit': 10,
            }
        },
        {
            'display_name': 'Training Env - SAS',
            'kubespawner_overrride': {
                'image_spec': 'jupyterhub/sas:0.8',
                'cpu_limit': 10,
            }
        }, {
            'display_name': 'DataScience - Pachyderm',
            'kubespawner_overrride': {
                'image_spec': 'jupyterhub/pachyderm:0.8',
                'cpu_limit': 10,
            }
        }
    ]

The interface does get updated but doesn't seem to do anything?

Looking at WrapSpawner + DockerSpawner are we not supposed to now check self.user_options before the make_pod assignment in

kubespawner/kubespawner/objects.py

Line 23 in f3a2637

def make_pod(

Thanks for the amazing work!

minrk · 2018-03-16T10:36:29Z

kubespawner/spawner.py

+
+    options_form = Unicode()
+
+    single_user_profile_list = List(


Can this be profile_list? I want to move toward removing the singleuser_ prefix from config, since everything here is necessarily about configuring singleuser pods, it's redundant.

minrk · 2018-03-16T10:36:59Z

kubespawner/spawner.py

@@ -781,6 +783,46 @@ def _hub_connect_port_default(self):
        """
    )

+    form_template = Unicode(
+        """<label for="profile">Please select a profile for your Jupyter:</label>


s/Jupyter/environment/

minrk · 2018-03-16T10:38:15Z

kubespawner/spawner.py

+    form_template = Unicode(
+        """<label for="profile">Please select a profile for your Jupyter:</label>
+        <select class="form-control" name="profile" required autofocus>
+        {input_template}


call this {inputs} since it is not input_template, but the result of input_template being rendered multiple times.

minrk · 2018-03-16T10:53:10Z

kubespawner/spawner.py

+            the first item starts selected."""
+        )
+
+    first_template = Unicode('selected',


If this isn't a template, maybe not have 'template' in the name. Maybe first_input?

gsemet · 2018-03-16T11:11:25Z

Ok, i'll rebase and test these changes next week :)

sylus · 2018-03-16T12:18:22Z

Was there any feedback on my comment was curious for my own edification that this was still missing logic in make_pod to be functional?

gsemet · 2018-03-16T14:25:21Z

I have actually not tested the image spec override so I may have made a mistake. I’ll see that next week, prev week was too busy ! But sure, I’ll take all your feedback into account, and the image override should work, was a reason to implement this profile_list feature !

gsemet · 2018-03-19T15:55:58Z

@sylus, you took my example that had a typo: kubespawner_overrride. Please change it to kubespawner_override :)

gsemet · 2018-03-19T16:20:23Z

Just tested it now. It works :) I only tested with the following override:

'cpu_limit': 1,
'mem_limit': '1G',

And they are well applied on the started pod.

clkao · 2018-03-22T01:34:23Z

kubespawner/spawner.py

+        config=True,
+        help="Text to substitute as {first} in inputs"
+        )
+


unintended whitespaces?

should be resolved

clkao · 2018-03-22T01:39:58Z

This looks great! the PR description example config should use profile_list instead of single_user_profile_list

gsemet · 2018-03-22T12:24:31Z

updating with example in documentation

clkao · 2018-03-25T06:05:39Z

with this PR merged, it seems #108 can be done by subclassing kubespawner making the profile list dynamic based on auth_state?

yuvipanda · 2018-04-17T20:52:08Z

@gsemet I've made some changes. If this looks good to you, I'm happy to merge :) I highly appreciate your patience in getting this change through!

gsemet · 2018-04-17T20:55:33Z

/me approve !

yuvipanda · 2018-04-17T20:56:56Z

Congratulations on getting this big patch merged in, @gsemet! And thank you for your patience in reworking based on feedback and waiting!

gsemet · 2018-04-17T20:58:11Z

thanks to you! I use it everyday, hope it will please others as much !

manics · 2018-04-18T08:38:00Z

Any chance of getting this into the next release of zero-to-jupyterhub?

choldgraf · 2018-04-19T17:36:18Z

@manics we merged this into jupyterhub for k8s, though I think it uncovered a memory bug that @minrk spotted...but yes I think it'll make it in soonishfully!

gsemet · 2018-04-19T18:20:16Z

tell me if you need test, i can do it pretty easily for now on our kube cluster

jgerardsimcock · 2018-04-22T04:15:23Z

Is this currently in the any of the jupyterhub helm-charts?

choldgraf · 2018-05-01T02:08:10Z

@jgerardsimcock we are working on getting it into the Z2JH helm chart, but it isn't in there yet

ablekh · 2018-06-04T17:43:00Z

@choldgraf Any news/outlook on integrating this very useful update (congratulations, @gsemet !) into Z2JH Helm chart (I assume, v0.7)? @minrk said today (jupyterhub/zero-to-jupyterhub-k8s#545 (comment)) that this feature is already integrated, so double checking ... BTW, has v0.7 already been published as GA?

gsemet · 2018-06-04T18:22:26Z

Glad to see it is useful to others. !
i can help documentation on z2jh when possible :)

choldgraf · 2018-06-04T22:04:50Z

@minrk 's opinion is usually more correct than mine, so I'll agree with him :-)

ablekh · 2018-06-04T22:09:17Z

@choldgraf What about the (general) availability of v0.7 Helm chart?

minrk · 2018-06-12T09:25:37Z

hub.extraConfig can always be used as an escape hatch for configuration that isn't yet exposed via helm charts. v0.7 is not a published version yet, but it is quite close. We need to finalize our 0.9 release of JupyterHub (this week) and probably polish and make releases of kubespawner and oauthenticator first as well.

consideRatio · 2018-06-12T11:31:16Z

Ah good summary @minrk! I'll put in work towards a helm chart release from now on.

gsemet mentioned this pull request Mar 2, 2018

Embed wrapspawner to allow selection of image jupyterhub/zero-to-jupyterhub-k8s#545

Closed

gsemet force-pushed the profile_spawner branch 3 times, most recently from 86addb8 to 1338224 Compare March 7, 2018 19:12

gsemet mentioned this pull request Mar 9, 2018

Support multiple user servers #142

Closed

gsemet changed the title ~~Add kube profile spawner~~ WIP: Add kube profile spawner Mar 9, 2018

gsemet force-pushed the profile_spawner branch from 7991c6b to 152d149 Compare March 11, 2018 16:15

gsemet changed the title ~~WIP: Add kube profile spawner~~ Add kube profile spawner Mar 11, 2018

ah- reviewed Mar 11, 2018

View reviewed changes

gsemet force-pushed the profile_spawner branch from 152d149 to 176f033 Compare March 11, 2018 16:47

minrk reviewed Mar 16, 2018

View reviewed changes

gsemet force-pushed the profile_spawner branch 2 times, most recently from fb77366 to e7c4735 Compare March 19, 2018 15:52

clkao reviewed Mar 22, 2018

View reviewed changes

gsemet force-pushed the profile_spawner branch 2 times, most recently from 16512fd to 7eb0403 Compare March 22, 2018 12:27

yuvipanda added 3 commits April 17, 2018 13:51

Use a single jinja2 template for rendering forms

8344d1a

Update traitlet docs for profile related traitlets

02bb801

Minor style adjustment

efb48ae

yuvipanda force-pushed the profile_spawner branch from 8ee1423 to efb48ae Compare April 17, 2018 20:51

yuvipanda approved these changes Apr 17, 2018

View reviewed changes

yuvipanda merged commit 5170da9 into jupyterhub:master Apr 17, 2018

yuvipanda mentioned this pull request Apr 19, 2018

include spawner in spawn page template namespace jupyterhub/jupyterhub#1788

Merged

This was referenced Apr 23, 2018

Docker image selection dropdown not rendering #164

Closed

Best way to install additional Kernels? jupyterhub/zero-to-jupyterhub-k8s#608

Closed

bitnik mentioned this pull request Jun 20, 2018

make profile_list union of List and Callable #192

Merged

yuvipanda mentioned this pull request Jun 27, 2018

Add support for SpawnerForm that lets you pick which Image to run #14

Closed

This was referenced Sep 3, 2018

Support multiple Docker builds? jupyterhub/zero-to-jupyterhub-k8s#46

Closed

kubespawner.profile_list - image-pulling of multiple images jupyterhub/zero-to-jupyterhub-k8s#903

Closed

ablekh mentioned this pull request Oct 26, 2018

Allow for alternate commands and images #135

Closed

prcastro mentioned this pull request Nov 30, 2018

Per-user (or per-group) custom resources jupyterhub/zero-to-jupyterhub-k8s#808

Closed


		__all__ = [KubeSpawner]
		__all__ = [KubeSpawner, KubeProfileSpawner]

Add kube profile spawner #137

Add kube profile spawner #137

Conversation

gsemet commented Mar 1, 2018 • edited Loading

yuvipanda commented Mar 7, 2018

gsemet commented Mar 7, 2018

gsemet commented Mar 9, 2018

Choose a reason for hiding this comment

gsemet commented Mar 11, 2018

gsemet commented Mar 11, 2018

sylus commented Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsemet commented Mar 16, 2018

sylus commented Mar 16, 2018

gsemet commented Mar 16, 2018

gsemet commented Mar 19, 2018 • edited Loading

gsemet commented Mar 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clkao commented Mar 22, 2018

gsemet commented Mar 22, 2018

clkao commented Mar 25, 2018

yuvipanda commented Apr 17, 2018

gsemet commented Apr 17, 2018

yuvipanda commented Apr 17, 2018

gsemet commented Apr 17, 2018

manics commented Apr 18, 2018

choldgraf commented Apr 19, 2018

gsemet commented Apr 19, 2018

jgerardsimcock commented Apr 22, 2018

choldgraf commented May 1, 2018

ablekh commented Jun 4, 2018 • edited Loading

gsemet commented Jun 4, 2018

choldgraf commented Jun 4, 2018 • edited Loading

ablekh commented Jun 4, 2018

minrk commented Jun 12, 2018

consideRatio commented Jun 12, 2018

gsemet commented Mar 1, 2018 •

edited

Loading

sylus commented Mar 15, 2018 •

edited

Loading

gsemet commented Mar 19, 2018 •

edited

Loading

ablekh commented Jun 4, 2018 •

edited

Loading

choldgraf commented Jun 4, 2018 •

edited

Loading