This section describes how to create an instance using WebAdmin.
WebAdmin must be set up correctly before it can be used. Refer to "B.1 Setting Up WebAdmin" for details. Additionally, if WebAdmin needs to be configured to use an external repository database, refer to "B.3 Using an External Repository for WebAdmin" for details.
Learn what you need to know before using WebAdmin.
Recommended Browser
Microsoft Edge (Build41 or later)
WebAdmin will work with other browsers, such as Firefox and Chrome, however, the look and feel may be different.
Configure your browser to allow cookies and pop-up requests from the server on which Fujitsu Enterprise Postgres is installed. Refer to "Appendix A Recommended WebAdmin Environments" for information on how to change the pop-up request settings and other recommended settings.
Notes on operations
It will not work correctly if you operate the same instance from multiple WebAdmin screens at the same time.
If you want to manage multiple versions of an instance, operate with the latest version of WebAdmin.
It is recommended not to use the browser [Back] and [Forward] navigation buttons, the [Refresh] button, and context-sensitive menus, including equivalent keyboard shortcuts.
Do not copy and paste or bookmark the URL of the WebAdmin login screen and skip directly.
Considerations for Using Transparent Data Encryption
After you create an instance in WebAdmin, follow the documentation for each feature in the Operation Guide for additional setup tasks.
About the PostgreSQL Configuration File Relationship
When creating or importing an instance in WebAdmin, set the log_directory parameter in postgresql.conf to '/var/tmp/fsep_version/instanceAdminUser_instanceNamePortNumber/log'.
Note
Note that resources placed in /var/tmp that have not been accessed for 30 days or more will be deleted by the default settings of the operating system. Therefore, consider excluding instances created using WebAdmin from deletion targets in the operating system settings if you need to stop those instances for a long time.
This section describes how to log in to WebAdmin.
In the browser address bar, type the startup URL of the WebAdmin window in the following format:
http://hostNameOrIpAddress:portNumber/
hostNameOrIpAddress: Host name or IP address of the server where WebAdmin is installed.
portNumber: Port number of WebAdmin. The default port number is 27515.
The startup screen is displayed. From this window you can log in to WebAdmin or access the product documentation.
Logging in to WebAdmin
Click [Launch WebAdmin] in the startup URL window to start WebAdmin and display the login window. Enter the instance administrator user ID (operating system user account name) and password, and log in to WebAdmin. User credential (instance administrator user ID and password) should not contain hazardous characters. Refer to "Appendix C WebAdmin Disallow User Inputs Containing Hazardous Characters".
If you set the account lock for login failure, login failure from WebAdmin might lock the account and prevent you from logging in to the OS. Check the account lock settings in advance.
This section describes how to create an instance.
Information
WebAdmin creates an instance configuration file, postgresql.conf, and sets kernel parameters to the optimal values for this configuration. Refer to "Appendix D Configuring Parameters" and "Appendix H Configuring Kernel Parameters" for more information.
WebAdmin automatically sets the memory usage assuming you create one instance per machine. If you are creating multiple instances on a single machine, refer to "Parameters automatically set by WebAdmin according to the amount of memory" to adjust the memory usage after the instance is created.
Start WebAdmin, and log in to the database server.
In the [Instances] tab, click .
Enter the information for the instance to be created.
Enter the following items:
[Host name] and [Operating system credential] should not contain hazardous characters. Refer to "Appendix C WebAdmin Disallow User Inputs Containing Hazardous Characters".
[Configuration type]: Whether to create a standalone instance or an instance that is part of a cluster.
[Server product type]: Sets which of the following instances to create:
Fujitsu Enterprise Postgres 14 Instances
Fujitsu Enterprise Postgres 15 Instances
Fujitsu Enterprise Postgres 16 Instances
Fujitsu Enterprise Postgres 17 Instances
The default is "Fujitsu Enterprise Postgres 17".
[Location]: Whether to create the instance in the server that the current user is logged into, or in a remote server. The default is "Local", which will create the instance in the server machine where WebAdmin is currently running.
[Instance name]: Name of the database instance to manage
The name must meet the conditions below:
Maximum of 16 characters
The first character must be an ASCII alphabetic character
The other characters must be ASCII alphanumeric characters
[Instance port]: Port number of the database server
[Data storage path]: Directory where the database data will be stored
[Backup]: Whether to enable or disable the WebAdmin backup feature. The default is "Enabled". Select "Disabled" to disable all backup and restore functionality for the instance. If "Enabled" is selected, enter the following item:
[Backup storage path]: Directory where the database backup will be stored
[Transaction log path]: Directory where the transaction log will be stored
[Encoding]: Database encoding system
[WAL file size]: Allow the WAL file size to be set when creating an instance. The default is 16 MB if the field is blank. The size specified must be a power of 2 between 1 and 1024. This option is not available for standby instances.
If "Remote" is selected for [Location], enter the following additional items:
[Host name]: Name of the host where the instance is to be created
[Operating system credential]: Operating system user name and password for the remote machine where the instance is to be created
[Remote WebAdmin port for standalone]: Port in which WebAdmin is accessible in the remote machine
Click to create the instance.
If the instance is created successfully, a message indicating the same will be displayed.
The instance will be started when it is created successfully.
Back up the basic information that was set
Back up the WebAdmin management information periodically to ensure operational continuity when a fault occurs on the system disk. Follow the procedure below to perform the backup.
Stop the WebAdmin server. Refer to "B.1.4 Stopping the Web Server Feature of WebAdmin" for details.
Back up the following directory:
webAdminInstallDir/data/fepwa
Note that if you are using an external database as your WebAdmin repository, you must also back up the following:
webAdminInstallDir/data/remotemetadb.conf
Use the database features to back up external databases (if they are created on the system disk).
You can change the information that is set when an instance is created.
Change the following settings to suit the operating and management environment for Fujitsu Enterprise Postgres.
Character encoding
Communication
SQL options
Memory
Streaming replication
Information
These settings are the same as the parameters that can be set in the files shown below. Refer to "Appendix D Configuring Parameters" for information on the equivalence relationship between the item name and the parameter.
postgresql.conf
pg_hba.conf
When [Instance name] or [Instance port] is modified, the log_directory and core_directory parameters in postgresql.conf are updated. Also, the specified directories are created if they do not exist. Refer to “4.3.1.5 Importing Instances” for information on the format of these directories.
Start WebAdmin and log in to the database server.
In the [Instances] tab, click .
Click to change the configuration.
Click to save your changes.
See
Select a client-side encoding system that can be converted to/from the database encoding system. Refer to "Automatic Character Set Conversion Between Server and Client" in "Server Administration" in the PostgreSQL Documentation for information on the encoding system combinations that can be converted.
Start WebAdmin and log in to the database server.
In the [Instances] tab, click .
Click to register new authentication information.
To change authentication information, select the information, and then click .
To delete authentication information, select the information, and then click .
When creating the instance, do not delete the entry below, because it is a connection required for WebAdmin to monitor the operational status of the database:
Type=local, Database=all, User=all, and Method=md5
Use the [Edit instance] page to modify the following items for an instance:
Instance name
Port number
Backup storage path
In the [Instances] tab, click . The [Edit instance] page is displayed.
Modify the relevant items.
If [Backup storage path] is changed, [Backup management] is enabled. Select the required option:
Retain existing backup: Create a backup in [Backup storage path] and retain the existing backup in its original location.
Copy existing backup to new path: Copy the existing backup to [Backup storage path]. A new backup will not be created. The existing backup will be retained in its original location.
Move existing backup to new path: Move the existing backup to [Backup storage path]. A new backup will not be created.
Remove existing backup: Create a backup in [Backup storage path]. The existing backup will be removed.
Click to save your changes.
Instances can be created using WebAdmin, or via the command line using the initdb command. Instances created using the initdb command (command line instances) can be managed using WebAdmin, however, they must first be imported into WebAdmin.
You cannot import instances that use the Mirroring Controller.
Advance Preparation
If the following file contains records that span multiple lines, change the record to a single line before importing.
pg_hba.conf
pg_ident.conf
You must make the following changes to the parameters in postgresql.conf prior to importing the instance in WebAdmin.
Parameter | Requirements |
---|---|
port | The port parameter should be uncommented. |
Delete the values specified for the following parameters. Also, if you have changed the value of the parameter (where the file is stored) from the default, move the file to the data storage directory before importing it.
hba_file parameter (pg_hba.conf)
ident_file parameter (pg_ident.conf)
Import
This section explains how to import command line instances into WebAdmin.
In the [Instances] tab, click . The [Import instance] page is displayed.
Enter the information for the instance being imported. Refer to "4.3.1.3 Creating an Instance" for information on the items that need to be entered.
Click to import the instance.
Information
The log_directory and core_directory parameters in postgresql.conf are updated during import. Also, the specified directories are created if they do not exist.
The format of these directories is as follows:
log_directory: '/var/tmp/fsep_version/instanceAdminUser_instanceNamePortNumber/log' core_directory: '/var/tmp/fsep_version/instanceAdminUser_instanceNamePortNumber/core' version: product version_WA_architecture instanceAdminUser: operating system user name PortNumber: port number specified when creating the instance
Examples:
log_directory: '/var/tmp/fsep_170_WA_64/naomi_myinst27599/log'
core_directory: '/var/tmp/fsep_170_WA_64/naomi_myinst27599/core'