Skip to content

Commit 8e7fdb9

Browse files
authored
Merge pull request #47381 from DebarghoGhosh/spec-sso-api-4112
RHDEVDOCS-4112 - Updated spec.sso operator documentation
2 parents 0b25def + f0f23ca commit 8e7fdb9

File tree

3 files changed

+40
-4
lines changed

3 files changed

+40
-4
lines changed

cicd/gitops/configuring-sso-on-argo-cd-using-dex.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ include::modules/gitops-dex-role-mappings.adoc[leveloffset=+2]
1616

1717
include::modules/gitops-disable-dex.adoc[leveloffset=+1]
1818

19+
include::modules/gitops-disable-dex-using-spec-sso.adoc[leveloffset=+1]
20+
1921
////
2022
[role="_additional-resources"]
2123
.Additional resources
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module is included in the following assemblies:
2+
//
3+
// * configuring-sso-for-argo-cd-using-dex
4+
5+
:_content-type: PROCEDURE
6+
[id="gitops-disable-dex-using-spec-sso_{context}"]
7+
= Enabling or disabling Dex using .spec.sso
8+
9+
You can configure {gitops-title} to use Dex as its SSO authentication provider by setting the `.spec.sso` parameter.
10+
11+
.Procedure
12+
13+
. To enable Dex, set the `.spec.sso.provider: dex` parameter in the YAML resource of the Operator:
14+
15+
+
16+
[source,yaml]
17+
----
18+
...
19+
spec:
20+
sso:
21+
provider: dex
22+
dex:
23+
openShiftOAuth: true
24+
...
25+
----
26+
+
27+
. To disable dex, either remove the `spec.sso` element from the Argo CD custom resource, or specify a different SSO provider.

modules/gitops-disable-dex.adoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
// Module is included in the following assemblies:
22
//
3-
// * configuring-sso-for-argo-cd-on-openshift
3+
// * configuring-sso-for-argo-cd-using-dex
44

55
:_content-type: PROCEDURE
66
[id="gitops-disable-dex_{context}"]
77
= Disabling Dex
88

9-
Dex is installed by default for all the Argo CD instances created by the Operator. You can disable Dex.
9+
Dex is installed by default for all the Argo CD instances created by the Operator. You can configure {gitops-title} to use Dex as the SSO authentication provider by setting the `.spec.dex` parameter.
10+
11+
[IMPORTANT]
12+
====
13+
In {gitops-title} v1.6.0, `DISABLE_DEX` is deprecated and is planned to be removed in {gitops-title} v1.9.0. Consider using the `.spec.sso.dex` parameter instead. See "Enabling or disabling Dex using .spec.sso".
14+
====
1015

1116
.Procedure
1217

13-
* Set the environmental variable `DISABLE_DEX` to true in the *YAML* resource of the Operator:
18+
* Set the environmental variable `DISABLE_DEX` to `true` in the YAML resource of the Operator:
1419
+
1520
[source,yaml]
1621
----
17-
spec:
22+
...
23+
spec:
1824
config:
1925
env:
2026
- name: DISABLE_DEX
2127
value: "true"
28+
...
2229
----

0 commit comments

Comments
 (0)