[skip ci] automated docs update

2024-02-18 12:48:54 +00:00 · 2024-02-18 12:48:54 +00:00 · 5bd50ff98e
parent be184663af
commit 5bd50ff98e
1 changed files with 151 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,152 @@
 # xoxys.kernel
+
+[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.kernel/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.kernel)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.kernel/src/branch/main/LICENSE)
+
+Configure kernel parameters and coredump settings.
+
+## Table of content
+
+- [Requirements](#requirements)
+- [Default Variables](#default-variables)
+  - [kernel_blacklist_modules](#kernel_blacklist_modules)
+  - [kernel_coredump_enabled](#kernel_coredump_enabled)
+  - [kernel_custom_config](#kernel_custom_config)
+  - [kernel_disable_modules](#kernel_disable_modules)
+  - [kernel_ipv4_forwarding_enabled](#kernel_ipv4_forwarding_enabled)
+  - [kernel_ipv4_ping_group_range](#kernel_ipv4_ping_group_range)
+  - [kernel_ipv6_enabled](#kernel_ipv6_enabled)
+  - [kernel_ipv6_forwarding_enabled](#kernel_ipv6_forwarding_enabled)
+  - [kernel_namespace_support_enabled](#kernel_namespace_support_enabled)
+  - [kernel_printk](#kernel_printk)
+- [Dependencies](#dependencies)
+- [License](#license)
+- [Author](#author)
+
+---
+
+## Requirements
+
+- Minimum Ansible version: `2.10`
+
+## Default Variables
+
+### kernel_blacklist_modules
+
+#### Default value
+
+```YAML
+kernel_blacklist_modules: []
+```
+
+### kernel_coredump_enabled
+
+#### Default value
+
+```YAML
+kernel_coredump_enabled: true
+```
+
+### kernel_custom_config
+
+#### Default value
+
+```YAML
+kernel_custom_config: []
+```
+
+#### Example usage
+
+```YAML
+kernel_custom_config:
+  - file: 90-example
+    content:
+      - name: vm.panic_on_oom
+        value: 0
+      - name: vm.overcommit_memory
+        value: 1
+```
+
+### kernel_disable_modules
+
+#### Default value
+
+```YAML
+kernel_disable_modules:
+  - usb-storage
+  - firewire-core
+  - dccp
+  - sctp
+  - tipc
+  - rds
+  - bluetooth
+  - cramfs
+  - squashfs
+  - udf
+```
+
+### kernel_ipv4_forwarding_enabled
+
+#### Default value
+
+```YAML
+kernel_ipv4_forwarding_enabled: false
+```
+
+### kernel_ipv4_ping_group_range
+
+#### Default value
+
+```YAML
+kernel_ipv4_ping_group_range: _unset
+```
+
+#### Example usage
+
+```YAML
+kernel_ipv4_ping_group_range: 0 2000000
+```
+
+### kernel_ipv6_enabled
+
+#### Default value
+
+```YAML
+kernel_ipv6_enabled: false
+```
+
+### kernel_ipv6_forwarding_enabled
+
+#### Default value
+
+```YAML
+kernel_ipv6_forwarding_enabled: false
+```
+
+### kernel_namespace_support_enabled
+
+#### Default value
+
+```YAML
+kernel_namespace_support_enabled: false
+```
+
+### kernel_printk
+
+#### Default value
+
+```YAML
+kernel_printk: 4 4 1 7
+```
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+[Robert Kaussow](https://gitea.rknet.org/xoxys)