From 58bbdad7f7e9e52476ba83132be53af2f6192824 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Tue, 6 Aug 2024 17:20:46 -0500 Subject: [PATCH 1/5] Document inotify config for kind deployments Fixes #495 --- docs/docs/how-tos/nebari-local.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 15335b4a9..46543279d 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -159,6 +159,15 @@ security: tag: sha-b4a2d1e ``` +### Increase fs watches + +Depending on your host system, you may need to increase the `fs.inotify.max_user_watches` and +`fs.inotify.max_user_instances kernel parameters` if you see a `too many open files` in the logs of +a failing pod. + +See the [kind troubleshooting +docs](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files) + ## Deploying Nebari With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time with: From 8a2cdd862781bc3b3d23f0fb5607323178dadce7 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Thu, 26 Sep 2024 11:12:14 -0500 Subject: [PATCH 2/5] Add user watches and instances snippet --- docs/docs/how-tos/nebari-local.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 46543279d..bba889afd 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -165,6 +165,11 @@ Depending on your host system, you may need to increase the `fs.inotify.max_user `fs.inotify.max_user_instances kernel parameters` if you see a `too many open files` in the logs of a failing pod. +```bash +sudo sysctl fs.inotify.max_user_watches=524288 +sudo sysctl fs.inotify.max_user_instances=512 +``` + See the [kind troubleshooting docs](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files) From 1b0ae94b73e4fc307b90cd008be30ea9d7c03e15 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Thu, 26 Sep 2024 11:13:16 -0500 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Kim Pevey --- docs/docs/how-tos/nebari-local.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index bba889afd..30b98a8c9 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -162,7 +162,7 @@ security: ### Increase fs watches Depending on your host system, you may need to increase the `fs.inotify.max_user_watches` and -`fs.inotify.max_user_instances kernel parameters` if you see a `too many open files` in the logs of +`fs.inotify.max_user_instances kernel parameters` if you see the error "too many open files" in the logs of a failing pod. ```bash @@ -171,7 +171,7 @@ sudo sysctl fs.inotify.max_user_instances=512 ``` See the [kind troubleshooting -docs](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files) +docs](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files) for more information. ## Deploying Nebari From a46bfff3fa7783bedd74c2d677940cbbc1829d39 Mon Sep 17 00:00:00 2001 From: Blake Rosenthal Date: Fri, 27 Sep 2024 10:32:38 -0700 Subject: [PATCH 4/5] Update and format GCP roles --- docs/docs/how-tos/nebari-gcp.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md index 2979c035e..90ef2a08e 100644 --- a/docs/docs/how-tos/nebari-gcp.md +++ b/docs/docs/how-tos/nebari-gcp.md @@ -66,7 +66,10 @@ management. If it's your first time creating a service account, please follow [these detailed instructions](https://cloud.google.com/iam/docs/creating-managing-service-accounts) to create a Google Service Account with the following roles attached: -"roles/editor", "roles/resourcemanager.projectIamAdmin" and "roles/container.admin". +- [`roles/editor`](https://cloud.google.com/iam/docs/understanding-roles#editor) +- [`roles/resourcemanager.projectIamAdmin`](https://cloud.google.com/iam/docs/understanding-roles#resourcemanager.projectIamAdmin) +- [`roles/container.admin`](https://cloud.google.com/iam/docs/understanding-roles#container.admin) +- [`roles/storage.admin`](https://cloud.google.com/iam/docs/understanding-roles#storage.admin) For more information about roles and permissions, see the [Google Cloud Platform IAM documentation](https://cloud.google.com/iam/docs/choose-predefined-roles). Remember to check the active project before creating resources, especially if From f3c7c29a2b6571bf6cc577bb83d774faebe052ff Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 7 Oct 2024 22:50:20 +0000 Subject: [PATCH 5/5] [pre-commit.ci] pre-commit autoupdate MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit updates: - [github.com/pre-commit/pre-commit-hooks: v4.6.0 → v5.0.0](https://github.com/pre-commit/pre-commit-hooks/compare/v4.6.0...v5.0.0) --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index caf603929..98bbd1475 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -36,7 +36,7 @@ repos: # Misc... - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.6.0 + rev: v5.0.0 # ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available hooks: # Autoformat: Makes sure files end in a newline and only a newline