From 9986db54a57f4dd20a5c3772551ffe777ace0e3a Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Mon, 10 Jan 2022 19:31:23 -0500 Subject: [PATCH 1/8] Update README with cgroups v2 configuration instructions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 314701a114..845addb689 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,14 @@ Build Requirements: Run Requirements: - Kubernetes/OpenShift/Minishift, Podman/Docker, or other container platform +- If running on Podman/Docker, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. +This allows resource configuration for any rootless containers running on Podman. + +First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure Podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html)*. + +*If your Podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of +runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). + ## BUILD ### Setup Dependencies From d66c955bb8b0c3d499e29a7cc97897e72b9a92fe Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Mon, 10 Jan 2022 19:33:08 -0500 Subject: [PATCH 2/8] Fix formatting --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 845addb689..1535ba33fd 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,7 @@ Run Requirements: - Kubernetes/OpenShift/Minishift, Podman/Docker, or other container platform - If running on Podman/Docker, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. -This allows resource configuration for any rootless containers running on Podman. - -First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure Podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html)*. +This allows resource configuration for any rootless containers running on Podman. First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure Podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html)*. *If your Podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). From e4e3f7c13b1ccdaebda6712d7eb1871c99050646 Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Mon, 10 Jan 2022 19:39:52 -0500 Subject: [PATCH 3/8] Move instructions down to the RUN section --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1535ba33fd..9343481b3d 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,6 @@ Build Requirements: Run Requirements: - Kubernetes/OpenShift/Minishift, Podman/Docker, or other container platform -- If running on Podman/Docker, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. -This allows resource configuration for any rootless containers running on Podman. First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure Podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html)*. - -*If your Podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of -runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). - ## BUILD ### Setup Dependencies @@ -94,12 +88,19 @@ exec:exec@destroy-pod` ### Run on Kubernetes/Openshift * See the [cryostat-operator](https://github.com/cryostatio/cryostat-operator) -### Run on local podman +### Run on local podman* * `run.sh` -### Run on local podman with Grafana, jfr-datasource and demo application +### Run on local podman with Grafana, jfr-datasource and demo application* * `smoketest.sh` +*To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. +This allows resource configuration for any rootless containers running on Podman. + +First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure Podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html)*. + +Note: If your Podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). + ## CONFIGURATION Cryostat can be configured via the following environment variables From 3effa18f856e09c7b5ecd0d324d6f407ed14b724 Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Mon, 10 Jan 2022 19:42:52 -0500 Subject: [PATCH 4/8] Change capitalization --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9343481b3d..1be5466f48 100644 --- a/README.md +++ b/README.md @@ -95,11 +95,11 @@ exec:exec@destroy-pod` * `smoketest.sh` *To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. -This allows resource configuration for any rootless containers running on Podman. +This allows resource configuration for any rootless containers running on podman. -First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure Podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html)*. +First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). -Note: If your Podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). +Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). ## CONFIGURATION From 42bf391f7de85fa7dcf9e15eacd3f12c8d16f1d4 Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Mon, 10 Jan 2022 19:45:02 -0500 Subject: [PATCH 5/8] Add comma --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1be5466f48..e4357eea11 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ exec:exec@destroy-pod` *To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. This allows resource configuration for any rootless containers running on podman. -First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2 can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). +First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2, can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). From b32a17d665cd66c978537658f5feffcbf590c0c4 Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Tue, 11 Jan 2022 12:31:59 -0500 Subject: [PATCH 6/8] Remove any mention of Docker --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e4357eea11..ed2331e147 100644 --- a/README.md +++ b/README.md @@ -95,11 +95,9 @@ exec:exec@destroy-pod` * `smoketest.sh` *To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. -This allows resource configuration for any rootless containers running on podman. +This allows resource configuration for any rootless containers running on podman. To ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). -First, update your Docker installation; instructions to do so, as well as how to enable cgroups v2, can be found [here](https://docs.docker.com/config/containers/runmetrics/#changing-cgroup-version). Finally, to ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). - -Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in these instructions. This version of runc supports cgroups v2, as stated in the [Docker documentation on the subject](https://docs.docker.com/config/containers/runmetrics/#running-docker-on-cgroup-v2). +Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in the instructions. This version of runc supports cgroups v2. The article refers to an older version of runc. ## CONFIGURATION From 532847be0cef04bfebb221dfe2786946b64cb126 Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Tue, 11 Jan 2022 12:34:06 -0500 Subject: [PATCH 7/8] Grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ed2331e147..72df4436b7 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ exec:exec@destroy-pod` *To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. This allows resource configuration for any rootless containers running on podman. To ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). -Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in the instructions. This version of runc supports cgroups v2. The article refers to an older version of runc. +Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in the instructions, since this version of runc supports cgroups v2. The article refers to an older version of runc. ## CONFIGURATION From 3e6ccaf23d0870b22e1765fdbbce3d91db82f983 Mon Sep 17 00:00:00 2001 From: Hareet Dhillon Date: Tue, 11 Jan 2022 15:10:30 -0500 Subject: [PATCH 8/8] Grammar and phrasing --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 72df4436b7..96ba7546b7 100644 --- a/README.md +++ b/README.md @@ -94,10 +94,10 @@ exec:exec@destroy-pod` ### Run on local podman with Grafana, jfr-datasource and demo application* * `smoketest.sh` -*To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) must be enabled. +*To run on local podman, [cgroups v2](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) should be enabled. This allows resource configuration for any rootless containers running on podman. To ensure podman works with cgroups v2, follow these [instructions](https://podman.io/blogs/2019/10/29/podman-crun-f31.html). -Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it crun as recommended in the instructions, since this version of runc supports cgroups v2. The article refers to an older version of runc. +Note: If your podman runtime is set to runc v1.0.0-rc91 or later it is not necessary to change it to crun as recommended in the instructions, since this version of runc supports cgroups v2. The article refers to an older version of runc. ## CONFIGURATION