Commit graph

63 commits

Author SHA1 Message Date
Jan Lieskovsky
bebdb9cc55 [KEYCLOAK-14681] Use correct up2date image stream names in the documentation
section(s) providing guidance on how to perform automatic and manual database
migration (so the described procedure works again)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2021-06-07 12:30:20 +02:00
Jan Lieskovsky
9a2c4c95d5 [KEYCLOAK-14489] Use correct up2date image stream names in the
documentation section providing guidance on how to import OpenShift
images

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2021-06-07 12:30:20 +02:00
Jan Lieskovsky
88a8c657af [KEYCLOAK-13207] Derive the value of the JBOSS_IMAGE_NAME information
environment variable from the image stream name instead of using a
hardcoded value

Derive the value of the JBOSS_IMAGE_VERSION information environment
variable from the "project_versionDoc" attribute instead of using
a hardcoded value, since the current "project_versionDoc" value matches
the "7.4" value currently present in the images

Drop the "JBOSS_IMAGE_RELEASE" and "STI_BUILDER" information environment
variables, since they aren't present in the latest version(s) of the
OpenJDK / OpenJ9 images any more

Add raw GitHub locations of the OpenJDK and OpenJ9 RH-SSO 7.4 templates
to be ignored by the tests (currently there are just RH-SSO 7.3 and
RH-SSO CD versions of these)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2021-06-07 12:30:20 +02:00
Andy Munro
e18ea48b26 KEYCLOAK-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +01:00
Andy Munro
e913cccdc2 KEYCLOAK-14157 Correcting template name and table problem. 2021-02-17 09:16:14 +01:00
Lorent Lempereur
02dbb7d3b2 KEYCLOAK-FIX Reinstating missing content. 2020-08-05 18:05:48 -03:00
Andy Munro
d02903fe30 KEYCLOAK-13280 Removing sentence that adds confusion.
KEYCLOAK-13280 addressing input from Jan
2020-07-31 10:24:18 +02:00
Andy Munro
c0a644ecf2 KEYCLOAK-13562 -- Adding back missing line: [[env_vars]] 2020-07-02 09:04:09 -03:00
Andy Munro
6cefe59a4b KEYCLOAK-13563 correcting variable 2020-04-06 16:24:24 +02:00
Jan Lieskovsky
abcd7c7237 [KEYCLOAK-13591] [openshift] Refresh (up2date) various currently invalid (HTTP 404) links
Some of OpenShift's guide links got invalidated (HTTP 404 Not Found) after the redesign
of the official OCP documentation from v3.x to v4.x. Point them back to proper locations

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2020-04-06 16:18:28 +02:00
Hynek Mlnarik
0f6f263187 KEYCLOAK-12862 Support for "default" hostname provider 2020-03-31 15:31:29 +02:00
Andy Munro
834afdaf64 KEYCLOAK-13556 correcting syntax for OC command 2020-03-31 15:19:10 +02:00
Andy Munro
b495ac8697 KEYCLOAK-13560 Correct formatting 2020-03-31 08:54:45 +02:00
Hynek Mlnarik
0835d23d16 KEYCLOAK-13364 Remove Mysql templates, add instructions for including custom JDBC driver 2020-03-27 11:48:41 +01:00
Hynek Mlnarik
c756744bd5 KEYCLOAK-13197 Add OpenJ9 variant of OpenShift guide 2020-03-17 15:52:42 +01:00
Andy Munro
c775efdf28 KEYCLOAK-12991 Identifying 3.11 as the OpenShift version 2020-03-16 15:53:45 +01:00
Andy Munro
8ba21c0ac2 Fixing URL. 2020-03-05 17:57:05 +01:00
Martin Kanis
63ac594e45 KEYCLOAK-11803 Vault support for RH-SSO openshift image 2020-02-06 15:52:28 +01:00
stianst
78c71b782c KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
Hynek Mlnarik
9194cbe2c4 KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
Andy Munro
ed42dceb7d KEYCLOAK-7010 Configure JAVA_OPTS onOpenShift
Adding a note to clarify the appearance of sso-mysql is just one example
2019-11-20 19:06:58 +01:00
Sebastian Laskawiec
cc7a125606 Fixed an outdated link 2019-07-12 09:58:23 -03:00
Hynek Mlnarik
ab68cdb79a KEYCLOAK-10321 Missing "the" 2019-06-05 11:47:12 +02:00
Sebastian Laskawiec
e6992e9e27 KEYCLOAK-10184 Connecting to an external database 2019-05-20 11:59:38 +02:00
stianst
46afdfd33a Fix OpenShift guide 2019-05-16 10:12:37 +02:00
Hynek Mlnarik
4a8b30d6c6 KEYCLOAK-10122 Update documentation for RHSSO CD 6 2019-05-10 08:54:49 +02:00
k-tamura
d59910b4d9 KEYCLOAK-8692 - Make it possible to build on Windows 2019-05-08 09:03:13 +02:00
Jan Lieskovsky
f6a4b41aeb [KEYCLOAK-9361] Address the issues pointed out by Matthew during PR review
Thanks, Matthew!

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-05-03 12:50:32 +02:00
Jan Lieskovsky
3d338af620 [KEYCLOAK-9361] Move 'Binary Builds' example from Get Started
section to Tutorials

Right before 'Example Workflow: Automatically Registering EAP
Application in Red Hat Single Sign-On with OpenID-Connect Client'
tutorial

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-05-03 12:50:32 +02:00
Jan Lieskovsky
6b7c6f6222 [KEYCLOAK-9361] Consolidate the Tutorials DB migration section
Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-05-03 12:50:32 +02:00
Jan Lieskovsky
d764ed3fa1 [KEYCLOAK-9361] Drop multiple (commented out) subsections from the
Get Started section

* 'Configuring Keystores' one (covered as 'Creating HTTPS and JGroups Keystores, ...'
  in Advanced Concepts section),
* 'Generating Secrets' one (covered as 'Secrets' subsection in Advanced Concepts),
* 'Creating the Service Account' one. Not needed at all (OCP 3.10 and 3.11 doesn't
   need it anymore),
* 'Using the OpenShift Web Console' one (covered as 'Deploying the Chosen {project_name}
   Passthrough TLS Template...' in Advanced Concepts sections, together with providing
   real expected values for these variables),
* 'Routes' one (since RH-SSO 7.3 doesn't use Passthrough TLS by default any more. The
   various supported TLS (reencrypt, passthrough) are described in
  '1.1. What Is Red Hat Single Sign-On?' section)

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-05-03 12:50:32 +02:00
Jan Lieskovsky
0661424bd3 [KEYCLOAK-9361] Multiple changes:
* Move 'Example Deploying SSO' back from Tutorials to Get Started section to:
  * Align with the form this section has in RH-SSO 7.2 image doc,
  * Bring the getting_started.adoc changes from this commit:
    f61cfad51e (diff-74a6baa8904aeee687e9db2c263b9b47)
    back to the get_started.adoc file, which is now used instead
    of the getting_started.adoc one

* Drop duplicate 'Accessing the Administrator Console' section
from Advanced Concepts

* Comment out the Keystores, Secrets sections in Get Started
since it's covered in Advanced Concepts now

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-05-03 12:50:32 +02:00
Jan Lieskovsky
ec4403ddfa [KEYCLOAK-9361] Replace reference to OpenShift Primer book with
reference to latest OCP version install

OpenShift Primer is very outdated (recommends OpenShift Enterprise v3.2 yet),
while latest OCP version is v3.11. As such, the recommended OpenShift Primer
steps aren't working to get fresh OCP install up & running

Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2019-05-03 12:50:32 +02:00
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