From: "Bill Burke" <bburke(a)redhat.com&gt; To: keycloak-dev(a)lists.jboss.org Sent: Tuesday, 7 January, 2014 8:12:15 PM Subject: [keycloak-dev] examples/distro reworked/improved/finalized PLEASE TRY! Please build and try on the examples and distro please! I'll be writing up the documentation so please get me some feedback. * new distribution/ directory containing multiple poms * examples now use a jboss modules import of adapter through jboss-deployment-structure.xml * removed server/ project from examples/ * tested on wildfly8cr1, eap61, as711 To build the distro $ cd keycloak/distribution $ mvn clean install this pom is not in the main build as it takes up a ton of space and downloads the wildfly distro. There will be two distribution zips. They are located in the build here: distribution/war-dist/target/keycloak-war-dist.zip distribution/appliance-dist/target/keycloak-appliance-dist.zip Directions on how to install keycloak and run the examples are here: https://github.com/keycloak/keycloak/tree/master/examples/wildfly-demo https://github.com/keycloak/keycloak/tree/master/examples/as7-eap-demo Please try it out for both and tell me what you think of the distro/examples, etc... The WAR Dist: This is for when you want to install the keycloak server on an existing Wildfly, EAP, or AS7 distro. deployments/auth-server.war deployments/auth-server.war.dodeploy deployments/keycloak-ds.xml examples/ adapters/keycloak-as7-adapter-dist-1.0-alpha-1-SNAPSHOT.zip adapters/keycloak-eap6-adapter-dist-1.0-alpha-1-SNAPSHOT.zip adapters/keycloak-wildfly-adapter-dist-1.0-alpha-1-SNAPSHOT.zip All you do is do a cp -r deployments/ to the standalone/ directory of your jboss/wildfly install and then just start up the server. The adapters/* are for installing an adapter on a non-keycloak server instances. You just unzip them in the jboss top level director. The Appliance Zip: This contains a full bootable appliance. Right now, SSL is not set up by default. I'm still not sure if it is worth it to set up a "localhost" self-signed cert or not. keycloak/ examples/ adapters/keycloak-as7-adapter-dist-1.0-alpha-1-SNAPSHOT.zip adapters/keycloak-eap6-adapter-dist-1.0-alpha-1-SNAPSHOT.zip adapters/keycloak-wildfly-adapter-dist-1.0-alpha-1-SNAPSHOT.zip The keycloak/ directory is a wildfly distro that contains the keycloak server war and ds.xml file for the datasource, as well as the wildfly adapter jboss module all unzipped. -- Bill Burke JBoss, a division of Red Hat http://bill.burkecentral.com _______________________________________________ keycloak-dev mailing list keycloak-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/keycloak-dev

From: "Bill Burke" <bburke(a)redhat.com&gt; To: "Stian Thorgersen" <stian(a)redhat.com&gt; Cc: keycloak-dev(a)lists.jboss.org Sent: Thursday, 9 January, 2014 4:23:50 PM Subject: Re: [keycloak-dev] examples/distro reworked/improved/finalized PLEASE TRY! On 1/9/2014 10:18 AM, Stian Thorgersen wrote: > I haven't had much time to play with this yet, but will do today/tomorrow. > Although if you're not accepting PRs after today, there may not be any > point? There's two outstanding PRs related to examples are you going to > merge those? > > Some comments on the distributions: > > Instead of having these download bundles I think it would be better to have > downloads for each individual thing: > > keycloak-bundle-<version>.zip > > - keycloak-<version> > - bin > - deployments/auth-server.war (exploded) > - .. > > keycloak-war.zip > > - auth-server.war (exploded) > - auth-server.war.dodeploy > - keycloak-ds.xml > > keycloak-wildfly-adapter.zip > keycloak-eap-adapter.zip > keycloak-as7-adapter.zip > Poms are set up to do this so not a problem. > Reason for this is that it allows devs to download what they want rather > than a huge bundle. For example: > > * To install the server all you want is the server > * If running Keycloak on OpenShift all you need is the one adapter for > whatever application server you're using > > We could move examples into a separate github project and the documentation > would instruct people to get it from there. That way we can add/edit > examples after a release. This is the way JDF does it, and I would think > that eventually Keycloak examples would be moved into there. > Not everybody knows how to use Github :) Plus, you need examples tied to release versions as there may be differences between them. > It may also be good to have these zips available in Maven central as that > makes it simpler for other projects to build their own distributions that > includes Keycloak. I can imagine AeroGear guys may be interested in that. > Simple enough. -- Bill Burke JBoss, a division of Red Hat http://bill.burkecentral.com

Yes, but make it harder for users. its jbs.xml and also web.xml On 1/9/2014 12:21 PM, Stian Thorgersen wrote: > Is the only difference between the 3 examples the name of the adapter in jboss-deployment-structure? > > If so could we not do either: > > * Maven profiles to template these files with the adapter module name > * Use same module name for the adapters? > > That would make it a lot easier to make sure the examples are in-sync. > > ----- Original Message ----- >> From: "Bill Burke" <bburke(a)redhat.com&gt; >> To: "Stian Thorgersen" <stian(a)redhat.com&gt; >> Cc: keycloak-dev(a)lists.jboss.org >> Sent: Thursday, 9 January, 2014 4:23:50 PM >> Subject: Re: [keycloak-dev] examples/distro reworked/improved/finalized PLEASE TRY! >> >> >> >> On 1/9/2014 10:18 AM, Stian Thorgersen wrote: >>> I haven't had much time to play with this yet, but will do today/tomorrow. >>> Although if you're not accepting PRs after today, there may not be any >>> point? There's two outstanding PRs related to examples are you going to >>> merge those? >>> >>> Some comments on the distributions: >>> >>> Instead of having these download bundles I think it would be better to have >>> downloads for each individual thing: >>> >>> keycloak-bundle-<version>.zip >>> >>> - keycloak-<version> >>> - bin >>> - deployments/auth-server.war (exploded) >>> - .. >>> >>> keycloak-war.zip >>> >>> - auth-server.war (exploded) >>> - auth-server.war.dodeploy >>> - keycloak-ds.xml >>> >>> keycloak-wildfly-adapter.zip >>> keycloak-eap-adapter.zip >>> keycloak-as7-adapter.zip >>> >> Poms are set up to do this so not a problem. >> >>> Reason for this is that it allows devs to download what they want rather >>> than a huge bundle. For example: >>> >>> * To install the server all you want is the server >>> * If running Keycloak on OpenShift all you need is the one adapter for >>> whatever application server you're using >>> >>> We could move examples into a separate github project and the documentation >>> would instruct people to get it from there. That way we can add/edit >>> examples after a release. This is the way JDF does it, and I would think >>> that eventually Keycloak examples would be moved into there. >>> >> Not everybody knows how to use Github :) Plus, you need examples tied >> to release versions as there may be differences between them. >> >>> It may also be good to have these zips available in Maven central as that >>> makes it simpler for other projects to build their own distributions that >>> includes Keycloak. I can imagine AeroGear guys may be interested in that. >>> >> Simple enough. >> >> >> -- >> Bill Burke >> JBoss, a division of Red Hat >> http://bill.burkecentral.com >>

On 1/10/2014 5:51 AM, Marek Posolda wrote: > Just a small note that there is a typo in > https://github.com/keycloak/keycloak/blob/master/examples/as7-eap-demo/RE... > > in step1. For EAP 6.x it should be "keycloak-eap6-adapter-dist.zip" when > currently it talks about "keycloak-as7-adapter-dist.zip" . > Good catch. > Another possible good thing would be to have "quickstart" appliance for > everything bundled in single ZIP (wildfly server with auth-server, > datasource, adapters, test-realm installed and all examples deployed). > This will enable possibility for users to start really quickly playing > with Keycloak without need to import realm in admin-console and > build/deploy examples with maven. Of course, this may not be possible if > examples will be moved to separate repo. > That's a *REALLY* good idea. I'll do that. BTW, not sure about your addition to CDI yet to one of the examples. We will be trimming down the Wildfly distro in the near future and CDI will be one of the subsystems that will be removed.

Bill

On 1/10/2014 10:27 AM, Marek Posolda wrote: > On 10.1.2014 15:23, Bill Burke wrote: >> >> >> On 1/10/2014 5:51 AM, Marek Posolda wrote: >>> Just a small note that there is a typo in >>> https://github.com/keycloak/keycloak/blob/master/examples/as7-eap-demo/RE... >>> >>> >>> in step1. For EAP 6.x it should be "keycloak-eap6-adapter-dist.zip" >>> when >>> currently it talks about "keycloak-as7-adapter-dist.zip" . >>> >> >> Good catch. >> >>> Another possible good thing would be to have "quickstart" appliance >>> for >>> everything bundled in single ZIP (wildfly server with auth-server, >>> datasource, adapters, test-realm installed and all examples deployed). >>> This will enable possibility for users to start really quickly playing >>> with Keycloak without need to import realm in admin-console and >>> build/deploy examples with maven. Of course, this may not be >>> possible if >>> examples will be moved to separate repo. >>> >> >> That's a *REALLY* good idea. I'll do that. >> >> BTW, not sure about your addition to CDI yet to one of the examples. >> We will be trimming down the Wildfly distro in the near future and CDI >> will be one of the subsystems that will be removed. > oops, I did it this way as you asked for it:-) You mentioned CDI or > Spring in another thread. > I didn't think it all the way through, its my fault. We can re-use the file configuration stuff though you did.

> So not sure what to do? I am seeing options like: > - Left the original "third-party" example and convert my stuff into > something like "third-party-cdi" example. This example won't be part of > WildFly appliance distribution, but IMO it can be just in WAR > distribution as this is used for people, who want to add examples into > their own AS7/Wildfly and so we can assume that it will be full > AS7/Wildfly with support of CDI and JSF. That works. > - Example won't be part of keycloak codebase, but it will be in separate > repo. This assumes that we will have separate repo with > examples/quickstarts as suggested by Stian in another mail. > Not sure about a separate repo for examples. Examples tend to change and evolve as you do more releases so you'll want to bind them to a particular release of keycloak. Also requires an extra step from the user to go to github and get them. I also liked your idea of having the demo pre-configured into the appliance so you can just run the demo out of the box.

> So only thing to change in original "third-party" example will be the > addition of JSON configuration, instead of hard-coded stuff in the code. > But there will be still ServletOAuthClient kept as attribute of > ServletContext. WDYT? > Or you could just rebuild ServletOAuthClient with every request and get rid of the Listener etc.

Bill

Is the only difference between the 3 examples the name of the adapter in jboss-deployment-structure? If so could we not do either: * Maven profiles to template these files with the adapter module name * Use same module name for the adapters? That would make it a lot easier to make sure the examples are in-sync. ----- Original Message ----- > From: "Bill Burke" <bburke(a)redhat.com&gt; > To: "Stian Thorgersen" <stian(a)redhat.com&gt; > Cc: keycloak-dev(a)lists.jboss.org > Sent: Thursday, 9 January, 2014 4:23:50 PM > Subject: Re: [keycloak-dev] examples/distro reworked/improved/finalized PLEASE TRY! > > > > On 1/9/2014 10:18 AM, Stian Thorgersen wrote: >> I haven't had much time to play with this yet, but will do today/tomorrow. >> Although if you're not accepting PRs after today, there may not be any >> point? There's two outstanding PRs related to examples are you going to >> merge those? >> >> Some comments on the distributions: >> >> Instead of having these download bundles I think it would be better to have >> downloads for each individual thing: >> >> keycloak-bundle-<version>.zip >> >> - keycloak-<version> >> - bin >> - deployments/auth-server.war (exploded) >> - .. >> >> keycloak-war.zip >> >> - auth-server.war (exploded) >> - auth-server.war.dodeploy >> - keycloak-ds.xml >> >> keycloak-wildfly-adapter.zip >> keycloak-eap-adapter.zip >> keycloak-as7-adapter.zip >> > > Poms are set up to do this so not a problem. > >> Reason for this is that it allows devs to download what they want rather >> than a huge bundle. For example: >> >> * To install the server all you want is the server >> * If running Keycloak on OpenShift all you need is the one adapter for >> whatever application server you're using >> >> We could move examples into a separate github project and the documentation >> would instruct people to get it from there. That way we can add/edit >> examples after a release. This is the way JDF does it, and I would think >> that eventually Keycloak examples would be moved into there. >> > > Not everybody knows how to use Github :) Plus, you need examples tied > to release versions as there may be differences between them. > >> It may also be good to have these zips available in Maven central as that >> makes it simpler for other projects to build their own distributions that >> includes Keycloak. I can imagine AeroGear guys may be interested in that. >> > > Simple enough. > > > -- > Bill Burke > JBoss, a division of Red Hat > http://bill.burkecentral.com >