Uploaded image for project: 'Keycloak'
  1. Keycloak
  2. KEYCLOAK-11864

[RH-SSO] [Docs] Provide step-by-step scenario / tutorial how to deploy custom Keycloak theme from zip archive

    Details

    • Sprint:
      Keycloak Sprint 4
    • Story Points:
      5
    • Affects:
      Documentation (Ref Guide, User Guide, etc.), Interactive Demo/Tutorial, User Experience
    • Docs QE Status:
      NEW
    • Bugzilla Update:
      Perform
    • QE Status:
      NEW

      Description

      It is often desired to customize RH-SSO for OpenShift image with custom theme. We should provide a full step-by-step tutorial / scenario in the existing documentation to illustrate how this can be achieved.

      See upstream documentation for further details.

      First approximation to the possible tutorial (complete / exact steps will be provided once the scenario has been tested):
      1, Deploy RH-SSO for OpenShift image as usually.
      2, Having the custom theme (with expected content) available as archive.zip perform the following:

      • Once RH-SSO pod is running copy the archive.zip to the pod. Identify the actual pod name and copy the archive.zip to its tmp/ directory
        $ oc get pods 
        $ mkdir -p ./tocopy
        $ mv archive.zip ./tocopy/
        $ oc rsync ./tocopy pod-id:/tmp
        

        Note: Substitute pod-id in the command above with the actual ID of the pod.

      • Connect to the JBoss CLI interface of that pod and deploy the theme:
        $ oc rsh pod-id
        $ cd /opt/eap/bin
        $ ./jboss-cli.sh
        $ connect
        $ module add --name=org.example.mytheme --resources=archive.zip
        

        Note: Replace pod-id in the above command with the actual ID of the pod.

      • Edit the standalone-openshift.xml file to register the theme module with RH-SSO:
        $ oc rsh pod-id
        $ export REGISTER_MODULE="<modules><module>org.example.mytheme</module></modules>"
        $ sed -i "/<theme>/a $REGISTER_MODULE" /opt/eap/standalone/conf/standalone-openshift.xml
        

        Note: Replace pod-id in the above command with the actual ID of the pod.

      • Restart the RH-SSO server within OCP pod:
        $ oc rsh pod-id
        $ cd /opt/eap/bin
        $ ./jboss-cli.sh --connect ':reload'
        

        Note: Replace pod-id in the above command with the actual ID of the pod.

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  iankko Ján Lieskovský
                  Involved:
                  Marek Schmidt, Pavel Drobek
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  6 Start watching this issue

                  Dates

                  • Created:
                    Updated: