From 68aae879c7f47367fc05bc08dfdcaab6551c5486 Mon Sep 17 00:00:00 2001 From: Sherlock113 Date: Wed, 9 Dec 2020 20:50:48 +0800 Subject: [PATCH] Add some desc for the address field in config-sample Signed-off-by: Sherlock113 --- .../introduction/multioverview.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/content/en/docs/installing-on-linux/introduction/multioverview.md b/content/en/docs/installing-on-linux/introduction/multioverview.md index 416b27b5d..7ce1ff4ee 100644 --- a/content/en/docs/installing-on-linux/introduction/multioverview.md +++ b/content/en/docs/installing-on-linux/introduction/multioverview.md @@ -181,7 +181,7 @@ Here are some examples for your reference: ### 2. Edit the configuration file -A default file **config-sample.yaml** will be created if you do not change the name. Edit the file and here is an example of the configuration file of a multi-node cluster with one master node. +A default file `config-sample.yaml` will be created if you do not change the name. Edit the file and here is an example of the configuration file of a multi-node cluster with one master node. {{< notice note >}} @@ -211,7 +211,15 @@ spec: #### Hosts -- List all your machines under `hosts` and add their detailed information as above. In this case, port 22 is the default port of SSH. Otherwise, you need to add the port number after the IP address. For example: +List all your machines under `hosts` and add their detailed information as above. + +`name`: The hostname of the instance. + +`address`: The IP address you use for the connection between the taskbox and other instances through SSH. This can be either the public IP address or the private IP address depending on your environment. For example, some cloud platforms provide every instance with a public IP address which you use to access instances through SSH. In this case, you can input the public IP address for this field. + +`internalAddress`: The private IP address of the instance. + +- In this tutorial, port 22 is the default port of SSH so you do not need to add it in the yaml file. Otherwise, you need to add the port number after the IP address. For example: ```yaml hosts: @@ -232,6 +240,12 @@ spec: - {name: master, address: 192.168.0.2, internalAddress: 192.168.0.2, privateKeyPath: "~/.ssh/id_rsa"} ``` +{{< notice tip >}} + +Before you install KubeSphere, you can use the information provided under `hosts` (for example, IP addresses and passwords) to test the network connection between the taskbox and other instances using SSH. + +{{}} + #### roleGroups - `etcd`: etcd node names