Skip to content

Commit ae3c9a4

Browse files
committed
Merge branch 'main' into RHIDP-7975
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
2 parents c824980 + 5558a59 commit ae3c9a4

File tree

7 files changed

+49
-32
lines changed

7 files changed

+49
-32
lines changed

assemblies/assembly-enabling-authentication-with-mandatory-steps-only.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
:only-default-steps:
2+
:optional-steps: disable
33

44
[id='enabling-authentication-with-mandatory-steps-only']
55
= Enabling authentication in {product} (with mandatory steps only)

assemblies/assembly-enabling-authentication.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
:_mod-docs-content-type: ASSEMBLY
2+
:optional-steps: enable
23

34
[id='enabling-authentication']
45
= Enabling authentication in {product}
56

6-
7-
8-
97
include::modules/authentication/con-understanding-authentication-and-user-provisioning.adoc[leveloffset=+1]
108

119

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Enter your schedule timeout, in the ISO duration or "human duration" format.
113113
Enter your schedule initial delay, in the ISO duration or "human duration" format.
114114
--
115115

116-
. To set up the GitHub authentication provider, add the `auth.providers.github` section to the `{my-app-config-file}` file content:
116+
. To set up the GitHub authentication provider, add the `auth.providers.github` section to your `{my-app-config-file}` file:
117117
+
118118
--
119119
.`{my-app-config-file}` file fragment with mandatory fields to enable authentication with GitHub
@@ -140,11 +140,13 @@ Enter the configured secret variable name: `$\{GITHUB_CLIENT_SECRET}`.
140140

141141
`signInPage`::
142142
Enter `github` to enable the GitHub provider as your {product-short} sign-in provider.
143-
144-
ifndef::only-default-steps[]
145-
Optional: Consider adding the following optional fields:
146-
147-
.`{my-app-config-file}` file fragment including optional fields to enable authentication with GitHub
143+
+
144+
Optional: Consider adding optional fields.
145+
ifeval::[{optional-steps} == 'disable']
146+
See {configuring-book-link}[{configuring-book-title}].
147+
endif::[]
148+
ifeval::[{optional-steps} == 'enable']
149+
+
148150
[source,yaml,subs="+quotes"]
149151
----
150152
auth:

modules/authentication/proc-enabling-user-authentication-with-microsoft-azure.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[]
9797

9898
. To provision {azure-short} users and groups to the {product-short} software catalog, add the `catalog.providers.microsoftGraphOrg` section to your custom {product-short} `{my-app-config-file}` configuration file:
9999
+
100-
--
101100
[id=microsoftGraphOrgProviderId]
102101
.`{my-app-config-file}` fragment with mandatory `microsoftGraphOrg` fields
103102
[source,yaml]
@@ -144,10 +143,12 @@ In a large organization, user provisioning might take a long time, therefore avo
144143

145144
`initialDelay`:::
146145
Enter the schedule initial delay in the ISO duration or human duration format.
147-
148-
ifndef::only-default-steps[]
149-
Optional: Consider adding the following optional `microsoftGraphOrg.providerId` fields:
150-
146+
+
147+
Optional: Consider adding optional fields.
148+
ifeval::[{optional-steps} == 'disable']
149+
See {configuring-book-link}[{configuring-book-title}].
150+
endif::[]
151+
ifeval::[{optional-steps} == 'enable']
151152
[id=authority]
152153
`authority`::
153154
Enter your link:https://learn.microsoft.com/en-us/graph/deployments#app-registration-and-token-service-root-endpoints[{azure-short} authority URL], when different from the default: `\https://login.microsoftonline.com`.
@@ -340,7 +341,6 @@ catalog:
340341
`group.select`::
341342
Enter the link:https://learn.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource type] list to retrieve.
342343
+
343-
.`{my-app-config-file}` fragment with optional `group.select` field
344344
[source,yaml]
345345
----
346346
catalog:
@@ -350,13 +350,10 @@ catalog:
350350
group:
351351
select: ['id', 'displayName', 'description']
352352
----
353-
--
354353
endif::[]
355354

356355
. To set up the {azure-short} authentication provider, add the `auth.providers.microsoft` section to your `{my-app-config-file}` file content:
357356
+
358-
--
359-
.`{my-app-config-file}` file fragment with mandatory fields to enable authentication with {azure-short}
360357
[source,yaml,subs="+quotes,+attributes"]
361358
----
362359
auth:
@@ -385,8 +382,12 @@ Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_TENANT_ID}`.
385382

386383
`signInPage`::
387384
Enter `microsoft` to set the {azure-short} provider as your {product-short} sign-in provider.
388-
389-
Optional: Consider adding following optional fields:
385+
+
386+
Optional: Consider adding optional fields.
387+
ifeval::[{optional-steps} == 'disable']
388+
See {configuring-book-link}[{configuring-book-title}].
389+
endif::[]
390+
ifeval::[{optional-steps} == 'enable']
390391

391392
`domainHint`::
392393
Optional for single-tenant applications.
@@ -486,7 +487,6 @@ This resolver looks up the user by matching their Microsoft email to the user en
486487
Configure the sign-in resolver to bypass the user provisioning requirement in the {product-short} software catalog.
487488
+
488489
WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
489-
--
490490

491491
.Verification
492492
. To verify user and group provisioning, check the console logs for `MicrosoftGraphOrgEntityProvider` events.

modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ plugins:
5151
----
5252

5353
. To provision {rhbk} users and groups to the {product-short} software catalog, add the `catalog.providers.keycloakOrg` section to your custom {product-short} `{my-app-config-file}` configuration file:
54-
55-
.. Add mandatory fields:
5654
+
5755
[id=keycloakOrgProviderId]
5856
.`{my-app-config-file}` fragment with mandatory `keycloakOrg` fields
@@ -83,10 +81,12 @@ Enter the realm name to provision users, such as `master`.
8381

8482
`loginRealm`::
8583
Enter the realm name to authenticate users, such as `master`.
86-
87-
ifndef::only-default-steps[]
88-
.. Optional: Consider adding optional fields:
89-
84+
+
85+
Optional: Consider adding optional fields.
86+
ifeval::[{optional-steps} == 'disable']
87+
See {configuring-book-link}[{configuring-book-title}].
88+
endif::[]
89+
ifeval::[{optional-steps} == 'enable']
9090
`userQuerySize`::
9191
Enter the user count to query simultaneously.
9292
Default value: `100`.
@@ -196,9 +196,12 @@ To allow the identity provider to automatically determine whether to prompt for
196196
====
197197
If `prompt: auto` is not set, the identity provider defaults to `prompt: none`, which assumes that you are already logged in and rejects sign-in requests without an active session.
198198
====
199-
200-
.. Optional: Consider adding optional fields:
201-
199+
+
200+
Optional: Consider adding optional fields.
201+
ifeval::[{optional-steps} == 'disable']
202+
See {configuring-book-link}[{configuring-book-title}].
203+
endif::[]
204+
ifeval::[{optional-steps} == 'enable']
202205
`callbackUrl`::
203206
{rhbk} callback URL.
204207
+
@@ -349,6 +352,7 @@ For security, consider that if multiple valid refresh tokens are issued due to f
349352
. From the *Realm Settings* page, click the *Tokens* tab.
350353
. From the *Refresh tokens* section of the *Tokens* tab, toggle the *Revoke Refresh Token* to the *Enabled* position.
351354
====
355+
endif::[]
352356

353357
.Verification
354358

modules/orchestrator/proc-enable-orchestrator-plugin.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,19 @@ data:
4646
icon: orchestratorIcon
4747
text: Orchestrator
4848
path: /orchestrator
49+
entityTabs:
50+
- path: /workflows
51+
title: Workflows
52+
mountPoint: entity.page.workflows
53+
mountPoints:
54+
- mountPoint: entity.page.workflows/cards
55+
importName: OrchestratorCatalogTab
56+
config:
57+
layout:
58+
gridColumn: '1 / -1'
59+
if:
60+
anyOf:
61+
- IsOrchestratorCatalogTabAvailable
4962
- package: "@redhat/[email protected]"
5063
disabled: false
5164
pluginConfig:

titles/setting-up-and-configuring-your-first-red-hat-developer-hub-instance/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ include::artifacts/attributes.adoc[]
33
:subtitle: Prepare your IT infrastructure including {ocp-brand-name} and required external components, and run your first {product} ({product-very-short}) instance in production.
44
:abstract: Prepare your IT infrastructure including {ocp-brand-name} and required external components, and run your first {product} ({product-very-short}) instance in production.
55
:context: setting-up-and-configuring-your-first-rhdh-instance
6-
:only-default-steps:
6+
:optional-steps: disable
77
[id="{context}"]
88
= {title}
99

0 commit comments

Comments
 (0)