Skip to content

Commit db5ad18

Browse files
authored
Change .yml extensions to .yaml and sc to sc.exe
1 parent 4ebfd33 commit db5ad18

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

doc/setup.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ netsh advfirewall firewall add rule name="python" dir=in action=allow program="C
7777

7878
# Setup etcd
7979

80-
From the base directory `C:\PES\`, go into the `etcd` directory and create a file `etcd.conf`.
80+
From the base directory `C:\PES\`, go into the `etcd` directory and create a file `etcd.yaml`.
8181

8282
```yaml
8383
name: 'win1'
@@ -117,7 +117,7 @@ Will register the service that will later launch `etcd` automatically for us.
117117
Apart from the messages on screen, you can check that the service is installed with:
118118

119119
```powershell
120-
sc qc etcd
120+
sc.exe qc etcd
121121
```
122122

123123
You should see that the start type for this service is set to auto, which means "start the service automatically after booting up".
@@ -133,7 +133,7 @@ Having installed the service, you can start it manually:
133133
or
134134
> net start etcd
135135
or
136-
> sc start etcd
136+
> sc.exe start etcd
137137
```
138138

139139
You will need to go through the etcd Setup on all three hosts in order to successfully bootstrap the etcd cluster. Only after that you will be able to continue with the setup of Patroni.
@@ -168,7 +168,7 @@ Some changes to the config (mainly those involving the initial cluster members a
168168

169169
Warning: Do not begin setting up Patroni if your etcd cluster does not yet contain all cluster members, check `C:\PES\etcd\etcdctl cluster-health` to make sure. Otherwise you will have multiple Patroni instances who are not aware of their peers and will bootstrap on their own.
170170

171-
From the base directory `C:\PES\`, go into the `patroni` directory and create (or edit) a file `patroni.yml`.
171+
From the base directory `C:\PES\`, go into the `patroni` directory and create (or edit) a file `patroni.yaml`.
172172

173173
```yaml
174174
scope: pgcluster
@@ -245,7 +245,7 @@ If you intend to create a Patroni cluster from a preexisting PostgreSQL cluster,
245245

246246
For a full list of configuration items and their description, please refer to the Patroni [Documentation](https://patroni.readthedocs.io/en/latest/SETTINGS.html).
247247

248-
When you're done adapting the above `patroni.yml` to your needs, copy it over to the other cluster members and change the name, and IP addresses or hostnames there accordingly.
248+
When you're done adapting the above `patroni.yaml` to your needs, copy it over to the other cluster members and change the name, and IP addresses or hostnames there accordingly.
249249

250250
The creation of the Patroni Service and start is similar to the procedure for `etcd`.
251251
The major difference is that Patroni needs to be run as the `pes` user. For this reason, the `patroni_service.xml` contains the user name and password.
@@ -261,7 +261,7 @@ C:\PES\patroni\patroni_service.exe install
261261
Check the service:
262262

263263
```powershell
264-
sc qc patroni
264+
sc.exe qc patroni
265265
```
266266

267267
You should see that the start type for this service is set to auto, which means "start the service automatically after booting up".
@@ -275,7 +275,7 @@ Start the service:
275275
or
276276
> net start etcd
277277
or
278-
> sc start etcd
278+
> sc.exe start etcd
279279
```
280280

281281
It is recommended to start Patroni on one host first and check that it bootstrapped as expected, before starting the remaining cluster members. This is not to avoid race conditions, because Patroni can handle those fine. This recommendation is given mainly to make it easier to troubleshoot problems as soon as they arise.
@@ -293,7 +293,7 @@ If there are no critical errors in those files, you can check if the Patroni clu
293293
```
294294

295295
```powershell
296-
PS C:\PES\patroni> python patronictl.py -c patroni.yml list
296+
PS C:\PES\patroni> python patronictl.py -c patroni.yaml list
297297
+ Cluster: pgcluster (6865748196457585920) --+----+-----------+
298298
| Member | Host | Role | State | TL | Lag in MB |
299299
+--------+----------------+--------+---------+----+-----------+
@@ -311,7 +311,7 @@ If there are cluster members that display "Start failed" in their status field,
311311

312312
# Setup vip-manager
313313

314-
From the base directory `C:\PES\`, go into the `vip-manager` directory and create a file `vip-manager.yml`.
314+
From the base directory `C:\PES\`, go into the `vip-manager` directory and create a file `vip-manager.yaml`.
315315

316316
```powershell
317317
# time (in milliseconds) after which vip-manager wakes up and checks if it needs to register or release ip addresses.
@@ -338,9 +338,9 @@ retry_num: 2
338338
retry_after: 250 #in milliseconds
339339
```
340340

341-
Change the `trigger-key` to match what the concatenation of these values from the patroni.yml gives: `<namespace> + "/" + <scope> + "/leader"` . Patroni store the current leader name in this key.
341+
Change the `trigger-key` to match what the concatenation of these values from the patroni.yaml gives: `<namespace> + "/" + <scope> + "/leader"` . Patroni store the current leader name in this key.
342342

343-
Change the `trigger-value` to the `name` in the `patroni.yml` of this host.
343+
Change the `trigger-value` to the `name` in the `patroni.yaml` of this host.
344344

345345
Change `ip`, `netmask`, `interface` to the virtual IP that will be managed and the appropriate netmask, as well as the networking interface on which the virtual IP should be registered.
346346

@@ -352,13 +352,13 @@ The creation of the vip-manager Service and start is similar to the procedure fo
352352
Create the service:
353353

354354
```powershell
355-
C:\PES\vip-manager\vip-manager_service install
355+
C:\PES\vip-manager\vip_service install
356356
```
357357

358358
Check the service:
359359

360360
```powershell
361-
sc qc vip-manager
361+
sc.exe qc vip-manager
362362
```
363363

364364
You should see that the start type for this service is set to auto, which means "start the service automatically after booting up".
@@ -368,7 +368,7 @@ You should see that the start type for this service is set to auto, which means
368368
Start the service:
369369

370370
```powershell
371-
> vip-manager_service.exe start
371+
> vip_service.exe start
372372
or
373373
> net start vip-manager
374374
or
@@ -377,12 +377,12 @@ or
377377

378378
## Check vip-manager
379379

380-
You can first take a look at `C:\PES\vip-manager\log\vip-manager_service.err.log`. If something went wrong during the installing or starting of the service already, the messages about that will be in `C:\PES\vip-manager\log\vip-manager_service.wrapper.log`.
380+
You can first take a look at `C:\PES\vip-manager\log\vip_service.err.log`. If something went wrong during the installing or starting of the service already, the messages about that will be in `C:\PES\vip-manager\log\vip_service.wrapper.log`.
381381

382382
When vip-manager is working as expected, it should log messages like ...
383383

384384
```powershell
385-
2020/08/28 01:24:36 reading config from C:\PES\vip-manager\vip-manager.yml
385+
2020/08/28 01:24:36 reading config from C:\PES\vip-manager\vip-manager.yaml
386386
2020/08/28 01:24:36 IP address 192.168.178.123/24 state is false, desired false
387387
2020/08/28 01:24:36 IP address 192.168.178.123/24 state is false, desired true
388388
2020/08/28 01:24:36 Configuring address 192.168.178.123/24 on Ethernet 2

0 commit comments

Comments
 (0)