Commit graph

30 commits

Author SHA1 Message Date
Matthew Helmke
cb1b73930f KEYCLOAK-9319 fixes in developer guide 2019-02-21 09:09:54 +01:00
Matthew Helmke
875f70e23e changes and reverted changes as requested 2019-02-20 11:30:04 +01:00
Matthew Helmke
6cb1d1d86b KEYCLOAK-9372 update EAP version 2019-02-20 11:30:04 +01:00
Stian Thorgersen
6a75edb903 Update introduction.adoc 2019-01-10 15:47:35 +01:00
Jan Lieskovsky
4a09aea087 [General] Drop the duplicate 'Creating Administrator Account for {project_name} Server'
paragraph from the 'Get Started' section

Keep the copy present in 'Advanced Concept's section, because it is more
updated & already present part of the book dedicated to advanced topics
(see 7.2 guide for reference)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
f743f4633c [General] Drop the duplicate occurrence of the '{project_name} Clients'
section and 'Limitations' section from the 'Get Started' book section

Keep them in the 'Advanced Concepts' section, since this is the one
where these two belongs (see 7.2 guide for reference)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
f94bf82cb6 [General] Drop the duplicate occurrence of the 'Deployment Process' paragraph
Keep it in the 'Advanced Concepts' section, since that's the one, where it belongs
(see 7.2 guide for reference)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
1ab6fd1c4e [General] Recommend 7.2 or {project_version} as the proper RH-SSO
image versions to be used for new apps

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
dd445d5c2a [KEYCLOAK-8234] Address multiple issues:
* Whitelist .../templates/${resource} link for both RH-SSO 7.3 TP CD & RH-SSO 7.3 products,
* Replace '[subs="verbatim,macros,attributes"]' with '[source,bash,subs="attributes+,macros+"]'

  The 'macros+' field is needed in order also constructs like 'pass:quotes[_user-name_]' got
  expanded correctly,

* Replace deprecated 'oc env' command with its new "oc set env" equivalent,
* Replace deprecated 'oadm' command with its new "oc adm" equivalent,
* Escape selected https:// links, so they wouldn't end up rendered as <link xlink=...>

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
fa081f55fb [KEYCLOAK-8234] Drop the 'project_previous_version' and 'project_previous_templates_version' Asciidoc attributes
Refactor the automatic & manual database migration sections not to be tied that much to a
specific, previous RH-SSO image version in order to these two attributes not to be needed

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
dce27ff5f1 [KEYCLOAK-8234] Drop the 'project_name_abbr' attribute
by substituting it with 'project_name' one, where previously referenced

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
fe14ea90cc [KEYCLOAK-8234] Replace various fixed versioned strings
with their parametrized version

Also drop mention about EAP 7.0 images / templates, since
these are deprecated (see CLOUD-2699 / CLOUD-2678 for details)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
389a22cc79 [KEYCLOAK-8234] Point the application templates installation step
to the new templates location

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
2ba16ddc78 [KEYCLOAK-8234] Parametrize mention of application templates
in the documentation, so various versions can be used

Also, use "[subs="verbatim,macros,attributes"]" as the default
for code sections in the documentation. Escape '<', '>', '+'
special characters, where necessary for proper rendering of
final documentation

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-01-10 15:47:35 +01:00
Jan Lieskovsky
e00695bbf7 [KEYCLOAK-8129] Describe the newly introduced SSO_HOSTNAME environment variable
Also add additional steps to 'Advanced Concepts' section, on how
to configure `fixed` hostname SPI provider

Also address the issue pointed out during the review by Matthew.
Thanks, Matthew!

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-12-18 06:24:26 -06:00
Matthew Helmke
929562fcb4 Added header to index.adoc as in master.adoc 2018-10-04 14:43:46 +02:00
Jan Lieskovsky
98bb9773bb [KEYCLOAK-8165] 'Using the RH-SSO for OpenShift Image Streams and Application Templates'
documentation section updates:

* Add details on how to pull images from Red Hat Terms Based Registry (registry.redhat.io),
* Update list of RH-SSO templates to the latest one, templates tag to the latest 'v.1.4.16'
  one, and RH-SSO 7.2 images tag to the latest '1.2' one

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-09-26 12:24:41 +02:00
Matthew Helmke
dcbee72e99 KEYCLOAK-8161 remove unused adoc files 2018-09-10 09:04:47 -05:00
Matthew Helmke
1a05779398 KEYCLOAK-8159 return missing section 2018-09-10 09:04:01 -05:00
Matthew Helmke
e3dc0f6210 RHSSO-1495 fix error in example 2018-08-14 10:54:01 +02:00
stianst
cab1353398 KEYCLOAK-7946 Fix missing variable in OpenShift guide 2018-07-30 10:37:35 +02:00
Stian Thorgersen
94bd75aa3e
KEYCLOAK-7527 Release notes in documentation and additions for CD (#397) 2018-06-07 15:18:50 +02:00
Stian Thorgersen
f61cfad51e
KEYCLOAK-6567 configure moved openshift content to our build process (#396) 2018-06-07 14:12:56 +02:00
Ján Lieskovský
fa7ca9c680 [CLOUD-2437] Mention JGroups ASYM_ENCRYPT cluster traffic (#382)
encryption protocol, which is the default setting for the
templates using re-encrypt TLS termination

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-05-29 10:03:28 +02:00
Kohei Tamura
911336913b Fix typos and improve readability (#381) 2018-05-29 10:02:18 +02:00
Ján Lieskovský
2b8143cb8d Fix issue with improper rendering of xreferences (#371)
Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-04-23 21:10:37 +02:00
Ján Lieskovský
3892ca58eb [KEYCLOAK-6650] [KEYCLOAK-6648] Make documentation changes for these JIRAs (#368)
* [KEYCLOAK-6650] Substitute:
* 'redhat-sso72-openshift:1.0' with 'redhat-sso72-openshift:1.1',
* 'ose-v1.4.9' tag with (upcoming) 'ose-v1.4.11' tag

Also update the command to install the updated templates

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6650] Mention the newly introduced RH-SSO 7.2 x509
application templates on appropriate places

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6650] Move "Binary Builds" tutorial out of
Getting Started section to Tutorials section

Also rename it to:
"Example Workflow: Create OpenShift Application that Authenticates
Using Red Hat Single Sing-On from Existing Maven Binaries"

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6650] Rename 'Get Started' section to 'Advanced Concepts'
(we will introduce a new, refactored 'Getting Started' section soon)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6650] Bring the refactored 'Getting Started' section
back to the docs

Make it contain the most simplistic example, how to deploy RH-SSO
server

Refactor the 'Advanced Concepts' section to guide:
* How to generate keystores, truststore, and secrets for passthroug
  TLS RH-SSO application templates,
* Also provide example, how the passthrough TLS template can be
  deployed once keystores and secrets are created

Remove the necessary sections from former 'tutorials' content,
that have been used:
* Either in the new 'Getting Started' section, or
* In the new 'Advanced Concepts' section

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6650] Address issues pointed out by Matthew during PR
review. Thanks for them, Matthew!

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6648] Align the definition of HTTPS, JGroups keystores,
and the truststore for the RH-SSO server in the application templates
with their definition in the documentation

Also provide example how to obtain certificate names from keystores

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>

* [KEYCLOAK-6650] Clarify in the Introduction section, that
for the x509 re-encrypt templates the JGroups keystore isn't
generated, and AUTH protocol is used for cluster traffic
authentication

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-04-23 20:03:11 +02:00
Ján Lieskovský
a37b3f58b0 [KEYCLOAK-6857] Deprecate RH-SSO 7.1 image and corresponding (#358)
application templates in the documentation

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-04-12 14:59:52 +02:00
Stian Thorgersen
ea5bec0841
KEYCLOAK-6566 Fix docinfo for OpenShift (#344) 2018-03-19 20:25:24 +01:00
Stian Thorgersen
23d48bb12c
KEYCLOAK-6566 Initial commit of xPaaS documentation (#343) 2018-03-19 20:04:57 +01:00