Skip to content

Commit 43e7d33

Browse files
authored
Merge branch 'main' into RHIDP-4807-main
2 parents 3cda7fe + 69d5ec8 commit 43e7d33

38 files changed

+1178
-487
lines changed

artifacts/attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
:ocp-very-short: RHOCP
2727
:osd-brand-name: Red Hat OpenShift Dedicated
2828
:osd-short: OpenShift Dedicated
29+
:logging-brand-name: Red Hat OpenShift Logging
30+
:logging-short: OpenShift Logging
2931
// minimum and current latest supported versions
3032
:ocp-version-min: 4.14
3133
:ocp-version: 4.17

assemblies/assembly-about-rhdh.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ This platform is driven by a centralized software catalog, providing efficiency
1919
Use {product} to simplify decision-making through a selection of internally approved tools, programming languages, and developer resources within a self-managed portal.
2020

2121

22-
include::modules/discover/con-benefits-of-rhdh.adoc[leveloffset=+1]
22+
include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]

assemblies/assembly-audit-log.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ Audit logs are not forwarded to the internal log store by default because this d
3333
* For a complete list of fields that a {product-short} audit log can include, see xref:ref-audit-log-fields.adoc_{context}[]
3434
* For a list of scaffolder events that a {product-short} audit log can include, see xref:ref-audit-log-scaffolder-events.adoc_{context}[]
3535

36-
include::modules/observe/con-audit-log-config.adoc[leveloffset=+1]
36+
include::modules/observe/con-audit-log-config.adoc[]
3737

38-
include::modules/observe/proc-audit-log-view.adoc[leveloffset=+1]
38+
include::modules/observe/proc-forward-audit-log-splunk.adoc[leveloffset=+2]
39+
40+
include::modules/observe/proc-audit-log-view.adoc[]
3941

4042
include::modules/observe/ref-audit-log-fields.adoc[leveloffset=+2]
4143

4244
include::modules/observe/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]
4345

4446
include::modules/observe/ref-audit-log-catalog-events.adoc[leveloffset=+2]
4547

46-
include::modules/observe/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1]
48+
include::modules/observe/ref-audit-log-file-rotation-overview.adoc[]

assemblies/assembly-configuring-authorization-in-rhdh.adoc

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,32 @@ the {product-short} RBAC feature allows you
1616
to define policies in a declarative fashion using a simple CSV based format.
1717
You can define the policies by using {product-short} web interface or REST API, rather than editing the CSV directly.
1818

19-
To apply RBAC in {product-short}:
19+
To define authorizations in {product-short}:
2020

21-
. The {product-short} administrator sets up the RBAC feature:
22-
.. Enable the RBAC feature
23-
.. Configure Policy Administrators
21+
. The {product-short} administrator enables and gives access to the RBAC feature.
2422

25-
. The {product-short} policy administrator configures your RBAC policies:
26-
.. Define roles with specific permissions
27-
.. Assign the roles to users and groups
23+
. You define your roles and policies by combining the following methods:
2824

25+
* The {product-short} policy administrator uses the {product-short} web interface or REST API.
26+
* The {product-short} administrator edits the main {product-short} configuration file.
27+
* The {product-short} administrator edits external files.
2928

3029
include::modules/authorization/proc-enabling-the-rbac-plugin.adoc[leveloffset=+1]
3130

3231

33-
include::assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc[leveloffset=+1]
34-
32+
include::modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc[leveloffset=+1]
3533

36-
include::assembly-managing-authorizations-by-using-the-rest-api.adoc[leveloffset=+1]
3734

38-
39-
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
35+
include::assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc[leveloffset=+1]
4036

4137

42-
include::modules/authorization/con-rbac-config-permission-policies.adoc[leveloffset=+2]
38+
include::assembly-managing-authorizations-by-using-the-rest-api.adoc[leveloffset=+1]
4339

4440

45-
include::modules/authorization/con-rbac-config-permission-policies-external-file.adoc[leveloffset=+3]
41+
include::assembly-managing-authorizations-by-using-external-files.adoc[leveloffset=+1]
4642

47-
include::modules/authorization/proc-mounting-the-policy-csv-file-using-the-operator.adoc[leveloffset=+4]
4843

49-
include::modules/authorization/proc-mounting-the-policy-csv-file-using-helm.adoc[leveloffset=+4]
44+
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
5045

5146

5247
include::modules/authorization/con-rbac-conditional-policies-rhdh.adoc[leveloffset=+1]
@@ -55,9 +50,6 @@ include::modules/authorization/con-rbac-conditional-policies-rhdh.adoc[leveloffs
5550
include::modules/authorization/ref-rbac-conditional-policy-definition.adoc[leveloffset=+2]
5651

5752

58-
include::modules/authorization/proc-rbac-config-conditional-policy-file.adoc[leveloffset=+2]
59-
60-
6153
include::modules/authorization/con-user-stats-rhdh.adoc[leveloffset=+1]
6254

6355

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[id='managing-authorizations-by-using-external-files']
2+
= Managing authorizations by using external files
3+
4+
To automate {product} maintenance, you can configure permissions and roles in external files, before starting {product-short}.
5+
6+
7+
include::modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc[leveloffset=+1]
8+
9+
include::modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc[leveloffset=+1]
10+

assemblies/assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[id='proc-rbac-ui-manage-roles_{context}']
1+
[id='managing-authorizations-by-using-the-web-ui']
22
= Managing role-based access controls (RBAC) using the {product} Web UI
33

44
Policy administrators can use the {product-short} web interface (Web UI) to allocate specific roles and permissions to individual users or groups. Allocating roles ensures that access to resources and functionalities is regulated across the {product-short}.

assemblies/assembly-rhdh-integration-aks.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ This integration requires the deployment of {product-short} on {aks-short} using
1313
* The Helm chart
1414
* The {product} Operator
1515
16-
//include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814
16+
//include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814

assemblies/assembly-running-rhdh-behind-a-proxy.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ You can run the {product-very-short} application behind a corporate proxy by set
66
* `HTTP_PROXY`: Denotes the proxy to use for HTTP requests.
77
* `HTTPS_PROXY`: Denotes the proxy to use for HTTPS requests.
88

9-
Additionally, you can set the `NO_PROXY` environment variable to exclude certain domains from proxying. The variable value is a comma-separated list of hostnames that do not require a proxy to get reached, even if one is specified.
9+
Additionally, set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a comma-separated list of hostnames or IP addresses that can be accessed without the proxy, even if one is specified.
1010

11+
include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1]
1112

1213
include::modules/admin/proc-configuring-proxy-in-helm-deployment.adoc[leveloffset=+1]
1314
include::modules/admin/proc-configuring-proxy-in-operator-deployment.adoc[leveloffset=+1]
File renamed without changes.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[id="understanding-no-proxy"]
2+
= Understanding the `NO_PROXY` exclusion rules
3+
4+
`NO_PROXY` is a comma or space-separated list of hostnames or IP addresses, with optional port numbers. If the input URL matches any of the entries listed in `NO_PROXY`, a direct request fetches that URL, for example, bypassing the proxy settings.
5+
6+
[NOTE]
7+
====
8+
The default value for `NO_PROXY` in {product-very-short} is `localhost,127.0.0.1`. If you want to override it, include at least `localhost` or `localhost:7007` in the list. Otherwise, the {product-very-short} backend might fail.
9+
====
10+
11+
Matching follows the rules below:
12+
13+
* `NO_PROXY=*` will bypass the proxy for all requests.
14+
15+
* Space and commas might separate the entries in the `NO_PROXY` list. For example, `NO_PROXY="localhost,example.com"`, or `NO_PROXY="localhost example.com"`, or `NO_PROXY="localhost, example.com"` would have the same effect.
16+
17+
* If `NO_PROXY` contains no entries, configuring the `HTTP(S)_PROXY` settings makes the backend send all requests through the proxy.
18+
19+
* The backend does not perform a DNS lookup to determine if a request should bypass the proxy or not. For example, if DNS resolves `example.com` to `1.2.3.4`, setting `NO_PROXY=1.2.3.4` has no effect on requests sent to `example.com`. Only requests sent to the IP address `1.2.3.4` bypass the proxy.
20+
21+
* If you add a port after the hostname or IP address, the request must match both the host/IP and port to bypass the proxy. For example, `NO_PROXY=example.com:1234` would bypass the proxy for requests to `http(s)://example.com:1234`, but not for requests on other ports, like `http(s)://example.com`.
22+
23+
* If you do not specify a port after the hostname or IP address, all requests to that host/IP address will bypass the proxy regardless of the port. For example, `NO_PROXY=localhost` would bypass the proxy for requests sent to URLs like `http(s)://localhost:7077` and `http(s)://localhost:8888`.
24+
25+
* IP Address blocks in CIDR notation will not work. So setting `NO_PROXY=10.11.0.0/16` will not have any effect, even if the backend sends a request to an IP address in that block.
26+
27+
* Supports only IPv4 addresses. IPv6 addresses like `::1` will not work.
28+
29+
* Generally, the proxy is only bypassed if the hostname is an exact match for an entry in the `NO_PROXY` list. The only exceptions are entries that start with a dot (`.`) or with a wildcard (`*`). In such a case, bypass the proxy if the hostname ends with the entry.
30+
31+
[NOTE]
32+
====
33+
List the domain and the wildcard domain if you want to exclude a given domain and all its subdomains. For example, you would set `NO_PROXY=example.com,.example.com` to bypass the proxy for requests sent to `http(s)://example.com` and `http(s)://subdomain.example.com`.
34+
====

0 commit comments

Comments
 (0)