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

help

--help

flag

not asked

Show this help and exit

lang

--lang

str

not asked

Interface language

ui

--ui

enum:auto,tui,text

auto

not asked

Interface mode: auto, tui, or text

usedefaults

-y, --y, -usedefaults, --usedefaults

flag

not asked

Use defaults wherever possible. See era_installer/unattended.adoc#era-installer-unattended-modes.

noninteractive

--non-interactive, --batch

flag

not asked

Ask nothing; if a value is missing, exit with an error. See era_installer/unattended.adoc#era-installer-unattended-modes.

answersfile

--answers-file

str

not asked

Read answers from a file. See era_installer/unattended.adoc#era-installer-unattended-answers.

saveanswers

--save-answers

str

not asked

Write the final answers to a file. See era_installer/unattended.adoc#era-installer-unattended-answers.

secretsfile

--secrets-file

str

not asked

Read passwords from a separate file. See era_installer/unattended.adoc#era-installer-unattended-secrets.

dryrun

--dry-run

flag

not asked

Collect data and show the plan without changing anything. See era_installer/unattended.adoc#era-installer-unattended-modes.

advanced

--advanced

flag

not asked

Show the advanced parameters screen

ignoreunknown

--ignore-unknown

flag

not asked

Do not stop at an unknown key

logsecrets

--log-secrets

flag

not asked

Write passwords to the log file in clear text

verbose

--verbose

flag

not asked

Verbose console output

quiet

--quiet

flag

not asked

Warnings and errors only

Remote server connection

Name Command line Type Default Screen Description

sshhost

-h, --host

host

0

Remote ssh host

sshport

-p, --port

port

22

0

Remote ssh port

sshuser

-u, --user

str

0

ssh user on the remote host

sshkey

--sshkey

str

0

Path to the ssh key for connecting to the remote server

remotedir

--remotedir

path

/tmp/era_installer

not asked

Directory on the target host where the installer is copied

resetknownhosts

--resetknownhosts

flag

not asked

Remove the known_hosts entry for the host before connecting

copyimages

--copyimages

yesno

not asked

Copy image files without asking: y or n

keepremote

--keepremote

flag

not asked

Keep the installer on the target host after completion

install.sh

Name Command line Type Default Screen Description

sshuser

-u, --user

str

not asked

ssh user on the remote host

sshhost

-h, --host

host

not asked

Remote ssh host

sshport

-p, --port

port

22

not asked

Remote ssh port

sshkey

--sshkey

str

not asked

Path to the ssh key for connecting to the remote server

ipaddress

-ipaddr, --ipaddress

ip

1

Local interface on which the platform is installed

postfix

--postfix

str

1

Instance name postfix

datapath

--datapath

path

/opt

1

Data path

srvname

--srvname

ident

1

Server name for the platform configuration

master

--master

yesno

1

Install the master server

masterdomain

--masterdomain

str

1

Master domain name

micaddress

--micaddress

str

1

Mic and ic addresses for a non-master server

pskcookie

--pskcookie

str

era2020key

1

PSK cookie

useapt

--useapt

yesno

y

2

Download required packages from the internet

proceedwithoutapt

--proceedwithoutapt

yesno

n

2

Continue with package installation disabled

useproxy

--useproxy

yesno

n

2

Use an http/https proxy

ehttpproxy

--ehttpproxy

str

2

http_proxy value

ehttpsproxy

--ehttpsproxy

str

{ehttpproxy}

2

https_proxy value

dopginstall

--dopginstall

yesno

y

3

Install PostgreSQL

pgmode

--pgmode

enum:h,d

3

PostgreSQL installation mode: h (host) or d (docker)

pghostmode

--pghostmode

enum:m,r

3

PostgreSQL master/recovery mode: m or r

usereplic

--usereplic

yesno

n

3

Use replication

usedockerhubpgimage

--usedockerhubpgimage

yesno

3

Take the PostgreSQL image from Docker Hub

pghost

--pghost

host

4

PostgreSQL server IP address

pgport

--pgport

port

5441

4

PostgreSQL server port

pgpostgresuser

--pgpostgresuser

str

platformpgadmin

4

PostgreSQL user name for the platform

pgerapwd

--pgerapwd

str

Era_User_pwd

4

PostgreSQL user password for the platform (value hidden in the log)

pgpostgrespwd

--pgpostgrespwd

str

Era_Pg_pwd

4

Password of the PostgreSQL 'postgres' user (value hidden in the log)

pgreplicauser

--pgreplicauser

str

era_replica

4

PostgreSQL replication user name

pgreplicapwd

--pgreplicapwd

str

Era_Replica_pwd

4

PostgreSQL replication user password (value hidden in the log)

pgpostgresgroup

--pgpostgresgroup

str

4

OS group to add the postgres user to

pgospwd

--pgospwd

str

not asked

Password of the system postgres user (value hidden in the log)

pgdatafolder

--pgdatafolder

path

5

PostgreSQL cluster data directory

pgbackupfolder

--pgbackupfolder

path

/tmp/pg_backups/era{postfix}

5

PostgreSQL cluster backup directory

pgcleardatafolder

--pgcleardatafolder

yesno

y

5

Clear the data/configuration directory if it exists

pgversion

--pgversion

str

not asked

PostgreSQL version

varlibvoldir

--varlibvoldir

path

{datapath}/era{postfix}/lib

6

Host directory for /var/lib/era

varlogvoldir

--varlogvoldir

path

{datapath}/era{postfix}/log

6

Host directory for /var/log/era

localvoldir

--localvoldir

path

{datapath}/era{postfix}/local

6

Host directory for /var/lib/era_files/local

rectempvoldir

--rectempvoldir

path

{datapath}/era{postfix}/rectemp

6

Host directory for /var/lib/era_files/rectemp

logstorevoldir

--logstorevoldir

path

{datapath}/era{postfix}/logstore

6

Host directory for /var/lib/era_files/logstore

syncrootvoldir

--syncrootvoldir

path

{datapath}/era{postfix}/syncroot

6

Host directory for /var/lib/era_files/syncroot

avoldir

--avoldir

path

{datapath}/era{postfix}/a

6

Host directory for /var/lib/era_files/a

bvoldir

--bvoldir

path

{datapath}/era{postfix}/b

6

Host directory for /var/lib/era_files/b

cvoldir

--cvoldir

path

{datapath}/era{postfix}/c

6

Host directory for /var/lib/era_files/c

recpathnfsclidir

--recpathnfsclidir

path

{datapath}/era{postfix}/era_recpath

7

Local RECPATH mount point

sitesharenfsclidir

--sitesharenfsclidir

path

{datapath}/era{postfix}/era_siteshare

7

Local SITESHARE mount point

globalsharenfsclidir

--globalsharenfsclidir

path

{datapath}/era{postfix}/era_globalshare

7

Local GLOBALSHARE mount point

installnfsserver

--installnfsserver

yesno

n

7

Install the NFS server

nfsclinetmask

--nfsclinetmask

str

7

Network mask for NFS clients

nfsserveraddr

--nfsserveraddr

str

7

NFS server address; empty — skip

recpathnfssrvdir

--recpathnfssrvdir

path

{datapath}/era{postfix}/nfs_recpath

7

RECPATH directory on the NFS server

sitesharenfssrvdir

--sitesharenfssrvdir

path

{datapath}/era{postfix}/nfs_siteshare

7

SITESHARE directory on the NFS server

globalsharenfssrvdir

--globalsharenfssrvdir

path

{datapath}/era{postfix}/nfs_globalshare

7

GLOBALSHARE directory on the NFS server

installrshare

--installrshare

yesno

y

7

Create the rshare.sign access marker

addservers

--addservers

yesno

n

10

Additional server installation is planned

addserverlist

--addserverlist

str

10

Additional servers: name@address comma-separated

dotwreuse

--dotwreuse

yesno

n

8

Enable connection reuse in time_wait

selinux

--selinux

enum:auto,configure,skip

auto

9

SELinux configuration: auto, configure, or skip

firewall

--firewall

enum:auto,open,skip

auto

9

Opening ports in firewalld: auto, open, or skip

usenonrootuser

--usenonrootuser

yesno

n

9

Use a non-root user inside the container

skipchangekernelparameters

--skipchangekernelparameters

yesno

n

9

Do not change kernel parameters

erawshttpport

--erawshttpport

port

9

Platform web server http port

erawshttpsport

--erawshttpsport

port

9

Platform web server https port

eradistports

--eradistports

str

9

Distributed Erlang port range

eranodesports

--eranodesports

str

9

Platform node port range

eraerlepmdport

--eraerlepmdport

port

9

Erlang epmd port

eradockernetwork

--eradockernetwork

str

9

Docker network for the platform container

eradockerip

--eradockerip

str

9

Platform container address in the docker network

eradockerimagepath

--eradockerimagepath

str

9

Path to the platform docker image file

pgindockerport

--pgindockerport

port

9

PostgreSQL port inside the container

pgdockernetwork

--pgdockernetwork

str

9

Docker network for the PostgreSQL container

pgdockerip

--pgdockerip

str

9

PostgreSQL container address in the docker network

pgssl

--pgssl

enum:true,false

false

4

SSL for the platform connection to PostgreSQL (true/false)

pgauthmethod

--pgauthmethod

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

datapath

--datapath

path

/opt

1

Data path

eracontainername

--eracontainername

str

2

Platform container name, for example era_11

erainstancedatapath

--erainstancedatapath

path

{datapath}/{eracontainername}

3

Instance directory on the host

pgcontainername

--pgcontainername

str

not asked

PostgreSQL container name

douninstallpg

--douninstallpg

yesno

y

4

Remove the PostgreSQL server

pgmode

--pgmode

enum:h,d

4

PostgreSQL installation mode: h (host) or d (docker)

pgversion

--pgversion

str

4

PostgreSQL version

pgdatafolder

--pgdatafolder

path

4

PostgreSQL cluster data directory

douninstallsyspkgs

--douninstallsyspkgs

yesno

n

4

Remove OS packages used by PostgreSQL

sshuser

-u, --user

str

not asked

ssh user on the remote host

sshhost

-h, --host

host

not asked

Remote ssh host

sshport

-p, --port

port

22

not asked

Remote ssh port

sshkey

--sshkey

str

not asked

Path to the ssh key for connecting to the remote server

postfix

--postfix

str

not asked

Instance name postfix

install_pg.sh

Name Command line Type Default Screen Description

operation

--operation

enum:install_in_docker,install_host_master,install_host_slave,switch_to_master,switch_to_slave,uninstall

1

Operation being performed

postfix

--postfix

str

1

Instance name postfix

ipaddress

-ipaddr, --ipaddress

ip

not asked

Local interface on which the platform is installed

datapath

--datapath

path

/opt

not asked

Data path

pgversion

--pgversion

str

not asked

PostgreSQL version

sshuser

-u, --user

str

not asked

ssh user on the remote host

sshhost

-h, --host

host

not asked

Remote ssh host

sshport

-p, --port

port

22

not asked

Remote ssh port

sshkey

--sshkey

str

not asked

Path to the ssh key for connecting to the remote server

usereplic

--usereplic

yesno

n

1

Use replication

usedockerhubpgimage

--usedockerhubpgimage

yesno

1

Take the PostgreSQL image from Docker Hub

pgmode

--pgmode

enum:h,d

1

PostgreSQL installation mode: h (host) or d (docker)

pghostmode

--pghostmode

enum:m,r

not asked

PostgreSQL master/recovery mode: m or r

douninstallsyspkgs

--douninstallsyspkgs

yesno

n

1

Remove OS packages used by PostgreSQL

pghost

--pghost

host

2

PostgreSQL server IP address

pgport

--pgport

port

5441

2

PostgreSQL server port

pgpostgresuser

--pgpostgresuser

str

platformpgadmin

2

PostgreSQL user name for the platform

pgerapwd

--pgerapwd

str

Era_User_pwd

2

PostgreSQL user password for the platform (value hidden in the log)

pgpostgrespwd

--pgpostgrespwd

str

Era_Pg_pwd

2

Password of the PostgreSQL 'postgres' user (value hidden in the log)

pgreplicauser

--pgreplicauser

str

era_replica

2

PostgreSQL replication user name

pgreplicapwd

--pgreplicapwd

str

Era_Replica_pwd

2

PostgreSQL replication user password (value hidden in the log)

pgpostgresgroup

--pgpostgresgroup

str

2

OS group to add the postgres user to

pgospwd

--pgospwd

str

not asked

Password of the system postgres user (value hidden in the log)

pgdatafolder

--pgdatafolder

path

3

PostgreSQL cluster data directory

pgbackupfolder

--pgbackupfolder

path

/tmp/pg_backups/era{postfix}

3

PostgreSQL cluster backup directory

pgcleardatafolder

--pgcleardatafolder

yesno

y

3

Clear the data/configuration directory if it exists

useapt

--useapt

yesno

y

not asked

Download required packages from the internet

useproxy

--useproxy

yesno

n

not asked

Use an http/https proxy

ehttpproxy

--ehttpproxy

str

not asked

http_proxy value

ehttpsproxy

--ehttpsproxy

str

{ehttpproxy}

not asked

https_proxy value

selinux

--selinux

enum:auto,configure,skip

auto

not asked

SELinux configuration: auto, configure, or skip

firewall

--firewall

enum:auto,open,skip

auto

not asked

Opening ports in firewalld: auto, open, or skip

pgindockerport

--pgindockerport

port

not asked

PostgreSQL port inside the container

pgdockernetwork

--pgdockernetwork

str

not asked

Docker network for the PostgreSQL container

pgdockerip

--pgdockerip

str

not asked

PostgreSQL container address in the docker network

skipinstalldocker

--skipinstalldocker

yesno

y

not asked

Do not install docker for the PostgreSQL container

launchinitiator

--launchinitiator

str

not asked

Internal: who launched this script

gen_container_cmd.sh

Name Command line Type Default Screen Description

container

--container

str

not asked

Container name