search

2i2c-org / docs

Documentation for 2i2c community JupyterHubs.
https://docs.2i2c.org
9 stars 17 forks source link

How-to guide for adding persistent storage buckets #215

Closed jnywong closed 5 months ago

jnywong commented 6 months ago

Develop a "runbook" style guide for Hub Admins to configure Cloud Object Storage for their hub.

See https://docs.2i2c.org/admin/howto/manage-object-storage-aws/

jmunroe commented 6 months ago

Related:

jnywong commented 6 months ago

Related:

choldgraf commented 6 months ago

I hadn't thought of user docs as "runbooks" before, but I think it's cool how @jnywong framed this in the top comment. Runbooks are ways for organizations to share knowledge from more experienced team members. When 2i2c creates runbooks for communities to follow, we are sharing our knowledge/experience in order to empower communities to share the responsibility of running infrastructure for their service. It's also a way to share expertise and uplevel community skills.

I'm curious if this is how you're thinking about it as well...

jnywong commented 5 months ago

I'm curious if this is how you're thinking about it as well...

Yes, that's exactly how I am looking at this piece of documentation. From the Diátaxis framework, I am working in the "How-to" quadrant so that a hub admin can quickly achieve the goal of simple file management in cloud object storage.

jnywong commented 5 months ago

Yuvi has pointed me to check out https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/325

jmunroe commented 5 months ago

I've now reviewed the PR Add how to guide to managing files in cloud object storage #221 I don't want to block merging of that PR but this issue is larger than a single task. I think we should

  1. Merge PR #221
  2. Create a new epic around 'Document Use of Cloud Object Storage' (which should include a reference to that Openscapes example)
  3. Close this particular issue.