Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): Add cgroups v2 configuration instructions to README #790

Merged
merged 8 commits into from
Jan 11, 2022
Merged

docs(readme): Add cgroups v2 configuration instructions to README #790

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9986db5
Update README with cgroups v2 configuration instructions
Jan 11, 2022
d66c955
Fix formatting
Jan 11, 2022
e4e3f7c
Move instructions down to the RUN section
Jan 11, 2022
3effa18
Change capitalization
Jan 11, 2022
42bf391
Add comma
Jan 11, 2022
b32a17d
Remove any mention of Docker
Jan 11, 2022
532847b
Grammar
Jan 11, 2022
3e6ccaf
Grammar and phrasing
Jan 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,17 @@ 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) 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 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

Cryostat can be configured via the following environment variables
Expand Down