Skip to content

Propagate changes to distributed-message-service-api-ref from PreProd environment #61

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

otcbot[bot]
Copy link
Contributor

@otcbot otcbot bot commented Jan 15, 2025

This is an automatically created Pull Request for changes to distributed-message-service-api-ref to promote changes down the pipeline to Production environment.

The original change can be found under https://gitea.eco.tsi-dev.otc-service.com/docs/distributed-message-service/pulls/183.

There were patch conflicts, please review original patch file.

@otcbot otcbot bot added the documentation Improvements or additions to documentation label Jan 15, 2025
Copy link
Contributor Author

otcbot bot commented Jan 15, 2025

I tried my best, but could not apply the patch as is, therefore I will report you what I could not apply.

BTW, if in the diff you see removed line equal to the added line it may be caused by invisible trailing spaces. This is safe to ignore.

In most cases content of the patch remainder need to be carefully analyzed and necessary changes applied manually.

Following is the patch remainder:

diff a/umn/source/creating_a_kafka_instance.rst b/umn/source/creating_a_kafka_instance.rst	(rejected hunks)
@@ -218,45 +218,45 @@ Procedure
 
    .. table:: **Table 3** Ciphertext access parameters
 
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | Parameter                 | Value                 | Description                                                                                                                                                                                                              |
-      +===========================+=======================+==========================================================================================================================================================================================================================+
-      | Security Protocol         | SASL_SSL              | SASL is used for authentication. Data is encrypted with SSL certificates for high-security transmission.                                                                                                                 |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | SCRAM-SHA-512 is enabled by default. To use PLAIN, enable **SASL/PLAIN**.                                                                                                                                                |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | **What are SCRAM-SHA-512 and PLAIN mechanisms?**                                                                                                                                                                         |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | -  SCRAM-SHA-512: uses the hash algorithm to generate credentials for usernames and passwords to verify identities. SCRAM-SHA-512 is more secure than PLAIN.                                                             |
-      |                           |                       | -  PLAIN: a simple username and password verification mechanism.                                                                                                                                                         |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      |                           | SASL_PLAINTEXT        | SASL is used for authentication. Data is transmitted in plaintext for high performance.                                                                                                                                  |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | SCRAM-SHA-512 is enabled by default. To use PLAIN, enable **SASL/PLAIN**. SCRAM-SHA-512 authentication is recommended for plaintext transmission.                                                                        |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | Cross-VPC Access Protocol | ``-``                 | -  When **Plaintext Access** is enabled and **Ciphertext Access** is disabled, **PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                                  |
-      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_SSL**, **SASL_SSL** is used for **Cross-VPC Access Protocol**.                                                                              |
-      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_PLAINTEXT**, **SASL_PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                  |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | Fixed once the instance is created.                                                                                                                                                                                      |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | SASL/PLAIN                | ``-``                 | -  If **SASL/PLAIN** is disabled, the SCRAM-SHA-512 mechanism is used for username and password authentication.                                                                                                          |
-      |                           |                       | -  If **SASL/PLAIN** is enabled, both the SCRAM-SHA-512 and PLAIN mechanisms are supported. You can select either of them as required.                                                                                   |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | The **SASL/PLAIN** setting cannot be changed once ciphertext access is enabled.                                                                                                                                          |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | Username and Password     | ``-``                 | Username and password used by the client to connect to the Kafka instance.                                                                                                                                               |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | A username should contain 4 to 64 characters, start with a letter, and contain only letters, digits, hyphens (-), and underscores (_).                                                                                   |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | A password must meet the following requirements:                                                                                                                                                                         |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | -  Contains 8 to 32 characters.                                                                                                                                                                                          |
-      |                           |                       | -  Cannot start with a hyphen (-) and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, spaces, and special characters \`~! @#$\ ``%^&*()-_=+\|[{}];:'",<.>?`` |
-      |                           |                       | -  Cannot be the username spelled forwards or backwards.                                                                                                                                                                 |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | The username cannot be changed once ciphertext access is enabled.                                                                                                                                                        |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Parameter                 | Value                 | Description                                                                                                                                                                                                             |
+      +===========================+=======================+=========================================================================================================================================================================================================================+
+      | Security Protocol         | SASL_SSL              | SASL is used for authentication. Data is encrypted with SSL certificates for high-security transmission.                                                                                                                |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | SCRAM-SHA-512 is enabled by default. To use PLAIN, enable **SASL/PLAIN**.                                                                                                                                               |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | **What are SCRAM-SHA-512 and PLAIN mechanisms?**                                                                                                                                                                        |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | -  SCRAM-SHA-512: uses the hash algorithm to generate credentials for usernames and passwords to verify identities. SCRAM-SHA-512 is more secure than PLAIN.                                                            |
+      |                           |                       | -  PLAIN: a simple username and password verification mechanism.                                                                                                                                                        |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      |                           | SASL_PLAINTEXT        | SASL is used for authentication. Data is transmitted in plaintext for high performance.                                                                                                                                 |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | SCRAM-SHA-512 is enabled by default. To use PLAIN, enable **SASL/PLAIN**. SCRAM-SHA-512 authentication is recommended for plaintext transmission.                                                                       |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Cross-VPC Access Protocol | ``-``                 | -  When **Plaintext Access** is enabled and **Ciphertext Access** is disabled, **PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                                 |
+      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_SSL**, **SASL_SSL** is used for **Cross-VPC Access Protocol**.                                                                             |
+      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_PLAINTEXT**, **SASL_PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                 |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | Fixed once the instance is created.                                                                                                                                                                                     |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | SASL/PLAIN                | ``-``                 | -  If **SASL/PLAIN** is disabled, the SCRAM-SHA-512 mechanism is used for username and password authentication.                                                                                                         |
+      |                           |                       | -  If **SASL/PLAIN** is enabled, both the SCRAM-SHA-512 and PLAIN mechanisms are supported. You can select either of them as required.                                                                                  |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | The **SASL/PLAIN** setting cannot be changed once ciphertext access is enabled.                                                                                                                                         |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Username and Password     | ``-``                 | Username and password used by the client to connect to the Kafka instance.                                                                                                                                              |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | A username should contain 4 to 64 characters, start with a letter, and contain only letters, digits, hyphens (-), and underscores (_).                                                                                  |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | A password must meet the following requirements:                                                                                                                                                                        |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | -  Contains 8 to 32 characters.                                                                                                                                                                                         |
+      |                           |                       | -  Cannot start with a hyphen (-) and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, spaces, and special characters \`~! @#$ ``%^&*()-_=+\|[{}];:'",<.>?`` |
+      |                           |                       | -  Cannot be the username spelled forwards or backwards.                                                                                                                                                                |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | The username cannot be changed once ciphertext access is enabled.                                                                                                                                                       |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
    .. note::
 
diff a/umn/source/connecting_to_an_instance/configuring_kafka_access_control/configuring_plaintext_or_ciphertext_access_to_kafka_instances.rst b/umn/source/connecting_to_an_instance/configuring_kafka_access_control/configuring_plaintext_or_ciphertext_access_to_kafka_instances.rst	(rejected hunks)
@@ -100,43 +100,43 @@ Enabling Ciphertext Access
 
    .. table:: **Table 3** Ciphertext access parameters
 
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | Parameter                 | Value                 | Description                                                                                                                                                                                                              |
-      +===========================+=======================+==========================================================================================================================================================================================================================+
-      | Security Protocol         | SASL_SSL              | SASL is used for authentication. Data is encrypted with SSL certificates for high-security transmission.                                                                                                                 |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      |                           | SASL_PLAINTEXT        | SASL is used for authentication. Data is transmitted in plaintext for high performance.                                                                                                                                  |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | SCRAM-SHA-512 authentication is recommended for plaintext transmission.                                                                                                                                                  |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | Cross-VPC Access Protocol | ``-``                 | -  When **Plaintext Access** is enabled and **Ciphertext Access** is disabled, **PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                                  |
-      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_SSL**, **SASL_SSL** is used for **Cross-VPC Access Protocol**.                                                                              |
-      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_PLAINTEXT**, **SASL_PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                  |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | Fixed once the instance is created.                                                                                                                                                                                      |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | SASL/PLAIN                | ``-``                 | -  If **SASL/PLAIN** is disabled, the SCRAM-SHA-512 mechanism is used for username and password authentication.                                                                                                          |
-      |                           |                       | -  If **SASL/PLAIN** is enabled, both the SCRAM-SHA-512 and PLAIN mechanisms are supported. You can select either of them as required.                                                                                   |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | The **SASL/PLAIN** setting cannot be changed once ciphertext access is enabled.                                                                                                                                          |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | **What are SCRAM-SHA-512 and PLAIN mechanisms?**                                                                                                                                                                         |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | -  SCRAM-SHA-512: uses the hash algorithm to generate credentials for usernames and passwords to verify identities. SCRAM-SHA-512 is more secure than PLAIN.                                                             |
-      |                           |                       | -  PLAIN: a simple username and password verification mechanism.                                                                                                                                                         |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | Username and Password     | ``-``                 | Username and password used by the client to connect to the Kafka instance.                                                                                                                                               |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | A username should contain 4 to 64 characters, start with a letter, and contain only letters, digits, hyphens (-), and underscores (_).                                                                                   |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | A password must meet the following requirements:                                                                                                                                                                         |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | -  Contains 8 to 32 characters.                                                                                                                                                                                          |
-      |                           |                       | -  Cannot start with a hyphen (-) and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, spaces, and special characters \`~! @#$\ ``%^&*()-_=+\|[{}];:'",<.>?`` |
-      |                           |                       | -  Cannot be the username spelled forward or backward.                                                                                                                                                                   |
-      |                           |                       |                                                                                                                                                                                                                          |
-      |                           |                       | The username cannot be changed once ciphertext access is enabled.                                                                                                                                                        |
-      +---------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Parameter                 | Value                 | Description                                                                                                                                                                                                             |
+      +===========================+=======================+=========================================================================================================================================================================================================================+
+      | Security Protocol         | SASL_SSL              | SASL is used for authentication. Data is encrypted with SSL certificates for high-security transmission.                                                                                                                |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      |                           | SASL_PLAINTEXT        | SASL is used for authentication. Data is transmitted in plaintext for high performance.                                                                                                                                 |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | SCRAM-SHA-512 authentication is recommended for plaintext transmission.                                                                                                                                                 |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Cross-VPC Access Protocol | ``-``                 | -  When **Plaintext Access** is enabled and **Ciphertext Access** is disabled, **PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                                 |
+      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_SSL**, **SASL_SSL** is used for **Cross-VPC Access Protocol**.                                                                             |
+      |                           |                       | -  When **Ciphertext Access** is enabled and **Security Protocol** is **SASL_PLAINTEXT**, **SASL_PLAINTEXT** is used for **Cross-VPC Access Protocol**.                                                                 |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | Fixed once the instance is created.                                                                                                                                                                                     |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | SASL/PLAIN                | ``-``                 | -  If **SASL/PLAIN** is disabled, the SCRAM-SHA-512 mechanism is used for username and password authentication.                                                                                                         |
+      |                           |                       | -  If **SASL/PLAIN** is enabled, both the SCRAM-SHA-512 and PLAIN mechanisms are supported. You can select either of them as required.                                                                                  |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | The **SASL/PLAIN** setting cannot be changed once ciphertext access is enabled.                                                                                                                                         |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | **What are SCRAM-SHA-512 and PLAIN mechanisms?**                                                                                                                                                                        |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | -  SCRAM-SHA-512: uses the hash algorithm to generate credentials for usernames and passwords to verify identities. SCRAM-SHA-512 is more secure than PLAIN.                                                            |
+      |                           |                       | -  PLAIN: a simple username and password verification mechanism.                                                                                                                                                        |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Username and Password     | ``-``                 | Username and password used by the client to connect to the Kafka instance.                                                                                                                                              |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | A username should contain 4 to 64 characters, start with a letter, and contain only letters, digits, hyphens (-), and underscores (_).                                                                                  |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | A password must meet the following requirements:                                                                                                                                                                        |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | -  Contains 8 to 32 characters.                                                                                                                                                                                         |
+      |                           |                       | -  Cannot start with a hyphen (-) and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, spaces, and special characters \`~! @#$ ``%^&*()-_=+\|[{}];:'",<.>?`` |
+      |                           |                       | -  Cannot be the username spelled forward or backward.                                                                                                                                                                  |
+      |                           |                       |                                                                                                                                                                                                                         |
+      |                           |                       | The username cannot be changed once ciphertext access is enabled.                                                                                                                                                       |
+      +---------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
    .. note::
 

@amuetzelgit
Copy link

recheck

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants