{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Two installers are built to support Windows users:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The IdP installer is a thin shim on top of the standard installer","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It unpacks the distribution into ","type":"text"},{"text":"ProgramData","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It collects some configuration information and captures it to properties files","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It runs the standard installer using ","type":"text"},{"text":"Property Driven Installation","type":"text","marks":[{"type":"link","attrs":{"href":"https://shibboleth.atlassian.net/wiki/spaces/IDP5/pages/3199500577/Installation#Property-Driven-Installation"}}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Jetty installer deploys three subsystems","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A specific version of Jetty","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Procrun (a windows executable which allows Java programs to be run as a “Service” (Windows-speak for a daemon)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A version of jetty-base for Windows targeted at the IdP installation","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Both of these can be build using WiX4 which in turn is invoked as part of a standard maven run (on a suitable configured Windows machine). These pages describe how to build a release of these installers","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"dfec6e24-735b-40f6-ab7b-643d2460f393"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"b1b9c421-c237-4e5d-8b1d-7006a9f9e0a5"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Prerequisites (one-off)","type":"text"}]},{"type":"paragraph","content":[{"text":"The Windows machine you will use to do the build Installation box must have the following installed","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Java JDK version 17 or later","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure that ","type":"text"},{"text":"JAVA_HOME","type":"text","marks":[{"type":"code"}]},{"text":" is set correctly","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Maven","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Git","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A recent version of the ","type":"text"},{"text":".NET SDK","type":"text","marks":[{"type":"link","attrs":{"href":"https://dotnet.microsoft.com/en-us/download"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An appropriate ","type":"text"},{"text":"settings.xml","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Building a Release of the IdP installer","type":"text"}]},{"type":"paragraph","content":[{"text":"The install requires the idp-distribution zip file for the release and so the build can be done any time after it is available in Nexus.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Checkout the Release tag","type":"text"}]},{"type":"codeBlock","content":[{"text":"git checkout \"tag\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Check the msi Version","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"msi.version","type":"text","marks":[{"type":"code"}]},{"text":" property is the version that the msi file will carry. It is separate from the ","type":"text"},{"text":"project.version","type":"text","marks":[{"type":"code"}]},{"text":" because ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It must be strictly numeric.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It has a final digit (to allow multiple installer releases for the same IdP release). We usually use ‘99’ to mean “SNAPSHOT”.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"At the time of release the version should match the project version with an appropriate 4th digit. If you need to edit it you will need to push a tag for the changed file.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Build the msi file","type":"text"}]},{"type":"paragraph","content":[{"text":"This is done using maven, on an appropriate windows machine. You need to run the idp-msi and the idp-bom projects ","type":"text"},{"text":"only.","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"mvn clean install -rf :idp-msi","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Make sure that the bom project runs - this will run the “m2 enforcer”.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sign and deploy the msi file","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the maven sign-and-deploy plugin. The following is an ","type":"text"},{"text":"untested","type":"text","marks":[{"type":"em"}]},{"text":" example","type":"text"}]},{"type":"codeBlock","content":[{"text":"ssh -L 1581:127.0.0.1:1581 -N build.shibboleth.net -f\nREM or use Putty\nset VERSION=5.1.2\nset NEXUS_URL=http://127.0.0.1:1581/nexus/content/repositories/releases\nset REPO_ID=release\nSET CL1=mvn -Dmaven.repo.local=%MAVEN_REPO% gpg:sign-and-deploy-file -Durl=%NEXUS_URL% -DrepositoryId=%REPO_ID%\nSET CL2=-Dfile=shibboleth-identity-provider-%VERSION%-x64.msi -DgroupId=net.shibboleth.idp -DartifactId=idp-msi\nSET CL3=-Dversion=%VERSION% -DgeneratePom=false -Dclassifier=msi\nSet SIGN_AND_DEPLOY=%CL1% %CL2% %CL3%\n%SIGN_AND_DEPLOY%\n\n","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"If you are deploying a version with a non zero version (e.g. 5.1.2.1) you will need to rename the msi file by hand.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Building a Release of the Jetty Installer","type":"text"}]},{"type":"paragraph","content":[{"text":"There are two parts to releasing the Jetty installer:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Updating the jetty-base tree to reflect any changes in jetty","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Building and publishing the msi file","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Updating Jetty Base","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The following is for Jetty 12.x","type":"text"}]}]},{"type":"paragraph","content":[{"text":"For Jetty 12, we track the project version of jetty-base. The branch we build from is currently named ","type":"text"},{"text":"12-windows","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Preparation","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clone and checkout the correct branch:","type":"text"}]},{"type":"codeBlock","content":[{"text":"git clone -b 12-windows git@git.shibboleth.net:java-idp-jetty-base\ncd java-idp-jetty-base","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Merge (not rebase) forward to the latest changes on the ","type":"text"},{"text":"12","type":"text","marks":[{"type":"code"}]},{"text":"branch","type":"text"}]},{"type":"codeBlock","content":[{"text":"git merge 12","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update the pom to reflect the jettty and procrun versions","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"12.0.8.0-SNAPSHOT\n\n\n 12.0.8\n 1.3.4\n...","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Review the ","type":"text"},{"text":"12","type":"text","marks":[{"type":"code"}]},{"text":" version of ","type":"text"},{"text":"src\\main\\resourcs\\jetty-base\\start.d\\idp.ini","type":"text","marks":[{"type":"code"}]},{"text":" and make any required changes to ","type":"text"},{"text":"src\\main\\resourcs\\jetty-base\\start.d.dist\\idp-system.ini","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set revision to zero (f needed)","type":"text"}]},{"type":"codeBlock","content":[{"text":"0","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"test build and smoke test","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Commit the changes.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Building the Jetty Installer","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Set up tag point (and tag if possible)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"em"}]},{"text":" to remove SNAPSHOT from versions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Tag (this may be deferred if running on a GPG deficient build machine)","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"SET JETTY_TAG=12.0.8.0-WINDOWS\ngit add -A\ngit commit -m \"Update files to be tagged for release\"\ngit tag -s -m \"Tag %JETTY_TAG%\" %JETTY_TAG%","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"em"}]},{"text":" to change the the version, adding -SNAPSHOT Make sure that there is alignment between the version and the version properties","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"12.0.8.3-SNAPSHOT\n12.0.8\n0","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Commit","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"git add -A\ngit commit -m \"Bump version after release\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Build the release version","type":"text"}]},{"type":"codeBlock","content":[{"text":"git checkout %JETTY_TAG% (or HEAD~1)\nmvn -Dmaven.repo.local=%MAVEN_REPO% clean install","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Test the released version","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Commit the Work","type":"text"}]},{"type":"paragraph","content":[{"text":"(this assumed that the build was done on a GPG-deficient machine)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Push the work done above (on the build machine)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Move msi to GPG machine","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Checkout to the build point and tag","type":"text"}]},{"type":"codeBlock","content":[{"text":"git pull 12-windows\ngit checkout 12-windows~1\n# CHECK at correct point\ngit tag -s -m \"Tag %JETTY_TAG%\" %JETTY_TAG%","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clean git reposuitory and move the test msi file into target","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Push to nexus using the ","type":"text"},{"text":"gpg:sign-and-deploy-file","type":"text","marks":[{"type":"code"}]},{"text":" plugin:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"ssh -L 1581:127.0.0.1:1581 -N build.shibboleth.net -f\nREM or use Putty\nset JETTY_VERSION=12.0.8\nset JETTY_REVISION=0\nset VERSION=%JETTY_VERSION%.%JETTY_REVISION%\n\nset NEXUS_URL=http://127.0.0.1:1581/nexus/content/repositories/releases\nset REPO_ID=release\n\nSET CL1=mvn -Dmaven.repo.local=%MAVEN_REPO% gpg:sign-and-deploy-file -Durl=%NEXUS_URL% -DrepositoryId=%REPO_ID%\nSET CL2=-Dfile=target/shibboleth-jetty-base-x64-%VERSION%.msi -DgroupId=net.shibboleth.idp -DartifactId=idp-jetty-base-windows\nSET CL3=-Dversion=%VERSION% -DgeneratePom=false -Dclassifier=msi\n\nSet SIGN_AND_DEPLOY=%CL1% %CL2% %CL3%\n\n%SIGN_AND_DEPLOY%","type":"text"}]},{"type":"paragraph","content":[{"text":"Push changes to git:","type":"text"}]},{"type":"codeBlock","content":[{"text":"git checkout 12-windows\ngit push origin 12-windows\ngit push origin %JETTY_TAG% ","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"There are two batch files ","type":"text"},{"text":"src\\main\\bin\\setrepos.bat","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"src\\main\\bin\\setvariables.bat","type":"text","marks":[{"type":"code"}]},{"text":" which set things up.","type":"text"}]}]},{"type":"paragraph"}],"version":1}

Browser not supported