doc: Update docs to reflect sso unification changes (#930)

* Update docs to reflect sso unification changes Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com> * Add a note about removed sso fields Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com> --------- Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
argoproj-labs · Jun 27, 2023 · 2970865 · 2970865
1 parent 671b3d3
commit 2970865
Show file tree

Hide file tree

Showing 5 changed files with 152 additions and 337 deletions.
diff --git a/docs/reference/api.html.md b/docs/reference/api.html.md
@@ -85,19 +85,6 @@ Resource Types:
                      <p>Controller defines the Application Controller options for ArgoCD.</p>
                   </td>
                </tr>
-               <tr>
-                  <td>
-                     <code>dex</code></br>
-                     <em>
-                     <a href="#argoproj.io/v1alpha1.ArgoCDDexSpec">
-                     ArgoCDDexSpec
-                     </a>
-                     </em>
-                  </td>
-                  <td>
-                     <p>Dex defines the Dex server options for ArgoCD.</p>
-                  </td>
-               </tr>
                <tr>
                   <td>
                      <code>gaTrackingID</code></br>
@@ -1982,19 +1969,6 @@ Resource Types:
             <p>Controller defines the Application Controller options for ArgoCD.</p>
          </td>
       </tr>
-      <tr>
-         <td>
-            <code>dex</code></br>
-            <em>
-            <a href="#argoproj.io/v1alpha1.ArgoCDDexSpec">
-            ArgoCDDexSpec
-            </a>
-            </em>
-         </td>
-         <td>
-            <p>Dex defines the Dex server options for ArgoCD.</p>
-         </td>
-      </tr>
       <tr>
          <td>
             <code>gaTrackingID</code></br>
@@ -2310,51 +2284,6 @@ Resource Types:
       </tr>
    </thead>
    <tbody>
-      <tr>
-        <td>
-            <code>image</code></br>
-            <em>
-            string
-            </em>
-        </td>
-        <td>
-            <p>Image is the Keycloak container image.</p>
-        </td>
-        </tr>
-        <tr>
-        <td>
-            <code>resources</code></br>
-            <em>
-            <a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#resourcerequirements-v1-core">
-            Kubernetes core/v1.ResourceRequirements
-            </em>
-        </td>
-        <td>
-            <p> Resources defines the Compute Resources required by the container for Keycloak.</p>
-        </td>
-        </tr>
-        <tr>
-        <td>
-            <code>version</code></br>
-            <em>
-            string
-            </em>
-        </td>
-        <td>
-            <p>Version is the Keycloak container image tag.</p>
-        </td>
-        </tr>
-        <tr>
-        <td>
-            <code>verifyTLS</code></br>
-            <em>
-            bool
-            </em>
-        </td>
-        <td>
-            <p>VerifyTLS set to false disables strict TLS validation.</p>
-        </td>
-        </tr>
       <tr>
          <td>
             <code>dex</code></br>
@@ -2364,7 +2293,7 @@ Resource Types:
             </em>
          </td>
          <td>
-            <p>Dex contains the configuration for Argo CD dex authentication</p>
+            <p>Dex contains the configuration for Argo CD dex authentication (previously found under cr.spec.dex)</p>
          </td>
       </tr>
       <tr>
@@ -2425,23 +2354,6 @@ Resource Types:
             </p>
          </td>
       </tr>
-      <tr>
-         <td>
-            <code>dex</code></br>
-            <em>
-            string
-            </em>
-         </td>
-         <td>
-            <p>Dex is a simple, high-level summary of where the Argo CD Dex component is in its lifecycle.
-               There are five possible dex values:
-               Pending: The Argo CD Dex component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
-               Running: All of the required Pods for the Argo CD Dex component are in a Ready state.
-               Failed: At least one of the  Argo CD Dex component Pods had a failure.
-               Unknown: For some reason the state of the Argo CD Dex component could not be obtained.
-            </p>
-         </td>
-      </tr>
       <tr>
          <td>
             <code>notifications</code></br>
@@ -2529,17 +2441,18 @@ Resource Types:
       </tr>
       <tr>
          <td>
-            <code>ssoConfig</code></br>
+            <code>sso</code></br>
             <em>
             string
             </em>
          </td>
          <td>
-            <p>ssoConfig is a simple, high-level summary of the status of SSO configuration for the Argo CD instance.
-               There are three possible server values:
-               Success: Only one SSO provider is configured in CR
-               Failed: SSO configuration is illegal or more than one SSO providers are configured in CR.
-               Unknown: For some reason the SSO configuration could not be obtained.
+            <p>SSO is a simple, high-level summary of where the Argo CD SSO(Dex/Keycloak) component is in its lifecycle.
+               There are four possible server values:
+               Pending: The Argo CD SSO component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
+               Running: All of the required Pods for the Argo CD SSO component are in a Ready state.
+               Failed: At least one of the  Argo CD SSO component Pods had a failure.
+               Unknown: The state of the Argo CD SSO component could not be obtained.
             </p>
          </td>
       </tr>