Skip to content
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

Issues in Accessing OBS Through an NGINX Reverse Proxy page from Best Practices #166

Closed
dsabelni opened this issue Nov 20, 2024 · 0 comments · Fixed by #179
Closed

Issues in Accessing OBS Through an NGINX Reverse Proxy page from Best Practices #166

dsabelni opened this issue Nov 20, 2024 · 0 comments · Fixed by #179
Assignees

Comments

@dsabelni
Copy link

dsabelni commented Nov 20, 2024

There are some issues present in the Accessing OBS Through an NGINX Reverse Proxy page from Best Practices - please update:

Broken link (lines 9-10)

Generally, you can access OBS using a bucket's access domain name for example provided by OBS or using a user-defined domain name bound to an OBS bucket.

here, [for example](https://**bucketname**.obs.eu-de.otc.t-systems.com) is presented as a broken link, though it should be a simple text: (for example, **https://** _bucketname_ **.obs.eu-de.otc.t-systems.com**)

Imprecise statements (lines 38-40)

You have known the region and access domain name of the bucket. For example, the access domain name of a bucket in the eu-de region is nginx-obs.obs.eu-de.otc.t-systems.com.

You have known should be updated to You know to be correct and consistent with the other points. Also the phrase the access domain name of a bucket in the eu-de region is nginx-obs.obs.eu-de.otc.t-systems.com is ambiguous and makes it seem like nginx-obs.obs.eu-de.otc.t-systems.com is the access domain name of any bucket. So I would rephrase these two sentences to:

You know the region and access domain name of the bucket. For example, the access domain name of a bucket named nginx-obs in the eu-de region is nginx-obs.obs.eu-de.otc.t-systems.com.

Incorrect syntax for Note (line 113)

Note: When you use an API, SDK, or obsutil for calling, set this parameter to the region domain name. The following is an example: obs.eu-de.otc.t-systems.com

The Note isn’t displayed properly in the Architecture Center - should be at least moved to the new line, or better the Note syntax should be fixed.
image

Missing screenshot (lines 160-161)

e. Choose a policy configuration method you like. Visual Editor is used here.

This suggests that there should be a screenshot, but no screenshot is present.
An example of a possible screenshot:
image

Missing table (line 163)

f. Configure the following parameters.

This suggests that there should be a table with parameters descriptions, but no table is present.
Text of the table to be added:

      .. table:: **Table 2** Bucket policy parameters

         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
         | Parameter             |                       | Description                                                                                                                 |
         +=======================+=======================+=============================================================================================================================+
         | Policy Name           |                       | Enter a policy name.                                                                                                        |
         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
         | Policy content        | Effect                | Select **Allow**.                                                                                                           |
         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
         |                       | Principal             | -  To select **All accounts** enter **\***.                                                                                 |
         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
         |                       | Resources             | -  Method 1:                                                                                                                |
         |                       |                       |                                                                                                                             |
         |                       |                       |    -  Select **Entire bucket (including the objects in it)**.                                                               |
         |                       |                       |                                                                                                                             |
         |                       |                       | -  Method 2:                                                                                                                |
         |                       |                       |                                                                                                                             |
         |                       |                       |    -  Select **Current bucket** and **Specified objects**.                                                                  |
         |                       |                       |    -  Set the resource path to **\*** to indicate all objects in the bucket.                                                |
         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
         |                       | Actions               | -  Choose **Customize**.                                                                                                    |
         |                       |                       | -  Select **Get\*** and **List\***.                                                                                         |
         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
         |                       | Conditions (Optional) | -  **Key**: Select **SourceIp**.                                                                                            |
         |                       |                       | -  **Condition Operator**: Select **IpAddress**                                                                             |
         |                       |                       | -  **Value**:                                                                                                               |
         |                       |                       |                                                                                                                             |
         |                       |                       |    -  If the ECS uses a public DNS, the value is as follows:                                                                |
         |                       |                       |                                                                                                                             |
         |                       |                       |       *Elastic IP address of the ECS*                                                                                       |
         |                       |                       |                                                                                                                             |
         |                       |                       |    -  If the ECS uses a Open Telekom Cloud private DNS, the value is as follows:                                            |
         |                       |                       |                                                                                                                             |
         |                       |                       |       **100.64.0.0/10,214.0.0.0/7,**\ *Private IP address of the ECS*                                                       |
         |                       |                       |                                                                                                                             |
         |                       |                       |       .. note::                                                                                                             |
         |                       |                       |                                                                                                                             |
         |                       |                       |          You can click **Add** to configure three IP addresses (CIDR blocks).                                               |
         |                       |                       |                                                                                                                             |
         |                       |                       |          IP addresses in the range starting with **100** or **214** are for ECSs to access OBS through an internal network. |
         +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+
@MJZLOTR MJZLOTR linked a pull request Dec 3, 2024 that will close this issue
@otc-zuul otc-zuul bot closed this as completed in #179 Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants