Parameter reference
Every key below is accepted both on the command line and in the answers file. The table is built from the same parameter registry the installer uses to parse the command line, so it cannot diverge from the code.
Keys common to all commands
| Name | Command line | Type | Default | Screen | Description |
|---|---|---|---|---|---|
|
|
flag |
not asked |
Show this help and exit |
|
|
|
str |
not asked |
Interface language |
|
|
|
enum:auto,tui,text |
|
not asked |
Interface mode: auto, tui, or text |
|
|
flag |
not asked |
Use defaults wherever possible. See era_installer/unattended.adoc#era-installer-unattended-modes. |
|
|
|
flag |
not asked |
Ask nothing; if a value is missing, exit with an error. See era_installer/unattended.adoc#era-installer-unattended-modes. |
|
|
|
str |
not asked |
Read answers from a file. See era_installer/unattended.adoc#era-installer-unattended-answers. |
|
|
|
str |
not asked |
Write the final answers to a file. See era_installer/unattended.adoc#era-installer-unattended-answers. |
|
|
|
str |
not asked |
Read passwords from a separate file. See era_installer/unattended.adoc#era-installer-unattended-secrets. |
|
|
|
flag |
not asked |
Collect data and show the plan without changing anything. See era_installer/unattended.adoc#era-installer-unattended-modes. |
|
|
|
flag |
not asked |
Show the advanced parameters screen |
|
|
|
flag |
not asked |
Do not stop at an unknown key |
|
|
|
flag |
not asked |
Write passwords to the log file in clear text |
|
|
|
flag |
not asked |
Verbose console output |
|
|
|
flag |
not asked |
Warnings and errors only |
Remote server connection
| Name | Command line | Type | Default | Screen | Description |
|---|---|---|---|---|---|
|
|
host |
0 |
Remote ssh host |
|
|
|
port |
|
0 |
Remote ssh port |
|
|
str |
0 |
ssh user on the remote host |
|
|
|
str |
0 |
Path to the ssh key for connecting to the remote server |
|
|
|
path |
|
not asked |
Directory on the target host where the installer is copied |
|
|
flag |
not asked |
Remove the known_hosts entry for the host before connecting |
|
|
|
yesno |
not asked |
Copy image files without asking: y or n |
|
|
|
flag |
not asked |
Keep the installer on the target host after completion |
install.sh
| Name | Command line | Type | Default | Screen | Description |
|---|---|---|---|---|---|
|
|
str |
not asked |
ssh user on the remote host |
|
|
|
host |
not asked |
Remote ssh host |
|
|
|
port |
|
not asked |
Remote ssh port |
|
|
str |
not asked |
Path to the ssh key for connecting to the remote server |
|
|
|
ip |
1 |
Local interface on which the platform is installed |
|
|
|
str |
1 |
Instance name postfix |
|
|
|
path |
|
1 |
Data path |
|
|
ident |
1 |
Server name for the platform configuration |
|
|
|
yesno |
1 |
Install the master server |
|
|
|
str |
1 |
Master domain name |
|
|
|
str |
1 |
Mic and ic addresses for a non-master server |
|
|
|
str |
|
1 |
PSK cookie |
|
|
yesno |
|
2 |
Download required packages from the internet |
|
|
yesno |
|
2 |
Continue with package installation disabled |
|
|
yesno |
|
2 |
Use an http/https proxy |
|
|
str |
2 |
http_proxy value |
|
|
|
str |
|
2 |
https_proxy value |
|
|
yesno |
|
3 |
Install PostgreSQL |
|
|
enum:h,d |
3 |
PostgreSQL installation mode: h (host) or d (docker) |
|
|
|
enum:m,r |
3 |
PostgreSQL master/recovery mode: m or r |
|
|
|
yesno |
|
3 |
Use replication |
|
|
yesno |
3 |
Take the PostgreSQL image from Docker Hub |
|
|
|
host |
4 |
PostgreSQL server IP address |
|
|
|
port |
|
4 |
PostgreSQL server port |
|
|
str |
|
4 |
PostgreSQL user name for the platform |
|
|
str |
|
4 |
PostgreSQL user password for the platform (value hidden in the log) |
|
|
str |
|
4 |
Password of the PostgreSQL 'postgres' user (value hidden in the log) |
|
|
str |
|
4 |
PostgreSQL replication user name |
|
|
str |
|
4 |
PostgreSQL replication user password (value hidden in the log) |
|
|
str |
4 |
OS group to add the postgres user to |
|
|
|
str |
not asked |
Password of the system postgres user (value hidden in the log) |
|
|
|
path |
5 |
PostgreSQL cluster data directory |
|
|
|
path |
|
5 |
PostgreSQL cluster backup directory |
|
|
yesno |
|
5 |
Clear the data/configuration directory if it exists |
|
|
str |
not asked |
PostgreSQL version |
|
|
|
path |
|
6 |
Host directory for /var/lib/era |
|
|
path |
|
6 |
Host directory for /var/log/era |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/local |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/rectemp |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/logstore |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/syncroot |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/a |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/b |
|
|
path |
|
6 |
Host directory for /var/lib/era_files/c |
|
|
path |
|
7 |
Local RECPATH mount point |
|
|
path |
|
7 |
Local SITESHARE mount point |
|
|
path |
|
7 |
Local GLOBALSHARE mount point |
|
|
yesno |
|
7 |
Install the NFS server |
|
|
str |
7 |
Network mask for NFS clients |
|
|
|
str |
7 |
NFS server address; empty — skip |
|
|
|
path |
|
7 |
RECPATH directory on the NFS server |
|
|
path |
|
7 |
SITESHARE directory on the NFS server |
|
|
path |
|
7 |
GLOBALSHARE directory on the NFS server |
|
|
yesno |
|
7 |
Create the rshare.sign access marker |
|
|
yesno |
|
10 |
Additional server installation is planned |
|
|
str |
10 |
Additional servers: name@address comma-separated |
|
|
|
yesno |
|
8 |
Enable connection reuse in time_wait |
|
|
enum:auto,configure,skip |
|
9 |
SELinux configuration: auto, configure, or skip |
|
|
enum:auto,open,skip |
|
9 |
Opening ports in firewalld: auto, open, or skip |
|
|
yesno |
|
9 |
Use a non-root user inside the container |
|
|
yesno |
|
9 |
Do not change kernel parameters |
|
|
port |
9 |
Platform web server http port |
|
|
|
port |
9 |
Platform web server https port |
|
|
|
str |
9 |
Distributed Erlang port range |
|
|
|
str |
9 |
Platform node port range |
|
|
|
port |
9 |
Erlang epmd port |
|
|
|
str |
9 |
Docker network for the platform container |
|
|
|
str |
9 |
Platform container address in the docker network |
|
|
|
str |
9 |
Path to the platform docker image file |
|
|
|
port |
9 |
PostgreSQL port inside the container |
|
|
|
str |
9 |
Docker network for the PostgreSQL container |
|
|
|
str |
9 |
PostgreSQL container address in the docker network |
|
|
|
enum:true,false |
|
4 |
SSL for the platform connection to PostgreSQL (true/false) |
|
|
enum:cleartext,md5,scram-sha-256 |
4 |
Authorization mode with SSL: cleartext, md5, scram-sha-256; empty — not set |
uninstall.sh
| Name | Command line | Type | Default | Screen | Description |
|---|---|---|---|---|---|
|
|
path |
|
1 |
Data path |
|
|
str |
2 |
Platform container name, for example era_11 |
|
|
|
path |
|
3 |
Instance directory on the host |
|
|
str |
not asked |
PostgreSQL container name |
|
|
|
yesno |
|
4 |
Remove the PostgreSQL server |
|
|
enum:h,d |
4 |
PostgreSQL installation mode: h (host) or d (docker) |
|
|
|
str |
4 |
PostgreSQL version |
|
|
|
path |
4 |
PostgreSQL cluster data directory |
|
|
|
yesno |
|
4 |
Remove OS packages used by PostgreSQL |
|
|
str |
not asked |
ssh user on the remote host |
|
|
|
host |
not asked |
Remote ssh host |
|
|
|
port |
|
not asked |
Remote ssh port |
|
|
str |
not asked |
Path to the ssh key for connecting to the remote server |
|
|
|
str |
not asked |
Instance name postfix |
install_pg.sh
| Name | Command line | Type | Default | Screen | Description |
|---|---|---|---|---|---|
|
|
enum:install_in_docker,install_host_master,install_host_slave,switch_to_master,switch_to_slave,uninstall |
1 |
Operation being performed |
|
|
|
str |
1 |
Instance name postfix |
|
|
|
ip |
not asked |
Local interface on which the platform is installed |
|
|
|
path |
|
not asked |
Data path |
|
|
str |
not asked |
PostgreSQL version |
|
|
|
str |
not asked |
ssh user on the remote host |
|
|
|
host |
not asked |
Remote ssh host |
|
|
|
port |
|
not asked |
Remote ssh port |
|
|
str |
not asked |
Path to the ssh key for connecting to the remote server |
|
|
|
yesno |
|
1 |
Use replication |
|
|
yesno |
1 |
Take the PostgreSQL image from Docker Hub |
|
|
|
enum:h,d |
1 |
PostgreSQL installation mode: h (host) or d (docker) |
|
|
|
enum:m,r |
not asked |
PostgreSQL master/recovery mode: m or r |
|
|
|
yesno |
|
1 |
Remove OS packages used by PostgreSQL |
|
|
host |
2 |
PostgreSQL server IP address |
|
|
|
port |
|
2 |
PostgreSQL server port |
|
|
str |
|
2 |
PostgreSQL user name for the platform |
|
|
str |
|
2 |
PostgreSQL user password for the platform (value hidden in the log) |
|
|
str |
|
2 |
Password of the PostgreSQL 'postgres' user (value hidden in the log) |
|
|
str |
|
2 |
PostgreSQL replication user name |
|
|
str |
|
2 |
PostgreSQL replication user password (value hidden in the log) |
|
|
str |
2 |
OS group to add the postgres user to |
|
|
|
str |
not asked |
Password of the system postgres user (value hidden in the log) |
|
|
|
path |
3 |
PostgreSQL cluster data directory |
|
|
|
path |
|
3 |
PostgreSQL cluster backup directory |
|
|
yesno |
|
3 |
Clear the data/configuration directory if it exists |
|
|
yesno |
|
not asked |
Download required packages from the internet |
|
|
yesno |
|
not asked |
Use an http/https proxy |
|
|
str |
not asked |
http_proxy value |
|
|
|
str |
|
not asked |
https_proxy value |
|
|
enum:auto,configure,skip |
|
not asked |
SELinux configuration: auto, configure, or skip |
|
|
enum:auto,open,skip |
|
not asked |
Opening ports in firewalld: auto, open, or skip |
|
|
port |
not asked |
PostgreSQL port inside the container |
|
|
|
str |
not asked |
Docker network for the PostgreSQL container |
|
|
|
str |
not asked |
PostgreSQL container address in the docker network |
|
|
|
yesno |
|
not asked |
Do not install docker for the PostgreSQL container |
|
|
str |
not asked |
Internal: who launched this script |