Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Un-nest admin tasks. #6409

Merged
merged 1 commit into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ website:
- text: "Contributing"
href: admins/pre-reqs.qmd
- text: "Admin Tasks"
href: admins/howto/documentation.qmd
href: tasks/documentation.qmd
- text: "Policy"
href: policy/create_policy.qmd
page-navigation: true
Expand All @@ -35,27 +35,27 @@ website:
- admins/storage.qmd
- admins/cluster-config.qmd
- admins/credentials.qmd
- section: "Common Administrator Tasks"
contents:
- admins/howto/documentation.qmd
- admins/howto/dns.qmd
- admins/howto/core-pool.qmd
- admins/howto/new-hub.qmd
- admins/howto/rebuild-hub-image.qmd
- admins/howto/rebuild-postgres-image.qmd
- admins/howto/managing-multiple-user-image-repos.qmd
- admins/howto/new-image.qmd
- admins/howto/transition-image.qmd
- admins/howto/new-packages.qmd
- admins/howto/course-config.qmd
- admins/howto/calendar-scaler.qmd
- admins/howto/prometheus-grafana.qmd
- admins/howto/remove-users-orm.qmd
- admins/howto/delete-hub.qmd
- admins/howto/clusterswitch.qmd
- admins/howto/github-token.qmd
- admins/howto/google-sheets.qmd
- admins/howto/cheatsheet.qmd
- section: "Common Administrator Tasks"
contents:
- tasks/documentation.qmd
- tasks/dns.qmd
- tasks/core-pool.qmd
- tasks/new-hub.qmd
- tasks/rebuild-hub-image.qmd
- tasks/rebuild-postgres-image.qmd
- tasks/managing-multiple-user-image-repos.qmd
- tasks/new-image.qmd
- tasks/transition-image.qmd
- tasks/new-packages.qmd
- tasks/course-config.qmd
- tasks/calendar-scaler.qmd
- tasks/prometheus-grafana.qmd
- tasks/remove-users-orm.qmd
- tasks/delete-hub.qmd
- tasks/clusterswitch.qmd
- tasks/github-token.qmd
- tasks/google-sheets.qmd
- tasks/cheatsheet.qmd
- section: "Policy"
contents:
- policy/create_policy.qmd
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Calendar Node Pool Autoscaler
aliases:
- ../admins/howto/calendar-scaler.html
---

## Why scale node pools with Google Calendar?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Operations Cheatsheet
aliases:
- ../admins/howto/cheatsheet.html
---

We periodically need to perform various tasks that can be quickly described by short shell fragments. This page is meant to be a dumping ground for them. It may be useful on occasion to move such fragments into more relevant pages.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
title: Switching over a hub to a new cluster
aliases:
- ../admins/howto/clusterswitch.html
---

This document describes how to switch an existing hub to a new cluster. The example used here refers to moving all UC Berkeley Datahubs.

You might find it easier to switch to a new cluster if you're running a [very old k8s version](https://cloud.google.com/kubernetes-engine/docs/release-notes), or in lieu of performing a [cluster credential rotation](https://cloud.google.com/kubernetes-engine/docs/how-to/credential-rotation). Sometimes starting from scratch is easier than an iterative and potentially destructive series of operations.

## Create a new cluster
1. Create a new cluster using the specified [configuration](../cluster-config.qmd).
1. Create a new cluster using the specified [configuration](../admins/cluster-config.qmd).
2. Set up helm on the cluster according to the instructions here:
http://z2jh.jupyter.org/en/latest/setup-helm.html
- Make sure the version of helm you're working with matches the version Github Actions is using.
Expand Down
2 changes: 2 additions & 0 deletions docs/admins/howto/core-pool.qmd → docs/tasks/core-pool.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Core Node Pool Management
aliases:
- ../admins/howto/core-pool.html
---

## What is the core node pool?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Course Configuration
aliases:
- ../admins/howto/course-config.html
---

## Allocating Resources
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Delete or spin down a Hub
aliases:
- ../admins/howto/delete-hub.html
---

## Why delete or spin down a hub?
Expand Down
2 changes: 2 additions & 0 deletions docs/admins/howto/dns.qmd → docs/tasks/dns.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Update DNS
aliases:
- ../admins/howto/dns.html
---

Some staff have access to make and update DNS entries in the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Documentation
aliases:
- ../admins/howto/documentation.html
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Create Finely Grained Access Token
aliases:
- ../admins/howto/github-token.html
---

At <https://github.com/settings/personal-access-tokens/new>:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Reading Google Sheets from DataHub
aliases:
- ../admins/howto/google-sheets.html
---

Available in: DataHub
Expand Down
2 changes: 2 additions & 0 deletions docs/admins/howto/index.qmd → docs/tasks/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
---
title: Common Administrator Tasks
aliases:
- ../admins/howto/index.html
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Managing multiple user image repos
aliases:
- ../admins/howto/managing-multiple-user-image-repos.html
---

## Managing user image repos
Expand Down
1 change: 1 addition & 0 deletions docs/admins/howto/new-hub.qmd → docs/tasks/new-hub.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Create a New Hub
aliases:
- ../../en/latest/admins/howto/new-hub.html
- ../admins/howto/new-hub.html
---

## Why create a new hub?
Expand Down
2 changes: 2 additions & 0 deletions docs/admins/howto/new-image.qmd → docs/tasks/new-image.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Create a New Single User Image
aliases:
- ../admins/howto/new-image.html
---

You might need to create a new user image when deploying a new hub, or changing
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Testing and Upgrading New Packages
aliases:
- ../admins/howto/new-packages.html
---

It is helpful to test package additions and upgrades for yourself before
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Prometheus and Grafana
aliases:
- ../admins/howto/prometheus-grafana.html
---

# Accessing the Prometheus Server
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Customize the Hub Docker Image"
aliases:
- ../admins/howto/rebuild-hub-image.html
---

We use a customized JupyterHub docker image so we can install extra packages
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Customize the Per-User Postgres Docker Image"
aliases:
- ../admins/howto/rebuild-postgres-image.html
---

We provide each student on `data100` with a postgresql server. We want the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: JupyterHub ORM Maintenance
aliases:
- ../admins/howto/remove-users-orm.html
---

## Performance
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Transition Single User Image to GitHub Actions
aliases:
- ../admins/howto/transition-image.html
---

Single user images have been maintained within the main datahub repo since its inception, however we decided to move them into their own repositories. It will make testing notebooks easier, and we will be able to delegate write access to course staff if necessary.
Expand Down
Loading