Skip to content

Propagate changes to database-security-service-api-ref from PreProd environment #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
otc-zuul merged 1 commit into from
Dec 12, 2025
Merged

Propagate changes to database-security-service-api-ref from PreProd environment #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed umn/source/_static/images/en-us_image_0000001127059132.png
View file
Open in desktop
Binary file not shown.
Binary file removed umn/source/_static/images/en-us_image_0000001127298856.png
View file
Open in desktop
Binary file not shown.
Binary file removed umn/source/_static/images/en-us_image_0000001173095271.png
View file
Open in desktop
Binary file not shown.
Binary file removed umn/source/_static/images/en-us_image_0000001173357101.png
View file
Open in desktop
Binary file not shown.
Binary file removed umn/source/_static/images/en-us_image_0000001293796118.png
View file
Open in desktop
Binary file not shown.
Binary file removed umn/source/_static/images/en-us_image_0000001880657541.png
View file
Open in desktop
Binary file not shown.
0 ...c/images/en-us_image_0000001570429773.png → ...c/images/en-us_image_0000002230396592.png
View file
Open in desktop
File renamed without changes
6 changes: 0 additions & 6 deletions umn/source/adding_risky_operations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,6 @@ Procedure

#. Set the operation type, operation object, and execution result. For details about related parameters, see :ref:`Table 2 <dbss_01_0192__table1588718356449>`.


.. figure:: /_static/images/en-us_image_0000001127298856.png
:alt: **Figure 2** Setting the operation type, operation object, and execution result

**Figure 2** Setting the operation type, operation object, and execution result

.. _dbss_01_0192__table1588718356449:

.. table:: **Table 2** Parameters
Expand Down
13 changes: 6 additions & 7 deletions umn/source/best_practices/auditing_an_rds_db_instance_without_agents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,27 @@ This section describes how to audit the security of a relational database instan
Solution Architecture
---------------------

The DBSS instance receives the logs sent from databases, such as certain GaussDB(for MySQL) or RDS for MySQL versions, and saves the logs to its log library for security analysis, aggregation statistics, and compliance analysis.
The DBSS instance receives the logs sent from databases, such as certain TaurusDB or RDS for MySQL versions, and saves the logs to its log library for security analysis, aggregation statistics, and compliance analysis.


.. figure:: /_static/images/en-us_image_0000001438417909.png
:alt: **Figure 1** Auditing an RDS DB instance (without agents)

**Figure 1** Auditing an RDS DB instance (without agents)

Take the :ref:`GaussDB(for MySQL) <dbss_06_0020__en-us_topic_0000001438668561_table79614220126>` database as an example. Assume you need to locate and track internal violations and improper operations in the database to meet compliance requirements. This section describes how to enable the database audit function and check audit results.
Take the TaurusDB database as an example. For details, see :ref:`Table 2 <dbss_06_0020__en-us_topic_0000001438668561_table79614220126>`. Assume you need to locate and track internal violations and improper operations in the database to meet compliance requirements. This section describes how to enable the database audit function and check audit results.

.. _dbss_06_0020__en-us_topic_0000001438668561_table79614220126:

.. table:: **Table 1** Database example

============= ==================
============= =============
Database Type RDS database
Database Type GaussDB(for MySQL)
Database Type TaurusDB
Version MySQL 8.0
IP Address 192.168.0.237
Database Port 3306
============= ==================
============= =============

Limitations and Constraints
---------------------------
Expand Down Expand Up @@ -107,13 +107,12 @@ You can check audit results on the dashboard page, or generate, preview, or down

e. Click **OK**.

The **Reports** page will be displayed. You can view the report status on this page. After a report is generated, you can click **Preview** or choose **More** > **Download**. See :ref:`Figure 2 <dbss_06_0020__en-us_topic_0000001438668561_en-us_topic_0252967583_fig17206172612245>`.
The **Reports** page will be displayed. You can view the report status on this page. After a report is generated, you can click **Preview** or choose **More** > **Download**.

.. important::

To preview a report online, use Google Chrome or Mozilla FireFox.

.. _dbss_06_0020__en-us_topic_0000001438668561_en-us_topic_0252967583_fig17206172612245:

.. figure:: /_static/images/en-us_image_0000001560437302.png
:alt: **Figure 2** Previewing or downloading an audit report
Expand Down
83 changes: 46 additions & 37 deletions umn/source/change_history.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,49 @@
Change History
==============

+-----------------------------------+----------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+================================================================================================================+
| 2025-04-03 | This is the fourth official release. |
| | |
| | Optimized: |
| | |
| | - Changed the database name to MySQL. |
| | - Added the description of the source IP address and source port in :ref:`Adding Audit Scope <dbss_01_0190>`. |
| | - Modified the string: Audit Rules. |
| | - Modified the string: Apply for DBSS. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------+
| 2024-10-30 | This is the third official release. |
| | |
| | - Modified :ref:`Table 1 <dbss_01_0001__table1221454114112>`. |
| | - Supported :ref:`Adding an SQL Whitelist <dbss_01_0046>`. |
| | - Supported :ref:`Managing an SQL Whitelist <dbss_01_0047>`. |
| | |
| | Supported the following database versions: |
| | |
| | - RDS for MySQL 5.6 (5.6.51.1 or later) |
| | - RDS for MySQL 5.7 (5.7.29.2 or later) |
| | - RDS for MySQL 8.0 (8.0.20.3 or later) |
| | - PostgreSQL 14 (14.4 or later) |
| | - PostgreSQL 13 (13.6 or later) |
| | - PostgreSQL 12 (12.10 or later) |
| | - PostgreSQL 11 (11.15 or later) |
| | - PostgreSQL 9.6 (9.6.24 or later) |
| | - PostgreSQL 9.5 (9.5.25 or later) |
| | - SQLServer supports all editions by default. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------+
| 2023-05-31 | This is the second official release. |
| | |
| | Added "Best Practices." |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------+
| 2022-07-30 | This is the first official release. |
+-----------------------------------+----------------------------------------------------------------------------------------------------------------+
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+====================================================================================================================================+
| 2025-11-18 | This is the sixth official release. |
| | |
| | - Updated :ref:`Viewing Session Distribution <dbss_01_0206>`. |
| | - Updated :ref:`Viewing Audit Reports <dbss_01_0248>`. |
| | - GaussDB(for MySQL) is renamed TaurusDB. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| 2025-06-27 | This is the fifth official release. |
| | |
| | - Added the **Exception Client IP Address/IP Address Segment** parameter to :ref:`Adding Risky Operations <dbss_01_0192>`. |
| | - Added the description that more than 100 risk detection types are supported in :ref:`Managing Risky Operations <dbss_01_0201>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| 2025-04-03 | This is the fourth official release. |
| | |
| | Optimized: |
| | |
| | - Changed the database name to MySQL. |
| | - Added the description of the source IP address and source port in :ref:`Adding Audit Scope <dbss_01_0190>`. |
| | - Modified the string: Audit Rules. |
| | - Modified the string: Apply for DBSS. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| 2024-10-30 | This is the third official release. |
| | |
| | Modified :ref:`Table 1 <dbss_01_0001__table1221454114112>`. |
| | |
| | Supported the following database versions: |
| | |
| | - RDS for MySQL 5.6 (5.6.51.1 or later) |
| | - RDS for MySQL 5.7 (5.7.29.2 or later) |
| | - RDS for MySQL 8.0 (8.0.20.3 or later) |
| | - PostgreSQL 14 (14.4 or later) |
| | - PostgreSQL 13 (13.6 or later) |
| | - PostgreSQL 12 (12.10 or later) |
| | - PostgreSQL 11 (11.15 or later) |
| | - PostgreSQL 9.6 (9.6.24 or later) |
| | - PostgreSQL 9.5 (9.5.25 or later) |
| | - SQLServer supports all editions by default. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| 2023-05-31 | This is the second official release. |
| | |
| | Added "Best Practices." |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| 2022-07-30 | This is the first official release. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
12 changes: 3 additions & 9 deletions umn/source/configuring_alarm_notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,16 @@ Procedure

#. Set alarm notifications. For details about related parameters, see :ref:`Table 1 <dbss_01_0239__table29461252153613>`.


.. figure:: /_static/images/en-us_image_0000001173357101.png
:alt: **Figure 1** Configuring alarm notifications

**Figure 1** Configuring alarm notifications

.. _dbss_01_0239__table29461252153613:

.. table:: **Table 1** Alarm notification parameters

+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+
| Parameter | Description | Example Value |
+============================+=========================================================================================================================================================================================+=======================+
| Message Notifications | Enables or disables notifications. | |image1| |
| Alarm Notifications | Status of the alarm notification function By default, **Alarm Notifications** is enabled for database audit. You will receive an email when a configured alarm is triggered. | ``-`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+
| Alarm Mode | Email notifications are supported currently. | Email Notifications |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+
| SMN Topic | Select an existing topic from the drop-down list or click **View Topic** and create an SMN topic on the displayed page for configuring the terminals for receiving alarm notifications. | ``-`` |
| | | |
Expand Down Expand Up @@ -75,5 +71,3 @@ Procedure
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+

#. Click **Apply**.

.. |image1| image:: /_static/images/en-us_image_0000001880657541.png
Loading