Skip to content

Commit c475ac8

Browse files
djw-mdjw-m
committed
Edits and regen for PGE docs extension
Signed-off-by: Dj Walker-Morgan <dj.walker-morgan@enterprisedb.com>
1 parent 5aacdf2 commit c475ac8

File tree

25 files changed

+1937
-43
lines changed

25 files changed

+1937
-43
lines changed

‎install_template/templates/products/edb-postgres-extended-server/base.njk‎

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{% extends "platformBase/" + platformBaseTemplate + '.njk' %}
22
{% set packageName = packageName or 'edb-postgresextended<xx>-server edb-postgresextended<xx>-contrib' %}
3+
{% set packageName = packageName | replace('<xx>', product.version) %}
34
{% import "platformBase/_deploymentConstants.njk" as deploy %}
45
{% block frontmatter %}
56
{#
@@ -12,6 +13,96 @@ redirects:
1213
{% endblock frontmatter %}
1314
{% block installCommand %}
1415
{{super()}}
15-
Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version {{ product.version }}, the package name would be {{packageName | replace('<xx>', product.version)}}.
1616

17-
{% endblock installCommand %}
17+
{% endblock installCommand %}
18+
19+
{% block postinstall %}
20+
## Initial configuration
21+
{% block debian_ubuntu %}
22+
Getting started with your cluster involves logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password.
23+
24+
First, you need to initialize and start the database cluster. The `edb-pge-{{ product.version | replace(".", "") }}-setup` script creates a cluster.
25+
26+
```shell
27+
sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/pge{{ product.version }}/bin/edb-pge-{{ product.version | replace(".", "") }}-setup initdb
28+
29+
sudo systemctl start edb-pge-{{ product.version }}
30+
```
31+
{% endblock debian_ubuntu %}
32+
33+
To work in your cluster, log in as the postgres user. Connect to the database server using the psql command-line client. Alternatively, you can use a client of your choice with the appropriate connection string.
34+
35+
```shell
36+
sudo -iu postgres
37+
38+
psql postgres
39+
```
40+
41+
The server runs with the `peer` or `ident` permission by default. You can change the authentication method by modifying the `pg_hba.conf` file.
42+
43+
{# this is kinda awful, but gotta deal with the reorg somehow... --jh #}
44+
{% set config_doc_path = "database_administration/01_configuration_parameters/01_setting_new_parameters/" if product.version >= 15 else "epas_guide/03_database_administration/01_configuration_parameters/01_setting_new_parameters/" %}
45+
Before changing the authentication method, assign a password to the database superuser, postgres. For more information on changing the authentication, see [Modifying the pg_hba.conf file](../../{{config_doc_path}}#modifying-the-pg_hbaconf-file).
46+
47+
```sql
48+
ALTER ROLE postgres with PASSWORD 'password';
49+
```
50+
51+
## Experiment
52+
53+
Now you're ready to create and connect to a database, create a table, insert data in a table, and view the data from the table.
54+
55+
First, use psql to create a database named `hr` to hold human resource information.
56+
57+
```sql
58+
# running in psql
59+
CREATE DATABASE hr;
60+
__OUTPUT__
61+
CREATE DATABASE
62+
```
63+
64+
Connect to the `hr` database inside psql:
65+
66+
```
67+
\c hr
68+
__OUTPUT__
69+
You are now connected to database "hr" as user "postgres".
70+
```
71+
72+
Create columns to hold department numbers, unique department names, and locations:
73+
74+
```
75+
CREATE TABLE public.dept (deptno numeric(2) NOT NULL CONSTRAINT dept_pk
76+
PRIMARY KEY, dname varchar(14) CONSTRAINT dept_dname_uq UNIQUE, loc
77+
varchar(13));
78+
__OUTPUT__
79+
CREATE TABLE
80+
```
81+
82+
Insert values into the `dept` table:
83+
84+
```
85+
INSERT INTO dept VALUES (10,'ACCOUNTING','NEW YORK');
86+
__OUTPUT__
87+
INSERT 0 1
88+
```
89+
90+
```
91+
INSERT into dept VALUES (20,'RESEARCH','DALLAS');
92+
__OUTPUT__
93+
INSERT 0 1
94+
```
95+
96+
View the table data by selecting the values from the table:
97+
98+
```
99+
SELECT * FROM dept;
100+
__OUTPUT__
101+
deptno | dname | loc
102+
--------+------------+----------
103+
10 | ACCOUNTING | NEW YORK
104+
20 | RESEARCH | DALLAS
105+
(2 rows)
106+
```
107+
108+
{% endblock postinstall %}

‎install_template/templates/products/edb-postgres-extended-server/debian.njk‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{% extends "products/edb-postgres-extended-server/base.njk" %}
22
{% block debian_ubuntu %}This section steps you through getting started with your cluster including logging in, ensuring the installation was successful, connecting to your cluster, and creating the user password.
33

4-
```shell{% endblock debian_ubuntu %}
4+
{% endblock debian_ubuntu %}

‎product_docs/docs/migration_toolkit/55/installing/linux_x86_64/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ navigation:
2020
- mtk_sles_12
2121
- mtk_ubuntu_22
2222
- mtk_ubuntu_20
23+
- mtk_ubuntu_18
2324
- mtk_debian_11
2425
- mtk_debian_10
2526
---

‎product_docs/docs/pge/15/installing/linux_x86_64/pge_centos_7.mdx‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,90 @@ Before you begin the installation process:
4040
## Install the package
4141

4242
```shell
43-
sudo yum -y install edb-postgresextended<xx>-server edb-postgresextended<xx>-contrib
43+
sudo yum -y install edb-postgresextended15-server edb-postgresextended15-contrib
4444
```
4545

46-
Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version 15, the package name would be edb-postgresextended15-server edb-postgresextended15-contrib.
46+
## Initial configuration
47+
48+
Getting started with your cluster involves logging in, ensuring the installation and initial configuration was successful, connecting to your cluster, and creating the user password.
49+
50+
First, you need to initialize and start the database cluster. The `edb-pge-15-setup` script creates a cluster.
51+
52+
```shell
53+
sudo PGSETUP_INITDB_OPTIONS="-E UTF-8" /usr/edb/pge15/bin/edb-pge-15-setup initdb
54+
55+
sudo systemctl start edb-pge-15
56+
```
57+
58+
To work in your cluster, log in as the postgres user. Connect to the database server using the psql command-line client. Alternatively, you can use a client of your choice with the appropriate connection string.
59+
60+
```shell
61+
sudo -iu postgres
62+
63+
psql postgres
64+
```
65+
66+
The server runs with the `peer` or `ident` permission by default. You can change the authentication method by modifying the `pg_hba.conf` file.
67+
68+
Before changing the authentication method, assign a password to the database superuser, postgres. For more information on changing the authentication, see [Modifying the pg_hba.conf file](../../database_administration/01_configuration_parameters/01_setting_new_parameters/#modifying-the-pg_hbaconf-file).
69+
70+
```sql
71+
ALTER ROLE postgres with PASSWORD 'password';
72+
```
73+
74+
## Experiment
75+
76+
Now you're ready to create and connect to a database, create a table, insert data in a table, and view the data from the table.
77+
78+
First, use psql to create a database named `hr` to hold human resource information.
79+
80+
```sql
81+
# running in psql
82+
CREATE DATABASE hr;
83+
__OUTPUT__
84+
CREATE DATABASE
85+
```
86+
87+
Connect to the `hr` database inside psql:
88+
89+
```
90+
\c hr
91+
__OUTPUT__
92+
You are now connected to database "hr" as user "postgres".
93+
```
94+
95+
Create columns to hold department numbers, unique department names, and locations:
96+
97+
```
98+
CREATE TABLE public.dept (deptno numeric(2) NOT NULL CONSTRAINT dept_pk
99+
PRIMARY KEY, dname varchar(14) CONSTRAINT dept_dname_uq UNIQUE, loc
100+
varchar(13));
101+
__OUTPUT__
102+
CREATE TABLE
103+
```
104+
105+
Insert values into the `dept` table:
106+
107+
```
108+
INSERT INTO dept VALUES (10,'ACCOUNTING','NEW YORK');
109+
__OUTPUT__
110+
INSERT 0 1
111+
```
112+
113+
```
114+
INSERT into dept VALUES (20,'RESEARCH','DALLAS');
115+
__OUTPUT__
116+
INSERT 0 1
117+
```
118+
119+
View the table data by selecting the values from the table:
120+
121+
```
122+
SELECT * FROM dept;
123+
__OUTPUT__
124+
deptno | dname | loc
125+
--------+------------+----------
126+
10 | ACCOUNTING | NEW YORK
127+
20 | RESEARCH | DALLAS
128+
(2 rows)
129+
```

‎product_docs/docs/pge/15/installing/linux_x86_64/pge_debian_10.mdx‎

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,84 @@ Before you begin the installation process:
3535
## Install the package
3636

3737
```shell
38-
sudo apt-get -y install edb-postgresextended-<xx>
38+
sudo apt-get -y install edb-postgresextended-15
3939
```
4040

4141
Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version 15, the package name would be `edb-postgresextended-15`.
42+
43+
## Initial configuration
44+
45+
This section steps you through getting started with your cluster including logging in, ensuring the installation was successful, connecting to your cluster, and creating the user password.
46+
47+
To work in your cluster, log in as the postgres user. Connect to the database server using the psql command-line client. Alternatively, you can use a client of your choice with the appropriate connection string.
48+
49+
```shell
50+
sudo -iu postgres
51+
52+
psql postgres
53+
```
54+
55+
The server runs with the `peer` or `ident` permission by default. You can change the authentication method by modifying the `pg_hba.conf` file.
56+
57+
Before changing the authentication method, assign a password to the database superuser, postgres. For more information on changing the authentication, see [Modifying the pg_hba.conf file](../../database_administration/01_configuration_parameters/01_setting_new_parameters/#modifying-the-pg_hbaconf-file).
58+
59+
```sql
60+
ALTER ROLE postgres with PASSWORD 'password';
61+
```
62+
63+
## Experiment
64+
65+
Now you're ready to create and connect to a database, create a table, insert data in a table, and view the data from the table.
66+
67+
First, use psql to create a database named `hr` to hold human resource information.
68+
69+
```sql
70+
# running in psql
71+
CREATE DATABASE hr;
72+
__OUTPUT__
73+
CREATE DATABASE
74+
```
75+
76+
Connect to the `hr` database inside psql:
77+
78+
```
79+
\c hr
80+
__OUTPUT__
81+
You are now connected to database "hr" as user "postgres".
82+
```
83+
84+
Create columns to hold department numbers, unique department names, and locations:
85+
86+
```
87+
CREATE TABLE public.dept (deptno numeric(2) NOT NULL CONSTRAINT dept_pk
88+
PRIMARY KEY, dname varchar(14) CONSTRAINT dept_dname_uq UNIQUE, loc
89+
varchar(13));
90+
__OUTPUT__
91+
CREATE TABLE
92+
```
93+
94+
Insert values into the `dept` table:
95+
96+
```
97+
INSERT INTO dept VALUES (10,'ACCOUNTING','NEW YORK');
98+
__OUTPUT__
99+
INSERT 0 1
100+
```
101+
102+
```
103+
INSERT into dept VALUES (20,'RESEARCH','DALLAS');
104+
__OUTPUT__
105+
INSERT 0 1
106+
```
107+
108+
View the table data by selecting the values from the table:
109+
110+
```
111+
SELECT * FROM dept;
112+
__OUTPUT__
113+
deptno | dname | loc
114+
--------+------------+----------
115+
10 | ACCOUNTING | NEW YORK
116+
20 | RESEARCH | DALLAS
117+
(2 rows)
118+
```

‎product_docs/docs/pge/15/installing/linux_x86_64/pge_debian_11.mdx‎

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,84 @@ Before you begin the installation process:
3535
## Install the package
3636

3737
```shell
38-
sudo apt-get -y install edb-postgresextended-<xx>
38+
sudo apt-get -y install edb-postgresextended-15
3939
```
4040

4141
Where `<xx>` is the version of EDB Postgres Extended Server you are installing. For example, if you are installing version 15, the package name would be `edb-postgresextended-15`.
42+
43+
## Initial configuration
44+
45+
This section steps you through getting started with your cluster including logging in, ensuring the installation was successful, connecting to your cluster, and creating the user password.
46+
47+
To work in your cluster, log in as the postgres user. Connect to the database server using the psql command-line client. Alternatively, you can use a client of your choice with the appropriate connection string.
48+
49+
```shell
50+
sudo -iu postgres
51+
52+
psql postgres
53+
```
54+
55+
The server runs with the `peer` or `ident` permission by default. You can change the authentication method by modifying the `pg_hba.conf` file.
56+
57+
Before changing the authentication method, assign a password to the database superuser, postgres. For more information on changing the authentication, see [Modifying the pg_hba.conf file](../../database_administration/01_configuration_parameters/01_setting_new_parameters/#modifying-the-pg_hbaconf-file).
58+
59+
```sql
60+
ALTER ROLE postgres with PASSWORD 'password';
61+
```
62+
63+
## Experiment
64+
65+
Now you're ready to create and connect to a database, create a table, insert data in a table, and view the data from the table.
66+
67+
First, use psql to create a database named `hr` to hold human resource information.
68+
69+
```sql
70+
# running in psql
71+
CREATE DATABASE hr;
72+
__OUTPUT__
73+
CREATE DATABASE
74+
```
75+
76+
Connect to the `hr` database inside psql:
77+
78+
```
79+
\c hr
80+
__OUTPUT__
81+
You are now connected to database "hr" as user "postgres".
82+
```
83+
84+
Create columns to hold department numbers, unique department names, and locations:
85+
86+
```
87+
CREATE TABLE public.dept (deptno numeric(2) NOT NULL CONSTRAINT dept_pk
88+
PRIMARY KEY, dname varchar(14) CONSTRAINT dept_dname_uq UNIQUE, loc
89+
varchar(13));
90+
__OUTPUT__
91+
CREATE TABLE
92+
```
93+
94+
Insert values into the `dept` table:
95+
96+
```
97+
INSERT INTO dept VALUES (10,'ACCOUNTING','NEW YORK');
98+
__OUTPUT__
99+
INSERT 0 1
100+
```
101+
102+
```
103+
INSERT into dept VALUES (20,'RESEARCH','DALLAS');
104+
__OUTPUT__
105+
INSERT 0 1
106+
```
107+
108+
View the table data by selecting the values from the table:
109+
110+
```
111+
SELECT * FROM dept;
112+
__OUTPUT__
113+
deptno | dname | loc
114+
--------+------------+----------
115+
10 | ACCOUNTING | NEW YORK
116+
20 | RESEARCH | DALLAS
117+
(2 rows)
118+
```

0 commit comments

Comments
 (0)