From 2a7a333b95acf8e46ecd5c05d57e8046a747a2e6 Mon Sep 17 00:00:00 2001 From: bbassie <17990055+bbassie@users.noreply.github.com> Date: Sun, 22 Nov 2026 00:00:06 +0000 Subject: [PATCH] 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 --- docs/{managing-a-cluster.md => clusterioctl.md} | 2 +- docs/configuration.md | 6 +++--- packages/ctl/README.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) rename docs/{managing-a-cluster.md => clusterioctl.md} (99%) diff --git a/docs/managing-a-cluster.md b/docs/clusterioctl.md similarity index 99% rename from docs/managing-a-cluster.md rename to docs/clusterioctl.md index 2cd6508b..fce1dd95 100644 --- a/docs/managing-a-cluster.md +++ b/docs/clusterioctl.md @@ -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 ` in the clusterio directory. This document uses the shorthand `ctl> foo` to indicate `npx clusterioctl foo` should be executed. diff --git a/docs/configuration.md b/docs/configuration.md index 90465063..31978e1e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,7 +1,7 @@ # Configuration 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. 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. 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. -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. @@ -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. 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. -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. diff --git a/packages/ctl/README.md b/packages/ctl/README.md index cf9fc7be..23060170 100644 --- a/packages/ctl/README.md +++ b/packages/ctl/README.md @@ -3,7 +3,7 @@ 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 @@ -25,7 +25,7 @@ Common options: * `--output ` Format to print the results of cluster commands in. 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. @@ -112,6 +112,6 @@ Lists up all configuration entries with their currently configured values. ## 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.