Skip to content

Commit 2fbf136

Browse files
jillian-maroketjillian-maroket
authored
Enhance and backport server_URL setting information (#1043)
* Reorganize and rewrite server_URL info in v1.9 doc Signed-off-by: Jillian <jillian.maroket@suse.com> * Revert "Reorganize and rewrite server_URL info in v1.9 doc" This reverts commit 6c5b08b. * Reorganize and rewrite server_url setting description Signed-off-by: Jillian <jillian.maroket@suse.com> * Apply changes to non-EOL versions Signed-off-by: Jillian <jillian.maroket@suse.com> --------- Signed-off-by: Jillian <jillian.maroket@suse.com>
1 parent c0426fc commit 2fbf136

5 files changed

Lines changed: 117 additions & 63 deletions

File tree

‎docs/install/harvester-configuration.md‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Harvester configuration file can be provided during manual or automatic installa
2121

2222
```yaml
2323
scheme_version: 1
24-
server_url: "" # empty or absent in create mode; set to https://cluster-VIP:443 in join mode
24+
server_url: "" # omitted or empty in CREATE mode; set to https://cluster-VIP:443 in JOIN mode
2525
token: TOKEN_VALUE
2626
os:
2727
ssh_authorized_keys:
@@ -143,34 +143,36 @@ Make sure that your custom configuration always has the correct scheme version.
143143

144144
#### Definition
145145

146-
`server_url` is the URL of the Harvester cluster, which is used for the new `node` to join the cluster.
146+
URL that nodes use when joining an existing Harvester cluster.
147147

148-
This configuration is mandatory when the installation is in `JOIN` mode. The default format of `server_url` is `https://cluster-VIP:443`.
149-
In `CREATE` mode the parameter must be absent or with empty value (`""`). Otherwise the installation fails.
148+
The configuration depends on the installation task that you are performing.
150149

151-
:::note
150+
- Creating a new cluster (`CREATE` mode): This setting must be omitted or contain an empty value (`""`). Specifying any other value results in installation failure.
151+
- Adding a node to an existing cluster (`JOIN` mode): This configuration is mandatory. The default format is `https://cluster-VIP:443`.
152+
153+
:::info important
152154

153-
To ensure a high availability (HA) Harvester cluster, please use either the Harvester cluster [VIP](#installvip) or a domain name in `server_url`.
155+
To ensure high availability (HA), you must specify either the Harvester cluster [VIP](#installvip) or a domain name.
154156

155157
:::
156158

157-
#### Example
159+
#### Examples
158160

159-
for cluster creation
161+
- Creating a new cluster (`CREATE` mode)
160162

161-
```yaml
162-
server_url: '' # or remove this line
163-
install:
164-
mode: create
165-
```
163+
```yaml
164+
server_url: '' # You can also remove this line.
165+
install:
166+
mode: create
167+
```
166168

167-
or to join a cluster
169+
- Adding a node to an existing cluster (`JOIN` mode)
168170

169-
```yaml
170-
server_url: https://cluster-VIP:443
171-
install:
172-
mode: join
173-
```
171+
```yaml
172+
server_url: https://cluster-VIP:443
173+
install:
174+
mode: join
175+
```
174176

175177
### `token`
176178

‎versioned_docs/version-v1.5/install/harvester-configuration.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Harvester configuration file can be provided during manual or automatic installa
2121

2222
```yaml
2323
scheme_version: 1
24-
server_url: https://cluster-VIP:443
24+
server_url: "" # omitted or empty in CREATE mode; set to https://cluster-VIP:443 in JOIN mode
2525
token: TOKEN_VALUE
2626
os:
2727
ssh_authorized_keys:
@@ -130,23 +130,36 @@ Make sure that your custom configuration always has the correct scheme version.
130130

131131
#### Definition
132132

133-
`server_url` is the URL of the Harvester cluster, which is used for the new `node` to join the cluster.
133+
URL that nodes use when joining an existing Harvester cluster.
134134

135-
This configuration is mandatory when the installation is in `JOIN` mode. The default format of `server_url` is `https://cluster-VIP:443`.
135+
The configuration depends on the installation task that you are performing.
136136

137-
:::note
137+
- Creating a new cluster (`CREATE` mode): This setting must be omitted or contain an empty value (`""`). Specifying any other value results in installation failure.
138+
- Adding a node to an existing cluster (`JOIN` mode): This configuration is mandatory. The default format is `https://cluster-VIP:443`.
139+
140+
:::info important
138141

139-
To ensure a high availability (HA) Harvester cluster, please use either the Harvester cluster [VIP](#installvip) or a domain name in `server_url`.
142+
To ensure high availability (HA), you must specify either the Harvester cluster [VIP](#installvip) or a domain name.
140143

141144
:::
142145

143-
#### Example
146+
#### Examples
144147

145-
```yaml
146-
server_url: https://cluster-VIP:443
147-
install:
148-
mode: join
149-
```
148+
- Creating a new cluster (`CREATE` mode)
149+
150+
```yaml
151+
server_url: '' # You can also remove this line.
152+
install:
153+
mode: create
154+
```
155+
156+
- Adding a node to an existing cluster (`JOIN` mode)
157+
158+
```yaml
159+
server_url: https://cluster-VIP:443
160+
install:
161+
mode: join
162+
```
150163

151164
### `token`
152165

‎versioned_docs/version-v1.6/install/harvester-configuration.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Harvester configuration file can be provided during manual or automatic installa
2121

2222
```yaml
2323
scheme_version: 1
24-
server_url: https://cluster-VIP:443
24+
server_url: "" # omitted or empty in CREATE mode; set to https://cluster-VIP:443 in JOIN mode
2525
token: TOKEN_VALUE
2626
os:
2727
ssh_authorized_keys:
@@ -130,23 +130,36 @@ Make sure that your custom configuration always has the correct scheme version.
130130

131131
#### Definition
132132

133-
`server_url` is the URL of the Harvester cluster, which is used for the new `node` to join the cluster.
133+
URL that nodes use when joining an existing Harvester cluster.
134134

135-
This configuration is mandatory when the installation is in `JOIN` mode. The default format of `server_url` is `https://cluster-VIP:443`.
135+
The configuration depends on the installation task that you are performing.
136136

137-
:::note
137+
- Creating a new cluster (`CREATE` mode): This setting must be omitted or contain an empty value (`""`). Specifying any other value results in installation failure.
138+
- Adding a node to an existing cluster (`JOIN` mode): This configuration is mandatory. The default format is `https://cluster-VIP:443`.
139+
140+
:::info important
138141

139-
To ensure a high availability (HA) Harvester cluster, please use either the Harvester cluster [VIP](#installvip) or a domain name in `server_url`.
142+
To ensure high availability (HA), you must specify either the Harvester cluster [VIP](#installvip) or a domain name.
140143

141144
:::
142145

143-
#### Example
146+
#### Examples
144147

145-
```yaml
146-
server_url: https://cluster-VIP:443
147-
install:
148-
mode: join
149-
```
148+
- Creating a new cluster (`CREATE` mode)
149+
150+
```yaml
151+
server_url: '' # You can also remove this line.
152+
install:
153+
mode: create
154+
```
155+
156+
- Adding a node to an existing cluster (`JOIN` mode)
157+
158+
```yaml
159+
server_url: https://cluster-VIP:443
160+
install:
161+
mode: join
162+
```
150163

151164
### `token`
152165

‎versioned_docs/version-v1.7/install/harvester-configuration.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Harvester configuration file can be provided during manual or automatic installa
2121

2222
```yaml
2323
scheme_version: 1
24-
server_url: https://cluster-VIP:443
24+
server_url: "" # omitted or empty in CREATE mode; set to https://cluster-VIP:443 in JOIN mode
2525
token: TOKEN_VALUE
2626
os:
2727
ssh_authorized_keys:
@@ -144,23 +144,36 @@ Make sure that your custom configuration always has the correct scheme version.
144144

145145
#### Definition
146146

147-
`server_url` is the URL of the Harvester cluster, which is used for the new `node` to join the cluster.
147+
URL that nodes use when joining an existing Harvester cluster.
148148

149-
This configuration is mandatory when the installation is in `JOIN` mode. The default format of `server_url` is `https://cluster-VIP:443`.
149+
The configuration depends on the installation task that you are performing.
150150

151-
:::note
151+
- Creating a new cluster (`CREATE` mode): This setting must be omitted or contain an empty value (`""`). Specifying any other value results in installation failure.
152+
- Adding a node to an existing cluster (`JOIN` mode): This configuration is mandatory. The default format is `https://cluster-VIP:443`.
153+
154+
:::info important
152155

153-
To ensure a high availability (HA) Harvester cluster, please use either the Harvester cluster [VIP](#installvip) or a domain name in `server_url`.
156+
To ensure high availability (HA), you must specify either the Harvester cluster [VIP](#installvip) or a domain name.
154157

155158
:::
156159

157-
#### Example
160+
#### Examples
158161

159-
```yaml
160-
server_url: https://cluster-VIP:443
161-
install:
162-
mode: join
163-
```
162+
- Creating a new cluster (`CREATE` mode)
163+
164+
```yaml
165+
server_url: '' # You can also remove this line.
166+
install:
167+
mode: create
168+
```
169+
170+
- Adding a node to an existing cluster (`JOIN` mode)
171+
172+
```yaml
173+
server_url: https://cluster-VIP:443
174+
install:
175+
mode: join
176+
```
164177

165178
### `token`
166179

‎versioned_docs/version-v1.8/install/harvester-configuration.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Harvester configuration file can be provided during manual or automatic installa
2121

2222
```yaml
2323
scheme_version: 1
24-
server_url: https://cluster-VIP:443
24+
server_url: "" # omitted or empty in CREATE mode; set to https://cluster-VIP:443 in JOIN mode
2525
token: TOKEN_VALUE
2626
os:
2727
ssh_authorized_keys:
@@ -143,23 +143,36 @@ Make sure that your custom configuration always has the correct scheme version.
143143

144144
#### Definition
145145

146-
`server_url` is the URL of the Harvester cluster, which is used for the new `node` to join the cluster.
146+
URL that nodes use when joining an existing Harvester cluster.
147147

148-
This configuration is mandatory when the installation is in `JOIN` mode. The default format of `server_url` is `https://cluster-VIP:443`.
148+
The configuration depends on the installation task that you are performing.
149149

150-
:::note
150+
- Creating a new cluster (`CREATE` mode): This setting must be omitted or contain an empty value (`""`). Specifying any other value results in installation failure.
151+
- Adding a node to an existing cluster (`JOIN` mode): This configuration is mandatory. The default format is `https://cluster-VIP:443`.
152+
153+
:::info important
151154

152-
To ensure a high availability (HA) Harvester cluster, please use either the Harvester cluster [VIP](#installvip) or a domain name in `server_url`.
155+
To ensure high availability (HA), you must specify either the Harvester cluster [VIP](#installvip) or a domain name.
153156

154157
:::
155158

156-
#### Example
159+
#### Examples
157160

158-
```yaml
159-
server_url: https://cluster-VIP:443
160-
install:
161-
mode: join
162-
```
161+
- Creating a new cluster (`CREATE` mode)
162+
163+
```yaml
164+
server_url: '' # You can also remove this line.
165+
install:
166+
mode: create
167+
```
168+
169+
- Adding a node to an existing cluster (`JOIN` mode)
170+
171+
```yaml
172+
server_url: https://cluster-VIP:443
173+
install:
174+
mode: join
175+
```
163176

164177
### `token`
165178

0 commit comments

Comments
 (0)