2i2cdocs

  • About the Service Administer a Hub Infrastructure Guide
  • 2i2c Team Compass Mailing List Twitter GitHub
    • support

    Infrastructure Guide

    Get started

    • Documentation structure
    • Setting up your local environment to work on this repo

    SRE guide

    • Support tasks
      • Access home directories of users of a hub
      • Decrypt encrypted information sent to support@2i2c.org
      • Build a Docker Image remotely
      • Apply Cloud Credits
      • Give Grafana access to community representative
    • Manage cloud and Kubernetes infrastructure
      • Authenticating with cloud providers for 2i2c engineers
      • Manual node administration
      • Cull resources
    • Scaling nodepools
      • AWS
      • Azure
    • Common problems and their solutions

    Hub deployment guide

    • Create new cloud accounts
      • Create a new GCP project
      • Create a new AWS account
    • Add Kubernetes clusters
      • New Kubernetes cluster on GCP or Azure
      • New Kubernetes cluster on AWS
    • Deploy support components
      • Configure and deploy the support chart
      • Setup grafana dashboards
      • Register the cluster’s Prometheus server with the central Grafana
    • Deploy a new hub
    • Enable authentication
      • Auth0
      • GitHub Orgs and Teams
      • CILogon
    • Other hub-related operations
      • Manually deploy a config change
      • Move a Hub across clusters
      • Delete a hub

    How-to guides

    • Enable specific hub features
      • Enable user access to cloud features
      • Enable access to GPUs
      • Allow users to push to GitHub
      • Configure the hub login page
      • Deploy authenticated static websites along the hub
      • Setup object storage buckets
      • Setup a database server per user
      • Setup a shared database for all users on the hub
      • Enable user image features
    • Manage domains of hubs
      • Set a community-specific domain using a CNAME
      • Setup Domain Redirects
      • Override a hub’s domain name
    • Enable GitHub authentication for Grafana
    • Manage a hub’s user environment
    • Manually setup an NFS server
    • Troubleshooting
      • Look at logs to troubleshoot issues
      • SSH into nodes

    Topic guides

    • Access and credentials
      • Authenticating with cloud providers for 2i2c engineers
      • Secrets and private keys
    • Infrastructure
      • Configuration structure
      • Cluster design considerations
      • Terraform
      • Hub helm charts
      • Network policy
      • Hub image
      • User home directory storage
    • Monitoring and alerting
      • Grafana dashboards
      • Simple HTTPS uptime checks
    • Features available on the hubs

    Reference

    • List of running hubs
    • Our CI/CD system
      • Automatic hub deployment
      • Automatically bumping image tags and helm sub-chart versions
    • Terraform Reference
    • Tools used in this repo

    Contributing

    • Review and merge guidelines
    Theme by the Executable Book Project
    • repository
    • open issue
    • .md

    Other hub-related operations

    Other hub-related operations#

    These sections cover other operations around deploying, migrating, and removing hubs from Kubernetes clusters. They also cover more specific use-cases for special infrastructure set-ups.

    • Manually deploy a config change
      • Deploy a single hub
      • Run a health check on the hub
    • Move a Hub across clusters
      • 1. Setup a new hub
      • 2. Copy home directories
      • 3. Set up Grafana Dashboards for the new cluster
      • 4. Take down the current hub
      • 5. Transfer the JupyterHub Database
      • 6. Delete all user pods from the old cluster
      • 7. Do one final copying of the home directories
      • 8. Transfer DNS
      • 9. Cleanup the old cluster and NFS VM
    • Delete a hub
      • 1. Manage existing data
      • 2. Remove the hub values file
      • 3. Delete the Helm release and namespace
      • 4. Delete the OAuth application

    previous

    CILogon

    next

    Manually deploy a config change

    By 2i2c.org
    © Copyright 2020, 2i2c.org.