Group

Just like Tasks, groups are one of the basic components of CloudNet. Groups allow tasks that require similar or identical settings to be grouped. For example, at the group level, Templates and other options can be set, which are applied to services in addition to the options of the task.

Name

The name of a group is a unique characteristic for this group. Based on the name, groups can be added to Tasks under the Groups section. Services of the task then inherit the options of the task itself and all registered groups.

JvmOptions

The JvmOptions setting allows you to change which options the Java Virtual Machine is started with. Options such as -DPaper.IgnoreJavaVersion=true can be set.

Further details about JvmOptions can be found in the tasks section, see here.

ProcessParameters

The ProcessParameters setting allows you to set additional parameters for the services of the group. Here options such as nogui can be set. The options set here are built into the start command as follows: java -jar paper.jar nogui

Further details about ProcessParameters can be found in the tasks section, see here.

EnvironmentVariables

The EnvironmentVariables setting allows you to set environment variables for the services of the group. Each variable has a key and a value that is hidden behind this key. With this key, the value can later be read out on the service.

Further details about EnvironmentVariables can be found in the tasks section, see here.

TargetEnvironments

The TargetEnvironments option allows you to assign a group to a certain Environment. Through this assignment, the group is applied to all tasks or services of tasks that have one of the environments set. This allows groups to be assigned at a higher level without explicit assignment with the Groups option in tasks.

If you want, for example, to have a global group that is applied to all services that are assigned to the MINECRAFT_SERVER environment (see here), this can be achieved with the option as follows:

"targetEnvironments": [
  "MINECRAFT_SERVER"
],

In this case, all servers of the MINECRAFT_SERVER environment would receive all options of the group. Setting the targetEnvironments is equivalent to explicitly setting the group under Groups for every task with the MINECRAFT_SERVER environment.

Templates

The Templates setting allows you to configure which files Services of the group should contain. By default, all templates from the option are copied to the service to be created and then it is started.

Further details about Templates can be found in the tasks section, see here.

Deployments

The Deployments setting allows you to determine which files of a service should be copied back to a given template after stopping.

Further details about Deployments can be found in the tasks section, see here.

Includes

The Includes setting allows you to determine which files should be downloaded before starting a service.

Further details about Includes can be found in the tasks section, see here.