[KEYCLOAK-9361] Address the issues pointed out by Matthew during PR review

Thanks, Matthew!

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
This commit is contained in:
Jan Lieskovsky 2019-01-23 20:22:21 +01:00 committed by Hynek Mlnařík
parent 3d338af620
commit f6a4b41aeb
3 changed files with 9 additions and 9 deletions

View file

@ -228,7 +228,7 @@ $ oc new-app --template={project_templates_version}-https \
---- ----
[[advanced-concepts-sso-hostname-spi-setup]] [[advanced-concepts-sso-hostname-spi-setup]]
=== Customizing the Hostname for {project_name} Server === Customizing the Hostname for the {project_name} Server
The hostname SPI introduced a flexible way to configure the hostname for the {project_name} server. There are two built-in providers. The first is `request`, which uses the request headers to determine the hostname. This is the *default setting* for {project_openshift_product_name} image. The second is `fixed`, which allows configuring a fixed hostname. The latter makes sure that only valid hostnames can be used and allows internal applications to invoke {project_name} server through an alternative URL. The hostname SPI introduced a flexible way to configure the hostname for the {project_name} server. There are two built-in providers. The first is `request`, which uses the request headers to determine the hostname. This is the *default setting* for {project_openshift_product_name} image. The second is `fixed`, which allows configuring a fixed hostname. The latter makes sure that only valid hostnames can be used and allows internal applications to invoke {project_name} server through an alternative URL.

View file

@ -72,7 +72,7 @@ $ oc new-project sso-app-demo
$ oc policy add-role-to-user view system:serviceaccount:$(oc project -q):default $ oc policy add-role-to-user view system:serviceaccount:$(oc project -q):default
---- ----
==== Deploying the {project_name} Image using Application Template ==== Deploying the {project_name} Image using the Application Template
===== Deploying the Template via OpenShift CLI ===== Deploying the Template via OpenShift CLI
@ -128,9 +128,9 @@ $ oc new-app --template={project_templates_version}-x509-https
Run 'oc status' to view your app. Run 'oc status' to view your app.
---- ----
===== Deploying the Template via OpenShift Web Console ===== Deploying the Template via the OpenShift Web Console
Alternatively, perform the following steps to deploy the {project_name} template via OpenShift web console: Alternatively, perform the following steps to deploy the {project_name} template via the OpenShift web console:
. Log in to the OpenShift web console and select the _sso-app-demo_ project space. . Log in to the OpenShift web console and select the _sso-app-demo_ project space.
. Click *Add to Project*, then *Browse Catalog* to list the default image streams and templates. . Click *Add to Project*, then *Browse Catalog* to list the default image streams and templates.

View file

@ -877,7 +877,7 @@ Repeat these steps for the `admin` role.
. Enter a valid *Username* (this example uses the user `appuser`) and click *Save*. . Enter a valid *Username* (this example uses the user `appuser`) and click *Save*.
. Edit the user configuration: . Edit the user configuration:
.. Click the *Credentials* tab in the user space and enter a password for the user (this example uses the password `apppassword`). .. Click the *Credentials* tab in the user space and enter a password for the user (this example uses the password `apppassword`).
.. Ensure the *Temporary Password* option is set to *Off* so that it does not prompt for a password change later on, and click *Reset Password* to set the user password. A pop-up window prompts for additional confirmation. .. Ensure the *Temporary Password* option is set to *Off* so that it does not prompt for a password change later on, and click *Reset Password* to set the user password. A pop-up window will prompt you to confirm.
===== Assign `user` {project_name} Role to the Realm Management User ===== Assign `user` {project_name} Role to the Realm Management User
@ -1016,7 +1016,7 @@ app-jee-jsp]$ mvn clean package -DskipTests
+ +
[IMPORTANT] [IMPORTANT]
==== ====
The link:https://github.com/keycloak/keycloak-quickstarts/tree/latest/app-jee-jsp[app-jee-jsp] quickstart requires to configure the adapter, and adapter configuration file (`keycloak.json`) to be present at the `config/` directory in the root of the quickstart to successfully build the quickstart. But since this example configures the adapter later via selected environment variables available for the EAP 6.4 / 7.1 for OpenShift image, it is not necessary to specify the form of `keycloak.json` adapter configuration file at this moment. The link:https://github.com/keycloak/keycloak-quickstarts/tree/latest/app-jee-jsp[app-jee-jsp] quickstart requires you to configure the adapter, and that the adapter configuration file (`keycloak.json`) is present in the `config/` directory in the root of the quickstart to successfully build the quickstart. But since this example configures the adapter later via selected environment variables available for the EAP 6.4 / 7.1 for OpenShift image, it is not necessary to specify the form of `keycloak.json` adapter configuration file at this moment.
==== ====
[[directory-structure-binary-builds]] [[directory-structure-binary-builds]]
@ -1025,7 +1025,7 @@ The link:https://github.com/keycloak/keycloak-quickstarts/tree/latest/app-jee-js
+ +
Application archives in the *deployments/* subdirectory of the main binary build directory are copied directly to the xref:standard-deployments-directory[standard deployments directory] of the image being built on OpenShift. For the application to deploy, the directory hierarchy containing the web application data must be correctly structured. Application archives in the *deployments/* subdirectory of the main binary build directory are copied directly to the xref:standard-deployments-directory[standard deployments directory] of the image being built on OpenShift. For the application to deploy, the directory hierarchy containing the web application data must be correctly structured.
+ +
Create main directory for the binary build on the local file system and *deployments/* subdirectory within it. Copy the previously built WAR archives of both the *service-jee-jaxrs* and *app-jee-jsp* quickstarts to the *deployments/* subdirectory: Create the main directory for the binary build on the local file system and *deployments/* subdirectory within it. Copy the previously built WAR archives of both the *service-jee-jaxrs* and *app-jee-jsp* quickstarts to the *deployments/* subdirectory:
+ +
[source,bash,subs="attributes+,macros+"] [source,bash,subs="attributes+,macros+"]
---- ----
@ -1063,7 +1063,7 @@ sso-eap7-bin-demo/
[[standard-deployments-directory]] [[standard-deployments-directory]]
[NOTE] [NOTE]
==== ====
Location of the standard deployments directory depends on the underlying base image, that was used to deploy the application. See the following table: The location of the standard deployments directory depends on the underlying base image, that was used to deploy the application. See the following table:
.Standard Location of the Deployments Directory .Standard Location of the Deployments Directory
[cols="2", options="header"] [cols="2", options="header"]
@ -1293,7 +1293,7 @@ Perform the following to test the application:
You should see the *Message: public* output. You should see the *Message: public* output.
* Click the *LOGIN* button to be redirected for user authentication to the {project_name} server instance against the `demo` realm. * Click the *LOGIN* button to be redirected for user authentication to the {project_name} server instance against the `demo` realm.
+ +
Specify username and password of the {project_name} user configured earlier (`appuser` / `apppassword`). Click *Log in*. The look of the application changes as detailed in the following image: Specify the username and password of the {project_name} user configured earlier (`appuser` / `apppassword`). Click *Log in*. The look of the application changes as detailed in the following image:
+ +
[.text-center] [.text-center]
image:images/sso_app_jee_jsp_logged_in.png[] image:images/sso_app_jee_jsp_logged_in.png[]