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

Docs - Overlay deployment - Incorrect steps to install on top of Wildfly

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: 3.0.0.Final
    • Fix Version/s: 3.1.0.CR1
    • Component/s: Documentation
    • Labels:
      None
    • Environment:

      Wildfly 10.0.0 (clean install; no other applications deployed)
      Ubuntu 16.04 (using Upstart instead of systemd)
      Linux 4.4.0-31-generic #50-Ubuntu SMP Wed Jul 13 00:07:12 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux

    • Steps to Reproduce:
      Hide
      1. Setup a clean Bento Box Ubuntu 16.04 VM using Vagrant.
      2. Use the script in this gist to install Wildfly 10.0.0 as a system service.
      3. Stop wildfly using sudo service wildfly stop.
      4. Download the 3.0.0 Final overlay TGZ archive found on the downloads page.
      5. Copy the overlay archive into /opt/wildfly.
      6. Switch to the wildfly user and extract the overlay with tar -xvzf keycloak-overlay-3.0.0.Final.tar.gz.
      7. Switch back to the vagrant account and start wildfly using sudo service wildfly start.
      8. Check logs in /var/log/wildfly/console.log to ensure server started successfully.
      9. Attempt to access Keycloak at http://SERVER_IP/.

      Expected Results

      The Keycloak welcome page would appear, like it does in the standalone distribution.

      Actual Results

      • Nothing in the logs indicates Keycloak has been loaded.
      • The Wildfly welcome page appears.
      Show
      Setup a clean Bento Box Ubuntu 16.04 VM using Vagrant. Use the script in this gist to install Wildfly 10.0.0 as a system service. Stop wildfly using sudo service wildfly stop . Download the 3.0.0 Final overlay TGZ archive found on the downloads page . Copy the overlay archive into /opt/wildfly . Switch to the wildfly user and extract the overlay with tar -xvzf keycloak-overlay-3.0.0.Final.tar.gz . Switch back to the vagrant account and start wildfly using sudo service wildfly start . Check logs in /var/log/wildfly/console.log to ensure server started successfully. Attempt to access Keycloak at http://SERVER_IP/ . Expected Results The Keycloak welcome page would appear, like it does in the standalone distribution. Actual Results Nothing in the logs indicates Keycloak has been loaded. The Wildfly welcome page appears.
    • Docs QE Status:
      NEW
    • QE Status:
      ASSIGNED

      Description

      According to the documentation, all that should be required to install the Keycloak overlay is to unzip it on top of the Wildfly application server. This does not seem to be correct.

      After unzipping the overlay on top of the application server, and restarting it, nothing seems to be deployed / running on Wildfly. I have confirmed that all of the files from the 3.0.0 overlay archive were successfully extracted on top of the server and are not in a sub-folder or otherwise missing.

      Based on an older Keycloak blog entry written for Keycloak 1.6.0, there used to be another required step of ensuring that the server starts with the standalone-keycloak.xml config, but that file is not included with the overlay. Something must be missing that is required for Wildfly to load Keycloak from the overlay.

      I recognize that the standalone package that includes Wildfly is the preferred deployment method, but that doesn't change the fact that the instructions for using the overlay are incorrect and incomplete.

        Gliffy Diagrams

          Attachments

            Activity

              People

              • Assignee:
                stianst Stian Thorgersen
                Reporter:
                guypaddock Guy Elsmore-Paddock
                Tester:
                Pavel Drozd
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: