@@ -10,14 +10,14 @@ The **pig** can also be used as a cli tool for Pigsty — the battery-include fr
1010Which brings HA, PITR, Monitoring, IaC, and all the extensions to your PostgreSQL cluster.
1111
1212``` bash
13- pig sty -Init (Download), Bootstrap, Configure, and Install Pigsty
13+ pig sty -Init (Download), Bootstrap, Configure, and Deploy Pigsty
1414
15- pig sty init [-pfvd] # install pigsty (~/pigsty by default)
16- pig sty boot [-rpk] # install ansible and prepare offline pkg
17- pig sty conf [-civrsxn ] # configure pigsty and generate config
18- pig sty install # use pigsty to install & provisioning env (DANGEROUS !)
19- pig sty get # download pigsty source tarball
20- pig sty list # list available pigsty versions
15+ pig sty init [-pfvd] # install pigsty (~/pigsty by default)
16+ pig sty boot [-rpk] # install ansible and prepare offline pkg
17+ pig sty conf [-cvrsoxnpg ] # configure pigsty and generate config
18+ pig sty deploy # use pigsty to deploy everything (CAUTION !)
19+ pig sty get # download pigsty source tarball
20+ pig sty list # list available pigsty versions
2121
2222Usage:
2323 pig sty [command]
@@ -26,18 +26,18 @@ Aliases:
2626 sty, s, pigsty
2727
2828Examples:
29- Get Started: https://pgsty.com /docs/install
29+ Get Started: https://pigsty.io /docs/setup/ install/
3030 pig sty init # extract and init ~/pigsty
3131 pig sty boot # install ansible & other deps
3232 pig sty conf # generate pigsty.yml config file
33- pig sty install # run pigsty/install .yml playbook
33+ pig sty deploy # run the deploy .yml playbook
3434
3535Available Commands:
3636 boot Bootstrap Pigsty
3737 conf Configure Pigsty
38+ deploy run pigsty deploy.yml playbook
3839 get download pigsty available versions
3940 init Install Pigsty
40- install run pigsty install.yml playbook
4141 list list pigsty available versions
4242
4343Flags:
@@ -56,7 +56,7 @@ You can use the `pig sty` subcommand to bootstrap pigsty on current node.
5656pig sty init
5757 -p | --path : where to install, ~ /pigsty by default
5858 -f | --force : force overwrite existing pigsty dir
59- -v | --version : pigsty version, embedded by default
59+ -v | --version : pigsty version, latest by default
6060 -d | --dir : download directory, /tmp by default
6161
6262Usage:
@@ -67,10 +67,10 @@ Aliases:
6767
6868Examples:
6969
70- pig sty init # install to ~/pigsty with embedded version
70+ pig sty init # install to ~/pigsty with the latest version
7171 pig sty init -f # install and OVERWRITE existing pigsty dir
7272 pig sty init -p /tmp/pigsty # install to another location /tmp/pigsty
73- pig sty init -v 3.3 # get & install specific version v3.3.0
73+ pig sty init -v 3.4 # get & install specific version v3.4.1
7474 pig sty init 3 # get & install specific version v3 latest
7575
7676
@@ -115,13 +115,17 @@ Flags:
115115Configure pigsty with ./configure
116116
117117pig sty conf
118- [-c| --conf < name> # [meta|dual|trio |full|prod ]
118+ [-c| --conf < name> ] # config template: [meta|rich|slim |full|supabase|... ]
119119 [--ip < ip> ] # primary IP address (skip with -s)
120- [-v| --version < pgver> # [17|16|15|14|13]
121- [-r| --region < region> # [default|china|europe]
120+ [-v| --version < pgver> ] # postgres major version: [18|17|16|15|14|13]
121+ [-r| --region < region> ] # upstream repo region: [default|china|europe]
122+ [-o| --output < file> ] # output config file path (default: pigsty.yml)
122123 [-s| --skip] # skip IP address probing
124+ [-p| --port < port> ] # specify SSH port (for ssh accessibility check)
123125 [-x| --proxy] # write proxy env from environment
124- [-n| --non-interactive] # non-interactively mode
126+ [-n| --non-interactive] # non-interactive mode
127+
128+ [-g| --generate] # generate random default passwords (RECOMMENDED!)
125129
126130Check https://pigsty.io/docs/setup/install/# configure for details
127131
@@ -133,38 +137,60 @@ Aliases:
133137
134138Examples:
135139
136- pig sty conf # use the default conf/meta.yml config
137- pig sty conf -c rich -x # use the rich.yml template, add your proxy env to config
138- pig sty conf -c supa --ip= 10.9.8.7 # use the supa template with 10.9.8.7 as primary IP
139- pig sty conf -c full -v 16 # use the 4-node full template with pg16 as default
140- pig sty conf -c oss -s # use the oss template, skip IP probing and replacement
141- pig sty conf -c slim -s -r china # use the 2-node slim template, designate china as region
140+ pig sty conf # use default meta.yml config
141+ pig sty conf -g # generate with random passwords (RECOMMENDED!)
142+ pig sty conf -c rich # use conf/rich.yml template (with more extensions)
143+ pig sty conf -c ha/full # use conf/ha/full.yml 4-node ha template
144+ pig sty conf -c slim # use conf/slim.yml template (minimal install)
145+ pig sty conf -c supabase # use conf/supabase.yml template (self-hosting)
146+ pig sty conf -v 17 -c rich # use conf/rich.yml template with PostgreSQL 17
147+ pig sty conf -r china -s # use china region mirrors, skip IP probe
148+ pig sty conf -x # write proxy env from environment to config
149+ pig sty conf -c full -g -o ha.yml # full HA template with random passwords to ha.yml
142150
143151
144152Flags:
145153 -c, --conf string config template name
154+ -g, --generate generate random passwords
146155 -h, --help help for conf
147156 --ip string primary ip address
148- -n , --non-interactive configure non-interactive
149- -p , --proxy configure proxy env
157+ -n, --non-interactive non-interactive mode
158+ -o, --output string output config file path
159+ -p, --port string SSH port (only used if set)
160+ -x, --proxy write proxy env from environment
150161 -r, --region string upstream repo region
151162 -s, --skip skip ip probe
152163 -v, --version string postgres major version
153164` ` `
154165
155166------
156167
157- # # `sty install `
168+ # # `sty deploy `
158169
159170` ` `
160- run pigsty install.yml playbook
171+ Deploy Pigsty using the deploy.yml playbook
172+
173+ This command runs the deploy.yml playbook from your Pigsty installation.
174+ For backward compatibility, if deploy.yml doesn' t exist but install.yml does,
175+ it will use install.yml instead.
176+
177+ Aliases: deploy, d, de, install, ins (for backward compatibility)
178+
179+ WARNING: This operation makes changes to your system. Use with caution!
161180
162181Usage:
163- pig sty install [flags]
182+ pig sty deploy [flags]
164183
165184Aliases:
166- install, ins, install
185+ deploy, d, de, install, ins
186+
187+ Examples:
188+ pig sty deploy # run deploy.yml (or install.yml if deploy.yml not found)
189+ pig sty install # same as deploy (backward compatible)
190+ pig sty d # short alias
191+ pig sty de # short alias
192+ pig sty ins # short alias
167193
168194Flags:
169- -h , --help help for install
195+ -h, --help help for deploy
170196```
0 commit comments