Skip to content

Commit

Permalink
Merge pull request #503 from svghadi/extend-sso-support
Browse files Browse the repository at this point in the history
docs: Update doc to reflect extended support for sso deprecated fields
  • Loading branch information
iam-veeramalla committed May 19, 2023
2 parents c870b55 + 671ab32 commit 224d9be
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions docs/OpenShift GitOps Usage Guide.md
Expand Up @@ -148,7 +148,9 @@ The scope of this section is to describe the steps to Install, Configure(**Setup

**Prerequisite:**

:warning: DISABLE_DEX is Deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.9.0. Dex can be enabled/disabled using `.spec.sso.provider`.
:warning: DISABLE_DEX is Deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.10.0. Dex can be enabled/disabled using `.spec.sso.provider`.

**Note: `DISABLE_DEX` environment variable was earlier scheduled for removal in OpenShift GitOps v1.9.0, but has been extended to v1.10.0.**

* Make sure you disable dex

Expand Down Expand Up @@ -369,7 +371,9 @@ Below `oc` command can be used to patch the default Argo CD Instance in the open

Or you can manually remove the **.spec.sso** field from the Argo CD Instance.

:warning: **`.spec.sso.image`, `.spec.sso.version`, `.spec.sso.resources` and `.spec.sso.verifyTLS` are Deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.9.0. Keycloak can be configured using `.spec.sso.keycloak`**.
:warning: **`.spec.sso.image`, `.spec.sso.version`, `.spec.sso.resources` and `.spec.sso.verifyTLS` are Deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.10.0. Keycloak can be configured using `.spec.sso.keycloak`**.

**Note: `.spec.sso.image`, `.spec.sso.version`, `.spec.sso.resources` and `.spec.sso.verifyTLS` fields were earlier scheduled for removal in OpenShift GitOps v1.9.0, but have been extended to v1.10.0.**

### **Skip the Keycloak Login page and display the OpenShift Login page.**

Expand Down Expand Up @@ -450,7 +454,7 @@ Updating the following environment variables in the existing Subscription Object
<tr>
<td>DISABLE_DEX</td>
<td>false</td>
<td> When set to `true`, will remove the Dex deployment from the openshift-gitops namespace. Note: Disabling Dex will not be supported in v.1.9.0+.
<td> When set to `true`, will remove the Dex deployment from the openshift-gitops namespace. Note: Disabling Dex will not be supported in v.1.10.0+.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -612,9 +616,11 @@ data:

**NOTE:** As of v1.3.0, Dex is automatically configured. You can log into the default Argo CD instance in the openshift-gitops namespace using the OpenShift or kubeadmin credentials. As an admin you can disable the Dex installation after the Operator is installed which will remove the Dex deployment from the openshift-gitops namespace.

:warning: **DISABLE_DEX is Deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.9.0. Dex can be enabled/disabled by setting `.spec.sso.provider: dex` as follows:**
:warning: **DISABLE_DEX is Deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.10.0. Dex can be enabled/disabled by setting `.spec.sso.provider: dex` as follows:**

:warning: **`.spec.dex` is deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.9.0. Dex can be configured through `.spec.sso.dex` as follows** :
:warning: **`.spec.dex` is deprecated in OpenShift GitOps v1.6.0 and support will be removed in v1.10.0. Dex can be configured through `.spec.sso.dex` as follows** :

**Note: `DISABLE_DEX` environment variable and `.spec.sso.image`, `.spec.sso.version`, `.spec.sso.resources` and `.spec.sso.verifyTLS` fields were earlier scheduled for removal in OpenShift GitOps v1.9.0, but have been extended to v1.10.0.**

```
spec:
Expand Down Expand Up @@ -667,15 +673,18 @@ spec:
value: "true"
```
:warning:
**`DISABLE_DEX` is deprecated and support will be removed in Argo CD operator v0.6.0. Please use `.spec.sso.provider` to enable/disable Dex.**
**`DISABLE_DEX` is deprecated and support will be removed in Argo CD operator v0.8.0. Please use `.spec.sso.provider` to enable/disable Dex.**

**Note: `DISABLE_DEX` environment variable was earlier scheduled for removal in Argo CD operator v0.7.0, but has been extended to v0.8.0.**

#### Using `.spec.dex`

Dex can be uninstalled by either removing `.spec.dex` from the Argo CD CR, or ensuring `.spec.dex.config` is empty and `.spec.dex.openShiftOAuth` is set to `false`.

:warning:
**`.spec.dex` is deprecated and support will be removed in Argo CD operator v0.6.0. Please use `.spec.sso.dex` to configure Dex.**
**`.spec.dex` is deprecated and support will be removed in Argo CD operator v0.8.0. Please use `.spec.sso.dex` to configure Dex.**

**Note: `.spec.dex` field was earlier scheduled for removal in Argo CD operator v0.7.0, but has been extended to Argo CD operator v0.8.0.**

You can enable RBAC on Argo CD by following the instructions provided in the Argo CD [RBAC Configuration](https://argoproj.github.io/argo-cd/operator-manual/rbac/). Example RBAC configuration looks like this.

Expand Down

0 comments on commit 224d9be

Please sign in to comment.