Skip to content

Commit

Permalink
📖 Rename references from kairos to p2p (#681)
Browse files Browse the repository at this point in the history
Leftover from the transition, kairos block is called p2p now

Signed-off-by: Itxaka <itxaka@spectrocloud.com>

Signed-off-by: Itxaka <itxaka@spectrocloud.com>
Co-authored-by: Itxaka <itxaka@spectrocloud.com>
  • Loading branch information
Itxaka and Itxaka committed Jan 19, 2023
1 parent 6168eda commit 9268dd1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/content/en/docs/Installation/manual.md
Expand Up @@ -29,7 +29,7 @@ Where the configuration can be a `cloud-init` file or a URL to it:
```yaml
#cloud-init

kairos:
p2p:
network_token: ....
# extra configuration
```
Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/Reference/configuration.md
Expand Up @@ -166,9 +166,9 @@ write_files:
owner: "bar"
```

The `kairos` block is used to enable the p2p full-mesh functionalities of Kairos. If you do not want to use these functionalities, simply don't specify a kairos block in your configuration file.
The `p2p` block is used to enable the p2p full-mesh functionalities of Kairos. If you do not want to use these functionalities, simply don't specify a kairos block in your configuration file.

Inside the `kairos` block, you can specify the network_token field, which is used to establish the p2p full meshed network. If you do not want to use the full-mesh functionalities, don't specify a network_token value.
Inside the `p2p` block, you can specify the network_token field, which is used to establish the p2p full meshed network. If you do not want to use the full-mesh functionalities, don't specify a network_token value.

The role field allows you to manually set the node role for your Kairos installation. The available options are `master` and `worker`, and the default value is auto (which means no role is set).

Expand Down Expand Up @@ -482,7 +482,7 @@ localhost:~$
## P2P configuration
P2P functionalities are experimental Kairos features and disabled by default. In order to enable them, just use the `kairos` configuration block.
P2P functionalities are experimental Kairos features and disabled by default. In order to enable them, just use the `p2p` configuration block.
### `p2p.network_token`
Expand Down

0 comments on commit 9268dd1

Please sign in to comment.