Skip to main content
Ctrl+K

2i2c docs

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
    • GitHub Orgs and Teams
    • CILogon
    • Auth0
  • 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
    • Make an ephemeral hub
  • Calculate how much cloud infrastructure costs
  • 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
  • Upgrade Kubernetes clusters
    • Upgrade Kubernetes cluster on AWS
  • 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
  • Repository
  • Open issue
  • .md

Support tasks

Support tasks#

This section lists various tasks that engineers might do as part of support requests.

There is also a wiki with per-cluster support notes.

  • Access home directories of users of a hub
  • Decrypt encrypted information sent to support@2i2c.org
    • Pre-requisites
    • Decrypt received message
  • Build a Docker Image remotely
    • Building images remotely
    • Testing images remotely
    • Limitations
  • Apply Cloud Credits
    • Amazon Web Services
    • Google Cloud
  • Give Grafana access to community representative

previous

Setting up your local environment to work on this repo

next

Access home directories of users of a hub

By 2i2c.org

© Copyright 2020, 2i2c.org.

By the International Interactive Computing Collaboration (2i2c)