Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Aug 9, 2024
1 parent e877631 commit 47de78b
Show file tree
Hide file tree
Showing 62 changed files with 178 additions and 175 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
11f49533
485fd4b9
2 changes: 1 addition & 1 deletion admins/cluster-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/credentials.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/deployments/datahub.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/deployments/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/deployments/stat159.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/calendar-scaler.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/clusterswitch.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/core-pool.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/course-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/delete-hub.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/dns.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/github-token.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/google-sheets.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/new-hub.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
31 changes: 17 additions & 14 deletions admins/howto/new-image.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>Creating a new single user image</title>
<title>Create a New Single User Image</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -154,7 +154,7 @@
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../admins/pre-reqs.html">Contributing to DataHub</a></li><li class="breadcrumb-item"><a href="../../admins/howto/preview-local.html">Common Administrator Tasks</a></li><li class="breadcrumb-item"><a href="../../admins/howto/new-image.html">Creating a new single user image</a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../admins/pre-reqs.html">Contributing to DataHub</a></li><li class="breadcrumb-item"><a href="../../admins/howto/preview-local.html">Common Administrator Tasks</a></li><li class="breadcrumb-item"><a href="../../admins/howto/new-image.html">Create a New Single User Image</a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
</div>
Expand Down Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -425,9 +425,9 @@
<!-- main -->
<main class="content" id="quarto-document-content">

<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../admins/pre-reqs.html">Contributing to DataHub</a></li><li class="breadcrumb-item"><a href="../../admins/howto/preview-local.html">Common Administrator Tasks</a></li><li class="breadcrumb-item"><a href="../../admins/howto/new-image.html">Creating a new single user image</a></li></ol></nav>
<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../admins/pre-reqs.html">Contributing to DataHub</a></li><li class="breadcrumb-item"><a href="../../admins/howto/preview-local.html">Common Administrator Tasks</a></li><li class="breadcrumb-item"><a href="../../admins/howto/new-image.html">Create a New Single User Image</a></li></ol></nav>
<div class="quarto-title">
<h1 class="title">Creating a new single user image</h1>
<h1 class="title">Create a New Single User Image</h1>
</div>


Expand All @@ -444,18 +444,21 @@ <h1 class="title">Creating a new single user image</h1>
</header>


<p>When deploying a new hub, or moving from a shared single user server image, you might need to create a new image for users. We use <a href="https://github.com/jupyterhub/repo2docker">repo2docker</a> to do this.</p>
<p>There are two approaches to creating a repo2docker image: 1. Use a repo2docker-style image <a href="https://github.com/berkeley-dsep-infra/datahub/tree/staging/deployments/data100/image">template</a> (environment.yaml, etc) 2. Use a <a href="https://github.com/berkeley-dsep-infra/datahub/tree/staging/deployments/datahub/images/default">Dockerfile</a> (useful for larger/more complex images)</p>
<p>You might need to create a new user image when deploying a new hub, or changing from a shared single user server image. We use <a href="https://github.com/jupyterhub/repo2docker">repo2docker</a> to generate our images.</p>
<p>There are two approaches to creating a repo2docker image:</p>
<ol type="1">
<li>Use a repo2docker-style image <a href="https://github.com/berkeley-dsep-infra/datahub/tree/staging/deployments/data100/image">template</a> (environment.yaml, etc)</li>
<li>Use a <a href="https://github.com/berkeley-dsep-infra/datahub/tree/staging/deployments/datahub/images/default">Dockerfile</a> (useful for larger/more complex images)</li>
</ol>
<p>Generally, we prefer to use the former approach, unless we need to install specific packages or utilities outside of python/apt as <code>root</code>. If that is the case, only a <code>Dockerfile</code> format will work.</p>
<p>Of course, as always create a feature branch for your changes, and submit a PR when done.</p>
<section id="find-a-hub-to-use-as-a-template" class="level2">
<h2 class="anchored" data-anchor-id="find-a-hub-to-use-as-a-template">Find a hub to use as a template</h2>
<p>As always, create a feature branch for your changes, and submit a PR when done.</p>
<section id="use-an-existing-image-as-a-template" class="level2">
<h2 class="anchored" data-anchor-id="use-an-existing-image-as-a-template">Use an existing image as a template</h2>
<p>Browse through our <code>deployments/</code> directory to find a hub that is similar to the one you are trying to create. This will give you a good starting point.</p>
</section>
<section id="create-the-image-directory-for-your-new-hub" class="level2">
<h2 class="anchored" data-anchor-id="create-the-image-directory-for-your-new-hub">Create the <code>image/</code> directory for your new hub</h2>
<p>Create a new directory under <code>deployments/</code> with the name of your hub. This directory will contain the files that will be used to create the image.</p>
<p>Then, copy the contents (and any subdirectories) of the source <code>image/</code> directory in to the new directory.</p>
<section id="create-the-image-directory" class="level2">
<h2 class="anchored" data-anchor-id="create-the-image-directory">Create the image directory</h2>
<p>Create a new <code>image/</code> directory in the deployment. Then copy the contents (and any subdirectories) of the source <code>image/</code> directory in to the new directory.</p>
</section>
<section id="modify-hubploy.yaml-for-the-hub" class="level2">
<h2 class="anchored" data-anchor-id="modify-hubploy.yaml-for-the-hub">Modify <code>hubploy.yaml</code> for the hub</h2>
Expand Down
6 changes: 3 additions & 3 deletions admins/howto/new-packages.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -919,8 +919,8 @@ <h2 class="anchored" data-anchor-id="tips-for-upgrading-package">Tips for Upgrad
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
<a href="../../admins/howto/new-image.html" class="pagination-link" aria-label="Creating a new single user image">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Creating a new single user image</span>
<a href="../../admins/howto/new-image.html" class="pagination-link" aria-label="Create a New Single User Image">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Create a New Single User Image</span>
</a>
</div>
<div class="nav-page nav-page-next">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/preview-local.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/prometheus-grafana.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/rebuild-hub-image.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
6 changes: 3 additions & 3 deletions admins/howto/rebuild-postgres-image.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down Expand Up @@ -850,8 +850,8 @@ <h1 class="title">Customize the Per-User Postgres Docker Image</h1>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../../admins/howto/new-image.html" class="pagination-link" aria-label="Creating a new single user image">
<span class="nav-page-text">Creating a new single user image</span> <i class="bi bi-arrow-right-short"></i>
<a href="../../admins/howto/new-image.html" class="pagination-link" aria-label="Create a New Single User Image">
<span class="nav-page-text">Create a New Single User Image</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
Expand Down
2 changes: 1 addition & 1 deletion admins/howto/remove-users-orm.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/pre-reqs.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/storage.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion admins/structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion incidents/2017-02-09-datahub-db-outage.html
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion incidents/2017-02-24-autoscaler-incident.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion incidents/2017-02-24-proxy-death-incident.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion incidents/2017-03-06-helm-config-image-mismatch.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion incidents/2017-03-20-too-many-volumes.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
2 changes: 1 addition & 1 deletion incidents/2017-03-23-kernel-deaths-incident.html
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../admins/howto/new-image.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Creating a new single user image</span></a>
<span class="menu-text">Create a New Single User Image</span></a>
</div>
</li>
<li class="sidebar-item">
Expand Down
Loading

0 comments on commit 47de78b

Please sign in to comment.