Rename managing-a-cluster.md to clusterioctl.md

The document is a reference for the clusterioctl commands. The name
is freed up for a guide to managing a cluster.

Part of #1254

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-11-22 00:00:06 +00:00
1 parent 8865038af5
commit 2a7a333b95
3 files changed
+7 -7

No files matched your search

@@ -1,4 +1,4 @@
# Managing a Cluster # Clusterioctl
Clusterio clusters are managed through the controller by using the `clusterioctl` command line interface which is invoked by running `npx clusterioctl <command>` in the clusterio directory. Clusterio clusters are managed through the controller by using the `clusterioctl` command line interface which is invoked by running `npx clusterioctl <command>` in the clusterio directory.
This document uses the shorthand `ctl> foo` to indicate `npx clusterioctl foo` should be executed. This document uses the shorthand `ctl> foo` to indicate `npx clusterioctl foo` should be executed.
+3 -3
View File
@@ -1,7 +1,7 @@
# Configuration # Configuration
Config values are changed with the `config set` commands of clusterioctl, clusteriocontroller and clusteriohost, or from the settings pages in the web interface. Config values are changed with the `config set` commands of clusterioctl, clusteriocontroller and clusteriohost, or from the settings pages in the web interface.
See [Managing a Cluster](/docs/managing-a-cluster.md) for the commands. See [Clusterioctl](/docs/clusterioctl.md) for the commands.
All values are checked against the type of the field when set. All values are checked against the type of the field when set.
Some fields have additional rules on top of that, such as a number having to be greater than 0, and these are listed under the field. Some fields have additional rules on top of that, such as a number having to be greater than 0, and these are listed under the field.
@@ -322,7 +322,7 @@ Defaults to 1000.
Whether the `controller update` command in clusterioctl and the update button in the web interface are allowed to update the `@clusterio/controller` package with npm. Whether the `controller update` command in clusterioctl and the update button in the web interface are allowed to update the `@clusterio/controller` package with npm.
For security reasons this can only be changed locally with `clusteriocontroller config set` while the controller is stopped, and it is hidden in the web interface. For security reasons this can only be changed locally with `clusteriocontroller config set` while the controller is stopped, and it is hidden in the web interface.
The installer sets this, controller.allow_plugin_updates and controller.allow_plugin_install from one question about remote updates and plugin installs. The installer sets this, controller.allow_plugin_updates and controller.allow_plugin_install from one question about remote updates and plugin installs.
See [Managing a Cluster](/docs/managing-a-cluster.md) for details on remote updates. See [Plugins (Remote)](/docs/clusterioctl.md#plugins-remote) for details on remote updates.
Defaults to true. Defaults to true.
@@ -477,7 +477,7 @@ Defaults to 30.
Whether the `host update` command in clusterioctl and the update button in the web interface are allowed to update the `@clusterio/host` package with npm. Whether the `host update` command in clusterioctl and the update button in the web interface are allowed to update the `@clusterio/host` package with npm.
For security reasons this can only be changed locally with `clusteriohost config set` while the host is stopped, and it is hidden in the web interface. For security reasons this can only be changed locally with `clusteriohost config set` while the host is stopped, and it is hidden in the web interface.
The installer sets this, host.allow_plugin_updates and host.allow_plugin_install from one question about remote updates and plugin installs. The installer sets this, host.allow_plugin_updates and host.allow_plugin_install from one question about remote updates and plugin installs.
See [Managing a Cluster](/docs/managing-a-cluster.md) for details on remote updates. See [Plugins (Remote)](/docs/clusterioctl.md#plugins-remote) for details on remote updates.
Defaults to true. Defaults to true.
+3 -3
View File
@@ -3,7 +3,7 @@
Provides a command line interface for managing a Clusterio cluster. Provides a command line interface for managing a Clusterio cluster.
Note that this document only describes the options and commands for managing clusterioctl itself, see [Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster. Note that this document only describes the options and commands for managing clusterioctl itself, see [Clusterioctl](/docs/clusterioctl.md) for the available commands used for managing a cluster.
## Usage ## Usage
@@ -25,7 +25,7 @@ Common options:
* `--output <human|json|wire>` Format to print the results of cluster commands in. * `--output <human|json|wire>` Format to print the results of cluster commands in.
Defaults to `human`. Defaults to `human`.
See [Output format](/docs/managing-a-cluster.md#output-format) for what `json` and `wire` print. See [Output format](/docs/clusterioctl.md#output-format) for what `json` and `wire` print.
The `plugin` and `config` commands described below always print human readable text. The `plugin` and `config` commands described below always print human readable text.
@@ -112,6 +112,6 @@ Lists up all configuration entries with their currently configured values.
## See Also ## See Also
[Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster. [Clusterioctl](/docs/clusterioctl.md) for the available commands used for managing a cluster.
[The Clusterio repository](https://github.com/clusterio/clusterio) for instructions on how to set up a cluster. [The Clusterio repository](https://github.com/clusterio/clusterio) for instructions on how to set up a cluster.