Additional Configuration

• Enabling Cloudflare proxy

• Container PID Limit

  • Example of usage

• Throttles Limits

  • Example of usage

• Installer Limits

  • Example of usage

• Other values

WARNING

These are advanced configurations for Kuber. You risk breaking Kuber and making containers unusable if you misconfigure something. Proceed only if you know what each configuration value does.

You must apply all changes to your Kuber config.yml file located at /etc/kubectyl and restart kuber. Verify your config file using Yaml Lint should you receive errors related to YAML parsing.

Enabling Cloudflare proxy

To enable Cloudflare proxy, you must change the Kuber port to one of the Cloudflare HTTPS ports with caching enabled (more info here), such as 8443, because Cloudflare only supports HTTP on port 8080. Select your Cluster in the Admin Panel, and on the settings tab, change the port. Make sure that you set "Not Behind Proxy" when using Full SSL settings in Cloudflare. Then on Cloudflare dashboard, your FQDN must have an orange cloud enabled beside it.

You are unable to proxy the SFTP port through Cloudflare unless you have their enterprise plan.

Container PID Limit

You can change the total number of processes that can be active in a container at any given moment by changing the container_pid_limit value. The default value is 512. You can set it to 0 to disable the limit completely. However, this is not recommended as the limit prevents malicious overloading of the node. Restart kuber and your game server to apply the new limit.

Example of usage

docker:
  ...
  container_pid_limit: 512
  ...

Throttles Limits

You can use these settings to adjust or completely disable throttling.

Setting Key	Default Value	Notes
enabled	true	Whether or not the throttler is enabled
lines	2000	Total lines that can be output in a given line_reset_interval period
maximum_trigger_count	5	Amount of times throttle limit can be triggered before the server will be stopped
line_reset_interval	100	The amount of time after which the number of lines processed is reset to 0
decay_interval	10000	Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented
stop_grace_period	15	Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle
write_limit	0	Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s
download_limit	0	Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s

Example of usage

throttles:
  enabled: true
  lines: 2000
  maximum_trigger_count: 5
  line_reset_interval: 100
  decay_interval: 10000
  stop_grace_period: 15

Installer Limits

Defines the limits on the installer containers that prevents a server's installation process from unintentionally consuming more resources than expected. This is used in conjunction with the server's defined limits. Whichever value is higher will take precedence in the install containers.

Setting Key	Default Value	Notes
memory	1024	The maximum amount of memory install container can use unless server memory limit is higher than this value
cpu	100	The maximum amount of cpu install container can use unless server cpu limit is higher than this value

Example of usage

installer_limits:
  memory: 1024
  cpu: 100

Other values

More commonly discussed values. View all Kuber config values and explanations in these two files.

Setting Key	Default Value	Notes
debug	false	Force Kuber to run in debug mode
tmpfs_size	100	The size of the /tmp directory in MB when mounted into a container
websocket_log_count	150	The number of lines to display in the console
detect_clean_exit_as_crash	true	Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button
(crash detection) timeout	60	Timeout between server crashes that will not cause the server to be automatically restarted
app_name	"Kubectyl"	Changes the name of the daemon, shown in the panel's game console
check_permissions_on_boot	true	Check all file permissions on each boot. Disable this when you have a very large amount of files and the server startup is hanging on checking permissions