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.

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

github: add issue template and small readme addition #647

Merged
merged 2 commits into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
The template below is mostly useful for bug reports and support questions.
Feel free to remove anything which doesn't apply to you and add more information where it makes sense.

# Required information

* Distribution:
* `cat /etc/os-release` or `cat /etc/lsb-release`
* LXCFS version:
* The output of
* `uname -a`
* `cat /proc/1/mounts`
* `ps aux | grep lxcfs`
* LXCFS logs

# Issue description

A brief description of what failed or what could be improved.

If you have LXCFS crashing, please, collect a crash dump.

# Steps to reproduce

1. Step one
2. Step two
3. Step three

# Information to attach

- [ ] any relevant kernel output (`dmesg`)
- [ ] LXCFS daemon output / logs
- [ ] LXCFS configuration (Which options were used to start a LXCFS daemon? `ps aux | grep lxcfs`)
- [ ] in case of crash, a core dump (please, read [how to collect a core dump](https://github.com/lxc/lxcfs?tab=readme-ov-file#core-dump))
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ lxc.kmsg = 0
lxc.include = /usr/share/lxc/config/common.conf.d/00-lxcfs.conf
```

## Using with Docker
### Using with Docker

```
docker run -it -m 256m --memory-swap 256m \
Expand Down Expand Up @@ -163,3 +163,29 @@ As a result, LXCFS had to make some compromise which go as follow:
usage (100% full) is reported. This provides adequate reporting of
the memory consumption while preventing applications from assuming more
SWAP is available.

## Issue reporting

### Core dump

In case of LXCFS crash, it can be extremely useful for us to have a core dump of the LXCFS process memory.

1. Please, check `/var/crash` and `coredumpctl list` just in case if you already have an LXCFS core dump file
2. If not, you can use the following way to collect it from your system:

On the machine where you run LXCFS, execute as root:
```
# save an old core_pattern setting value:
cat /proc/sys/kernel/core_pattern > /root/core_pattern.old_value.bak

# set a new one to collect all core dumps:
echo '|/bin/sh -c $@ -- eval exec gzip --fast > /var/crash/core-%e.%p.gz' > /proc/sys/kernel/core_pattern

# wait for the next LXCFS crash and check
ls -lah /var/crash

# there should be a file with a name like "core-lxcfs.80581.gz". Please, upload it somewhere and share with us.

# restore the old "core_pattern" value:
cat /root/core_pattern.old_value.bak > /proc/sys/kernel/core_pattern
```
Loading