From ea716a10e6b86a2be2aaee184f871121918fdd0d Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Wed, 13 Nov 2024 18:20:56 -0600 Subject: [PATCH] add extension pgaudit --- .../pg_extensions/pgaudit/configuring.mdx | 24 +++++++ advocacy_docs/pg_extensions/pgaudit/index.mdx | 23 ++++++ .../pg_extensions/pgaudit/installing.mdx | 70 +++++++++++++++++++ .../pg_extensions/pgaudit/rel_notes/index.mdx | 10 +++ .../rel_notes/pgaudit_17_rel_notes.mdx | 6 ++ advocacy_docs/pg_extensions/pgaudit/using.mdx | 6 ++ 6 files changed, 139 insertions(+) create mode 100644 advocacy_docs/pg_extensions/pgaudit/configuring.mdx create mode 100644 advocacy_docs/pg_extensions/pgaudit/index.mdx create mode 100644 advocacy_docs/pg_extensions/pgaudit/installing.mdx create mode 100644 advocacy_docs/pg_extensions/pgaudit/rel_notes/index.mdx create mode 100644 advocacy_docs/pg_extensions/pgaudit/rel_notes/pgaudit_17_rel_notes.mdx create mode 100644 advocacy_docs/pg_extensions/pgaudit/using.mdx diff --git a/advocacy_docs/pg_extensions/pgaudit/configuring.mdx b/advocacy_docs/pg_extensions/pgaudit/configuring.mdx new file mode 100644 index 00000000000..6d7c643b8ea --- /dev/null +++ b/advocacy_docs/pg_extensions/pgaudit/configuring.mdx @@ -0,0 +1,24 @@ +--- +title: Configuring pgaudit +navTitle: Configuring +--- + +1. In `postgresql.conf`, add `pgaudit` to the `shared_preload_libraries` parameter: + + ```ini + shared_preload_libraries = 'pgaudit' + ``` + + If `shared_preload_libraries` has other extensions, then you can add `pgaudit` to the list. The order doesn't matter. + + +1. Restart Postgres. + + +1. Create the `pgaudit` extension in your database: + + ```shell + CREATE EXTENSION pgaudit; + ``` + +For detailed information on other configuration steps, see the official [pgaudit documentation](https://github.com/pgaudit/pgaudit). \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/pgaudit/index.mdx b/advocacy_docs/pg_extensions/pgaudit/index.mdx new file mode 100644 index 00000000000..8473cb8a432 --- /dev/null +++ b/advocacy_docs/pg_extensions/pgaudit/index.mdx @@ -0,0 +1,23 @@ +--- +title: 'pgaudit' +indexCards: none +navigation: + - rel_notes + - installing + - configuring + - using +directoryDefaults: + product: pgaudit +--- + +`pgaudit` is an extension released as open source software under the PostgreSQL License. + +`pgaudit` is used to produce session and object audit logging. You can create detailed logging for DML and DDL statements. + +For more information about `pgaudit`, see: + +- [Installing pgaudit](installing.mdx) +- [Configuring pgaudit](configuring.mdx) +- [Using pgaudit](using.mdx) + + diff --git a/advocacy_docs/pg_extensions/pgaudit/installing.mdx b/advocacy_docs/pg_extensions/pgaudit/installing.mdx new file mode 100644 index 00000000000..6910a129065 --- /dev/null +++ b/advocacy_docs/pg_extensions/pgaudit/installing.mdx @@ -0,0 +1,70 @@ +--- +title: Installing pgaudit +navTitle: Installing +--- + +`pg_audit` is supported on the same platforms as the Postgres distribution you're using. Support for `pg_audit` starts with Postgres 12. For details, see: + +- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg) +- [EDB Postgres Extended Server Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#epas_extended) + +## Installation + +Before you begin the installation process: + +- Install Postgres. See: + + - [Installing PostgreSQL](https://www.postgresql.org/download/) + + - [Installing EDB Postgres Extended Server](/pge/latest/installing/) + +- Set up the repository. + + Setting up the repository is a one-time task. If you've already set up your repository, you don't need to perform this step. + + To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there. + +## Install the package + +The syntax for the package install command is: + +```shell +# For SLES, CentOS, RHEL and its derivatives +sudo -y install edb--pg-audit1 + +# For Debian and Ubuntu +sudo -y install edb--pg-audit-1 +``` + +Where: +- ``is the package manager used with your operating system: + + | Package manager | Operating system | + | --------------- | -------------------------------- | + | dnf | RHEL 8/9 and derivatives | + | yum | RHEL 7 and derivatives, CentOS 7 | + | zypper | SLES | + | apt-get | Debian and derivatives | + +- `` is the distribution of Postgres you're using: + + | Postgres distribution | Value | + | ---------------------------- | ---------- | + | PostgreSQL | pg | + | EDB Postgres Extended Server | postgresextended | + +- `` is the version of Postgres you're using. + +For example, to install pg_audit for EDB Postgres 15 on a RHEL 8 platform: + +```shell +sudo dnf -y install edb-pg15-pg-audit1 +``` +!!!Note +For Postgres 16, the pgaudit extension major version is 16. +For Postgres 15 and under, the pgaudit extension major version is 1. +!!! + + + + diff --git a/advocacy_docs/pg_extensions/pgaudit/rel_notes/index.mdx b/advocacy_docs/pg_extensions/pgaudit/rel_notes/index.mdx new file mode 100644 index 00000000000..382671d51d8 --- /dev/null +++ b/advocacy_docs/pg_extensions/pgaudit/rel_notes/index.mdx @@ -0,0 +1,10 @@ +--- +title: 'pgaudit release notes' +navTitle: "Release notes" +indexCards: none +--- +The pgaudit documentation describes the latest version of pgaudit, including minor releases and patches. These release notes cover what was new in each release. For new functionality introduced in a minor or patch release, there are also indicators in the content about the release that introduced the feature. + +| Version | Release Date | +| ----------------------------------- | ------------ | +| [17](pgaudit_17_rel_notes) | 26 May 2024 | diff --git a/advocacy_docs/pg_extensions/pgaudit/rel_notes/pgaudit_17_rel_notes.mdx b/advocacy_docs/pg_extensions/pgaudit/rel_notes/pgaudit_17_rel_notes.mdx new file mode 100644 index 00000000000..4cf726e7efe --- /dev/null +++ b/advocacy_docs/pg_extensions/pgaudit/rel_notes/pgaudit_17_rel_notes.mdx @@ -0,0 +1,6 @@ +--- +title: Release notes for pgaudit +navTitle: "Version 17.0" +--- + +For `pgaudit` release notes, see the [pgaudit official release notes](https://github.com/pgaudit/pgaudit/releases/). diff --git a/advocacy_docs/pg_extensions/pgaudit/using.mdx b/advocacy_docs/pg_extensions/pgaudit/using.mdx new file mode 100644 index 00000000000..f1b8d355da1 --- /dev/null +++ b/advocacy_docs/pg_extensions/pgaudit/using.mdx @@ -0,0 +1,6 @@ +--- +title: Using pgaudit +navTitle: Using +--- + +For information on using `pgaudit`, see the official [pgaudit documentation](https://github.com/pgaudit/pgaudit). \ No newline at end of file