Skip to content

Commit dbb71af

Browse files
authored
Merge branch 'release-1.4' into plugins-table-update-1.4.2
2 parents a91e68a + 27674df commit dbb71af

File tree

38 files changed

+160
-270
lines changed

38 files changed

+160
-270
lines changed

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[id="rhdh-keycloak_{context}"]
2-
= Installing and configuring Keycloak
2+
= Installing and configuring Keycloak
33

44
The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:
55

@@ -8,7 +8,7 @@ The Keycloak backend plugin, which integrates Keycloak into {product-short}, has
88

99
[NOTE]
1010
====
11-
The supported Keycloak version is `{keycloak-version}`.
11+
The supported {rhbk-brand-name} ({rhbk}) version is `{keycloak-version}`.
1212
====
1313

1414
== Installation

assemblies/assembly-release-notes-fixed-security-issues.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ This section lists security issues fixed in {product} {product-version}.
88

99
include::./modules/release-notes/snip-fixed-security-issues-in-product-1.4.1.adoc[leveloffset=+2]
1010

11-
// nothing yet so don't include this
11+
// nothing yet so don't include this
1212
// include::./modules/release-notes/snip-fixed-security-issues-in-rpm-1.4.1.adoc[leveloffset=+2]
1313

1414
== {product} 1.4.0
1515

16-
include::./modules/release-notes/snip-fixed-security-issues-in-product-1.3.0.adoc[leveloffset=+2]
16+
include::./modules/release-notes/snip-fixed-security-issues-in-product-1.4.0.adoc[leveloffset=+2]
1717

18-
include::./modules/release-notes/snip-fixed-security-issues-in-rpm-1.3.0.adoc[leveloffset=+2]
18+
// nothing yet so don't include this
19+
//include::./modules/release-notes/snip-fixed-security-issues-in-rpm-1.4.0.adoc[leveloffset=+2]

modules/about/ref-supported-platforms.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,3 @@
88

99
You can find the supported platforms and life cycle dates for both current and past versions of {product} on the link:https://access.redhat.com/support/policy/updates/developerhub[Life Cycle page].
1010

11-
[role="_additional-resources"]
12-
.Additional resources
13-
14-
* link:https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-837/rel-notes-rhdh/#compatibility-matrix[{product} {product-version} Compatibility Matrix].

modules/authentication/proc-enabling-authentication-with-github.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
5555
+
5656
`AUTH_GITHUB_APP_ID`:: Enter the saved **App ID**.
5757
`AUTH_GITHUB_CLIENT_ID`:: Enter the saved **Client ID**.
58-
`GITHUB_HOST_DOMAIN`:: Enter your GitHub host domain: `github.com` unless you are using GitHub Enterprise.
58+
//`GITHUB_HOST_DOMAIN`:: Enter your GitHub host domain: `github.com` unless you are using GitHub Enterprise.
5959
`GITHUB_ORGANIZATION`:: Enter your GitHub organization name, such as `__<your_github_organization_name>__'.
6060
`GITHUB_ORG_URL`:: Enter `$GITHUB_HOST_DOMAIN/$GITHUB_ORGANIZATION`.
6161
`GITHUB_CLIENT_SECRET`:: Enter the saved **Client Secret**.
@@ -145,6 +145,7 @@ auth:
145145
callbackUrl: __<your_intermediate_service_url/handler>__
146146
----
147147

148+
////
148149
`enterpriseInstanceUrl`::
149150
Your GitHub Enterprise URL.
150151
Requires you defined the `GITHUB_HOST_DOMAIN` secret in the previous step.
@@ -158,6 +159,7 @@ auth:
158159
production:
159160
enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN}
160161
----
162+
////
161163

162164
[TIP]
163165
====

modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ $ oc create configmap rbac-policies \
7575
--from-file=rbac-conditional-policies.yaml
7676
----
7777

78-
. Update your {product-short} `Backstage` custom resource to mount in the {product-short} filesystem your files from the `rbac-policies` config map:
78+
. Update link:{configuring-book-url}[your `{product-custom-resource-type}` custom resource] to mount in the {product-short} filesystem your files from the `rbac-policies` config map:
7979
+
80-
.`Backstage` Custom resource fragment
80+
.`{product-custom-resource-type}` custom resource fragment
8181
[source,yaml]
8282
----
8383
apiVersion: rhdh.redhat.com/v1alpha3

modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ For Operator-based deployment, the approach you use for proxy configuration is b
5959
----
6060

6161

62-
* As a developer, set the proxy information in your custom resource (CR) file as shown in the following example:
62+
* As a developer, set the proxy information in your `{product-custom-resource-type}` CR file as shown in the following example:
6363
+
6464
.Example: Setting proxy variables in a CR file
6565
[source, yaml]

modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
[id="configuring-the-deployment"]
2-
= Configuring {product} deployment when using the operator
2+
= Configuring {product} deployment when using the Operator
33

4-
The {product} operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its Custom Resource Definition (CRD). This CRD exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object.
4+
The {product} Operator exposes a `rhdh.redhat.com/v1alpha3` API Version of its custom resource (CR). This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object.
55

66
.Procedure
77

8-
. Create a {product-short} Custom Resource Definition with the following fields:
8+
. Create a `{product-custom-resource-type}` CR with the following fields:
99

1010
--
1111
.Example
1212
[source, yaml]
1313
----
14-
apiVersion: rhdh.redhat.com/v1alpha2
14+
apiVersion: rhdh.redhat.com/v1alpha3
1515
kind: Backstage
1616
metadata:
1717
name: developer-hub
@@ -28,7 +28,7 @@ Add labels to the {product-short} pod.
2828
.Example adding the label `my=true`
2929
[source, yaml]
3030
----
31-
apiVersion: rhdh.redhat.com/v1alpha2
31+
apiVersion: rhdh.redhat.com/v1alpha3
3232
kind: Backstage
3333
metadata:
3434
name: developer-hub
@@ -50,7 +50,7 @@ Add an additional volume named `my-volume` and mount it under `/my/path` in the
5050
.Example additional volume
5151
[source, yaml]
5252
----
53-
apiVersion: rhdh.redhat.com/v1alpha2
53+
apiVersion: rhdh.redhat.com/v1alpha3
5454
kind: Backstage
5555
metadata:
5656
name: developer-hub
@@ -78,7 +78,7 @@ Replace the default `dynamic-plugins-root` volume with a persistent volume claim
7878
.Example `dynamic-plugins-root` volume replacement
7979
[source, yaml]
8080
----
81-
apiVersion: rhdh.redhat.com/v1alpha2
81+
apiVersion: rhdh.redhat.com/v1alpha3
8282
kind: Backstage
8383
metadata:
8484
name: developer-hub
@@ -103,7 +103,7 @@ Set the CPU request for the {product-short} application container to 250m.
103103
.Example CPU request
104104
[source, yaml]
105105
----
106-
apiVersion: rhdh.redhat.com/v1alpha2
106+
apiVersion: rhdh.redhat.com/v1alpha3
107107
kind: Backstage
108108
metadata:
109109
name: developer-hub
@@ -127,7 +127,7 @@ Add a new `my-sidecar` sidecar container into the {product-short} Pod.
127127
.Example side car container
128128
[source, yaml]
129129
----
130-
apiVersion: rhdh.redhat.com/v1alpha2
130+
apiVersion: rhdh.redhat.com/v1alpha3
131131
kind: Backstage
132132
metadata:
133133
name: developer-hub

modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ EOF
7474
<3> Optional: Provide the value based on the required link:https://www.postgresql.org/docs/15/libpq-connect.html#LIBPQ-CONNECT-SSLMODE[Secure Sockets Layer (SSL) mode].
7575
<4> Optional: Provide the value only if you need a TLS connection for your PostgreSQL instance.
7676

77-
. Create a `{product-custom-resource-type}` custom resource (CR):
77+
. Create your `{product-custom-resource-type}` custom resource (CR):
7878
+
7979
[source,terminal,subs="+attributes,+quotes"]
8080
----

modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ done
7878
You can stop port forwarding when the copying of the data is complete. For more information about handling large databases and using the compression tools, see the link:https://www.postgresql.org/docs/current/backup-dump.html#BACKUP-DUMP-LARGE[Handling Large Databases] section on the PostgreSQL website.
7979
====
8080

81-
. Reconfigure your `Backstage` custom resource (CR). For more information, see link:{configuring-book-url}#proc-configuring-postgresql-instance-using-operator_configuring-external-postgresql-databases[Configuring an external PostgreSQL instance using the Operator].
81+
. Reconfigure your `{product-custom-resource-type}` custom resource (CR). For more information, see link:{configuring-book-url}#proc-configuring-postgresql-instance-using-operator_configuring-external-postgresql-databases[Configuring an external PostgreSQL instance using the Operator].
8282
. Check that the following code is present at the end of your `Backstage` CR after reconfiguration:
8383
+
8484
[source,yaml]

modules/configuring/proc-provisioning-your-custom-configuration.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,28 @@ It contains one secret per line in `KEY=value` form.
2121
. Author your custom `{my-app-config-file}` file.
2222
This is the main {product-short} configuration file.
2323
+
24-
You can start with an empty file to use the default configuration.
24+
The `baseUrl` field is mandatory in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. You must specify the `baseUrl` in both the `app` and `backend` sections to avoid errors during initialization.
25+
+
26+
.Configuring the `baseUrl` in `{my-app-config-file}`
27+
====
28+
[source,yaml,subs="+attributes,+quotes"]
29+
----
30+
app:
31+
title: {product}
32+
baseUrl: {my-product-url}
33+
34+
backend:
35+
auth:
36+
externalAccess:
37+
- type: legacy
38+
options:
39+
subject: legacy-default-config
40+
secret: "${BACKEND_SECRET}"
41+
baseUrl: {my-product-url}
42+
cors:
43+
origin: {my-product-url}
44+
----
45+
====
2546
+
2647
Optionally, enter your configuration such as:
2748

0 commit comments

Comments
 (0)