Skip to content

Commit

Permalink
docs: fix misc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
consideRatio committed Apr 16, 2024
1 parent e82b095 commit 1f71da0
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions docs/howto/features/cloud-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ This AWS IAM Role is managed via terraform.
`````{tab-set}
````{tab-item} GCP
:sync: gcp-key
```yaml
```
hub_cloud_permissions = {
"<hub-name-slug>": {
"<hub-name-slug>" : {
allow_access_to_external_requester_pays_buckets : true,
bucket_admin_access : ["bucket-1", "bucket-2"]
hub_namespace : "<hub-name>"
Expand All @@ -60,9 +60,9 @@ This AWS IAM Role is managed via terraform.
````{tab-item} AWS
:sync: aws-key
```bash
```
hub_cloud_permissions = {
"<hub-name-slug>": {
"<hub-name-slug>" : {
bucket_admin_access : ["bucket-1", "bucket-2"]
hub_namespace : "<hub-name>"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/features/dask.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Setting up dask nodepools with terraform can be done by adding the following to the cluster's terraform config file:

```terraform
```
# Setup a single node pool for dask workers.
#
# A not yet fully established policy is being developed about using a single
Expand Down
12 changes: 6 additions & 6 deletions docs/howto/features/dedicated-nodepool.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Some hubs on shared clusters require dedicated nodepools, for a few reasons:
1. Setup a new nodepool in terraform, via the `<cluster-name>.tfvars` for the
cluster. Add the new nodepool to `notebook_nodes`:

```terraform
```
notebook_nodes = {
"<community-name>": {
"<community-name>" : {
min: 0,
max: 100,
machine_type: "<machine-type>",
Expand All @@ -25,16 +25,16 @@ Some hubs on shared clusters require dedicated nodepools, for a few reasons:
taints: [{
key: "2i2c.org/community",
value: "<community-name>",
effect: "NO_SCHEDULE"
effect: "NO_SCHEDULE",
}],
gpu: {
enabled: false,
type: "",
count: 0
count: 0,
},
resource_labels: {
"community": "<community-name>"
}
"community": "<community-name>",
},
}
}
```
Expand Down
10 changes: 5 additions & 5 deletions docs/howto/features/gpu.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The `notebook_nodes` variable for our GCP terraform accepts a `gpu`
parameter, which can be used to provision a GPU nodepool. An example
would look like:

```terraform
```
notebook_nodes = {
"gpu-t4": {
min: 0,
Expand All @@ -49,16 +49,16 @@ notebook_nodes = {
gpu: {
enabled: true,
type: "nvidia-tesla-t4",
count: 1
count: 1,
},
# Optional, in case we run into resource exhaustion in the main zone
zones: [
"us-central1-a",
"us-central1-b",
"us-central1-c",
"us-central1-f"
]
}
"us-central1-f",
],
},
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/howto/upgrade-cluster/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ cluster is unused or that the maintenance is communicated ahead of time.

1. *Install or upgrade CLI tools*

Install required tools as documented in [](new-cluster:aws-required-tools),
Install required tools as documented in [](new-cluster:prerequisites),
and ensure you have a recent version of eksctl.

```{warning}
Expand All @@ -35,7 +35,7 @@ cluster is unused or that the maintenance is communicated ahead of time.
Before upgrading an EKS cluster, it could be a good time to consider changes
to `eksctl/template.jsonnet` since this cluster's jsonnet template was last
generated, which it was initially according to
[](new-cluster:aws:generate-cluster-files).
[](new-cluster:generate-cluster-files).

To do this first ensure `git status` reports no changes, then generate new
cluster files using the deployer script, then restore changes to everything
Expand Down
2 changes: 2 additions & 0 deletions docs/hub-deployment-guide/new-cluster/new-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ terraform to provision supporting infrastructure, such as storage buckets.

This guide will assume you have already followed the guidance in [](/topic/infrastructure/cluster-design) to select the appropriate infrastructure.

(new-cluster:prerequisites)=
## Prerequisites

`````{tab-set}
Expand Down Expand Up @@ -87,6 +88,7 @@ N/A
````
`````

(new-cluster:generate-cluster-files)=
### Generate cluster files

We automatically generate the files required to setup a new cluster:
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ sre-guide/common-problems-solutions.md

These sections walk an engineer step-by-step through the workflow of setting up a new 2i2c-managed JupyterHub.

- If there isn't a cloud account setup yet, start with [](new-cloud-account)
- If there isn't a cloud account setup yet, start with [](hub-deployment-guide:runbooks:phase1)
- If there isn't a Kubernetes cluster setup yet, start with [](new-cluster)
- If all you need to do is deploy the hub, start with [](new-hub)

Expand Down
4 changes: 1 addition & 3 deletions docs/topic/billing/chargeable-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -476,9 +476,7 @@ exposed to the public internet at all, which theoretically adds another
layer of security as well.

```{image} https://hackmd.io/_uploads/H1IYevYi6.png)
:alt: Dr. Who Meme about Cloud NAT
One of the many memes about Cloud NAT being expensive, from [QuinnyPig](https://twitter.com/QuinnyPig/status/1357391731902341120). Many seem far more violent. See [this post](https://www.lastweekinaws.com/blog/the-aws-managed-nat-gateway-is-unpleasant-and-not-recommended/) for more information.
:alt: Dr. Who Meme about Cloud NAT. One of the many memes about Cloud NAT being expensive, from [QuinnyPig](https://twitter.com/QuinnyPig/status/1357391731902341120). Many seem far more violent. See [this post](https://www.lastweekinaws.com/blog/the-aws-managed-nat-gateway-is-unpleasant-and-not-recommended/) for more information.
```

However, using a cloud NAT for outbound internet access is the **single most
Expand Down

0 comments on commit 1f71da0

Please sign in to comment.