Skip to content

Commit 0b11dc7

Browse files
authored
Merge branch 'main' into end-user-new-content-rhidp-8377
2 parents db64c30 + 01a0412 commit 0b11dc7

File tree

6 files changed

+83
-23
lines changed

6 files changed

+83
-23
lines changed

artifacts/rhdh-plugins-reference/aap-backend/aap-backend-plugin-readme.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ The AAP backend plugin is pre-loaded in {product-short} with basic configuration
2828

2929
[source,yaml]
3030
----
31-
global:
32-
dynamic:
33-
includes:
31+
global:
32+
dynamic:
33+
includes:
3434
- dynamic-plugins.default.yaml
35-
plugins:
35+
plugins:
3636
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic
3737
disabled: false
3838
----
@@ -60,9 +60,9 @@ To enable the AAP plugin, you must set the following environment variables:
6060
owner: <owner>
6161
system: <system>
6262
schedule: # optional; same options as in TaskScheduleDefinition
63-
# supports cron, ISO duration, "human duration" as used in code
63+
# supports cron, ISO 8601 duration strings, and duration objects
6464
frequency: { minutes: 1 }
65-
# supports ISO duration, "human duration" as used in code
65+
# supports ISO 8601 duration strings and duration objects
6666
timeout: { minutes: 1 }
6767
----
6868
--

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ You can configure a schedule in the `app-config.yaml` file, as follows:
5353
# ...
5454
# highlight-add-start
5555
schedule: # optional; same options as in TaskScheduleDefinition
56-
# supports cron, ISO duration, "human duration" as used in code
56+
# supports cron, ISO 8601 duration strings, and duration objects
5757
frequency: { minutes: 1 }
58-
# supports ISO duration, "human duration" as used in code
58+
# supports ISO 8601 duration strings and duration objects
5959
timeout: { minutes: 1 }
6060
initialDelay: { seconds: 15 }
6161
# highlight-add-end

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

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

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

@@ -12,11 +12,11 @@ The Keycloak plugin is pre-loaded in {product-short} with basic configuration pr
1212

1313
[source,yaml]
1414
----
15-
global:
16-
dynamic:
17-
includes:
15+
global:
16+
dynamic:
17+
includes:
1818
- dynamic-plugins.default.yaml
19-
plugins:
19+
plugins:
2020
- package: ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic
2121
disabled: false
2222
----
@@ -48,9 +48,9 @@ You can configure a schedule in the `app-config.yaml` file, as follows:
4848
# ...
4949
# highlight-add-start
5050
schedule: # optional; same options as in TaskScheduleDefinition
51-
# supports cron, ISO duration, "human duration" as used in code
51+
# supports cron, ISO 8601 duration strings, and duration objects
5252
frequency: { minutes: 1 }
53-
# supports ISO duration, "human duration" as used in code
53+
# supports ISO 8601 duration strings and duration objects
5454
timeout: { minutes: 1 }
5555
initialDelay: { seconds: 15 }
5656
# highlight-add-end

artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM
2525
----
2626
# update your .npmrc or .yarnrc file
2727
yarn config set "@redhat:registry" https://npm.registry.redhat.com
28-
# then pull a package
28+
# then pull a package
2929
yarn add @redhat/backstage-plugin-quay
3030
----
3131

32-
For more information, see link:https://docs.npmjs.com/cli/v9/configuring-npm/npmrc[npm docs].
32+
For more information, see link:https://docs.npmjs.com/cli/v9/configuring-npm/npmrc[npm docs].
3333

34-
Creating a `.npmrc` file ensures that all the packages are scoped under `@redhat` and are fetched from link:https://npm.registry.redhat.com/[Red Hat's NPM registry], while the rest dependencies remain sourced from other link:registry.npmjs.org[registry].
34+
Creating a `.npmrc` file ensures that all the packages are scoped under `@redhat` and are fetched from link:https://npm.registry.redhat.com/[Red Hat's NPM registry], while the rest dependencies remain sourced from other link:registry.npmjs.org[registry].
3535

36-
Using this configuration, you can proceed with the installation of the individual packages.
36+
Using this configuration, you can proceed with the installation of the individual packages.
3737

3838
The OCM plugin is composed of two packages, including:
3939

@@ -204,9 +204,9 @@ For more information about the configuration, see https://backstage.io/docs/feat
204204
# ...
205205
# highlight-add-start
206206
schedule: # optional; same options as in TaskScheduleDefinition
207-
# supports cron, ISO duration, "human duration" as used in code
207+
# supports cron, ISO 8601 duration strings, and duration objects
208208
frequency: { minutes: 1 }
209-
# supports ISO duration, "human duration" as used in code
209+
# supports ISO 8601 duration strings and duration objects
210210
timeout: { minutes: 1 }
211211
# highlight-add-end
212212
+
@@ -295,7 +295,7 @@ yarn workspace app add @redhat/backstage-plugin-ocm
295295
--
296296

297297
. Select the components that you want to use, such as:
298-
298+
299299
** `OcmPage`: This is a standalone page or dashboard displaying all clusters as tiles. You can add `OcmPage` to `packages/app/src/App.tsx` file as follows:
300300
+
301301
--

assemblies/assembly-rhdh-default-configuration.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,6 @@ include::modules/configuring-external-databases/con-mounts-for-default-secret-pv
1919

2020
include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+2]
2121

22-
include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+2]
22+
include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+2]
23+
24+
include::modules/configuring/ref-time-syntax.adoc[leveloffset=1]
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
:_mod-docs-content-type: REFERENCE
2+
3+
[id="ref-time-syntax_{context}"]
4+
= Time syntax in {product}
5+
6+
Learn about time duration formats supported by {product}.
7+
8+
.Generally supported time formats
9+
[cols="1, 1, 1, 1"]
10+
|===
11+
|*Format*
12+
|*Description*
13+
|*Example*
14+
|*Compound values*
15+
16+
|*Human-readable strings*
17+
|Simple strings compatible with the `ms` library.
18+
|`30m`
19+
|No
20+
21+
|*Duration objects*
22+
|A structured object specifying time units. Matches the `HumanDuration` TypeScript interface.
23+
a|[source,yaml]
24+
----
25+
timeout:
26+
minutes: 30
27+
----
28+
|Yes
29+
30+
|*ISO 8601 duration strings*
31+
|Standard ISO 8601 duration strings.
32+
|`PT30M`
33+
|Yes
34+
|===
35+
36+
37+
.Context-dependent time formats
38+
[cols="1, 1, 1"]
39+
|===
40+
|*Format*
41+
|*Description*
42+
|*Example*
43+
44+
|*Cron*
45+
|An object containing a `cron` key with a crontab-style string. Used primarily by Scheduler services for tasks such as `frequency`).
46+
a|[source,yaml]
47+
----
48+
frequency:
49+
cron: '*/30 * * * *'
50+
----
51+
|===
52+
53+
[WARNING]
54+
====
55+
{product-very-short} configuration reader `readDurationFromConfig` explicitly **disallows** plain numbers to prevent ambiguity.
56+
57+
However, specific raw configuration fields, such as direct Node.js HTTP server settings, might strictly require numbers. Always check the specific documentation for the field you are configuring.
58+
====

0 commit comments

Comments
 (0)