Initial commit

docs/index.md

+(front-page)=
+
+# OutpostSpawner
+
+The OutpostSpawner enables JupyterHub to spawn single-user notebook servers on multiple remote resources.
+
+## Overview  
+  
+The JupyterHub community created many useful [JupyterHub Spawner](https://jupyterhub.readthedocs.io/en/latest/reference/spawners.html#examples) over the past years, to allow JupyterHub to use the specific resources of different systems. For most of these Spawners JupyterHub has to run at the system itself. The OutpostSpawner enables the use of these Spawners on remote systems.  
+
+Other Spawners like [SSHSpawner](https://github.com/NERSC/sshspawner) can spawn single-user servers on remote systems, but are not able to use system-specific features like [KubeSpawner](https://github.com/jupyterhub/kubespawner) or [BatchSpawner](https://github.com/jupyterhub/batchspawner).  
+  
+With the OutpostSpawner a single JupyterHub can offer multiple remote systems of different types. It comes with an additional REST API called "JupyterHub Outpost". This JupyterHub Outpost can use any JupyterHub Spawner and will manage the lifecycle of the single-user servers.  
+  
+- Use one JupyterHub to offer single-user servers on multiple systems.
+- Each system may use a different JupyterHub Spawner.
+- Integrated SSH port forwarding solution to reach remote single-user server.
+- supports the JupyterHub `internal_ssl` feature.
+- shows events gathered by the remote Spawner to the user.
+- Users can override the configuration of the remote Spawner at runtime (e.g. to select a different Docker Image).
+- One JupyterHub Outpost can be connected to multiple JupyterHubs, without interfering with each other.
+  
+## Requirements  
+  
+JupyterHub must run on a Kubernetes Cluster (recommended is the use of Zero2JupyterHub).  
+The JupyterHub Outpost must fulfill the requirements of the configured Spawner class. 
+
+
+## License
+
+```{eval-rst}
+.. literalinclude:: ../LICENSE
+```
+  
+```{eval-rst}
+.. toctree::
+    :maxdepth: 2
+    :caption: General
+
+    architecture
+```
+
+```{eval-rst}
+.. toctree::
+    :maxdepth: 2
+    :caption: Spawners
+
+    spawners/outpostspawner
+    spawners/eventoutpostspawner
+    apiendpoints
+```

docs/requirements.txt

+--editable .
+
+autodoc-traits
+sphinx-jsonschema
+sphinx-copybutton
+sphinx-book-theme
+sphinxext-opengraph
+myst-parser>=0.17.0
+sphinxext-rediraffe
+pytablewriter>=0.56
+breathe==4.35.0
+sphinx==7.2.6
+sphinx-rtd-theme==1.3.0

docs/spawners/eventoutpostspawner.md

+# EventOutpostSpawner
+
+```{eval-rst}
+.. automodule:: outpostspawner
+```
+
+```{eval-rst}
+.. autoconfigurable:: EventOutpostSpawner
+   :noindex:
+   :exclude-members: args,auth_state_hook,cmd,consecutive_failure_limit,cpu_guarantee,cpu_limit,debug,default_url,disable_user_config,env_keep,environment,http_timeout,hub_connect_url,ip,mem_guarantee,mem_limit,notebook_dir,oauth_client_allowed_scopes,oauth_roles,options_form,options_from_form,port,post_stop_hook,pre_spawn_hook,server_token_scopes,start_timeout,ssl_alt_names_include_local,ssl_alt_names,check_allowed,custom_env,custom_internal_ssl,custom_misc,custom_misc_disable_default,custom_port,custom_user_options,dns_name_template,extra_labels,failed_spawn_request_hook,pod_name_template,poll_interval,post_spawn_request_hook,public_api_url,request_404_poll_keep_running,request_failed_poll_keep_running,request_headers,request_kwargs,request_url,ssh_custom_forward,ssh_custom_forward_remove,ssh_custom_svc,ssh_custom_svc_remove,ssh_enabled,ssh_forward_options,ssh_key,ssh_node,ssh_port,ssh_recreate_at_start,ssh_username
+```

outpostspawner/__init__.py

+from . import api_events
+from . import api_setup_tunnel
+from .api_events import user_cancel_message
+from .outpostspawner import OutpostSpawner
+from .eventspawner import EventOutpostSpawner