Skip to content

Commit

Permalink
Add docs on how to enable extra_admin_members
Browse files Browse the repository at this point in the history
  • Loading branch information
yuvipanda committed Jun 27, 2023
1 parent e9623e8 commit a8925d5
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion docs/howto/features/buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,46 @@ on why users want this!
You can also add other env vars pointing to other buckets users requested.

5. Get this change deployed, and users should now be able to use the buckets!
Currently running users might have to restart their pods for the change to take effect.
Currently running users might have to restart their pods for the change to take effect.


## Allowing access to buckets from outside the JupyterHub

### GCP

Some hub users want to be able to write to the bucket from outside the hub,
primarily for large data transfer from on-premise systems. Since
[Google Groups](https://groups.google.com) can be used to control access to
GCS buckets, it can be used to allow arbitrary users to write to the bucket!

1. With your `2i2c.org` google account, go to [Google Groups](https://groups.google.com) and create a new Google Group with the name
"<bucket-name>-writers", where "<bucket-name>" is the name of the bucket
we are going to grant write access to.

2. Grant "Group Owner" access to the community champion requesting this feature.
They will be able to add / remove users from the group as necessary, and
thus manage access without needing to involve 2i2c engineers.

3. In the `user_buckets` definition for the bucket in question, add the group
name as an `extra_admin_members`:

```terraform
user_buckets = {
"persistent": {
"delete_after": null,
"extra_admin_members": [
"group:<name-of-group>@googlegroups.com"
]
}
}
```

Apply this terraform change to create the appropriate permissions for members
of the group to have full read/write access to that GCS bucket.

4. We want the community champions to handle granting / revoking access to
this google group, as well as produce community specific documentation on
how to actually upload data here. We currently do not have a template of
how end users can use this, but something can be stolen from the
[documentation for LEAP users](https://leap-stc.github.io/leap-pangeo/jupyterhub.html#i-have-a-dataset-and-want-to-work-with-it-on-the-hub-how-do-i-upload-it)

0 comments on commit a8925d5

Please sign in to comment.