libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

KEYCLOAK-13197 Add OpenJ9 variant of OpenShift guide

Browse source
This commit is contained in:
Hynek Mlnarik 2020-03-03 21:51:20 +01:00 committed by Hynek Mlnařík
parent c201f92046
commit c756744bd5
17 changed files with 144 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
openshift-openj9/docinfo-footer.html Symbolic link
View file

@ -0,0 +1 @@
../openshift/docinfo-footer.html

1
openshift-openj9/docinfo.html Symbolic link
View file

@ -0,0 +1 @@
../openshift/docinfo.html

1
openshift-openj9/images Symbolic link
View file

@ -0,0 +1 @@
../openshift/images

19
openshift-openj9/index.adoc Normal file
View file

@ -0,0 +1,19 @@
:toc:
:toclevels: 3
:numbered:
:linkattrs:
include::topics/templates/document-attributes-product.adoc[]
:project_templates_url: {project_templates_base_url}/openj9
:project_templates_version: {openshift_openj9_project_templates_version}
:openshift_name: {openshift_openj9_name}
:openshift_link: {openshift_openj9_link}
:openshift_image_platforms: {openshift_openj9_platforms}
:openshift_name_other: {openshift_openjdk_name}
:openshift_link_other: {openshift_openjdk_link}
:openshift:
= {openshift_openj9_name}
include::topics.adoc[]

25
openshift-openj9/master-docinfo.xml Normal file
View file

@ -0,0 +1,25 @@
<productname>{project_name_full}</productname>
<productnumber>{project_versionDoc}</productnumber>
<subtitle>For use with {project_name_full} {project_versionDoc}</subtitle>
<title>{openshift_openj9_name}</title>
<release>{project_versionDoc}</release>
<abstract>
<para>This guide consists of basic information and instructions to get started with {project_name_full} {project_versionDoc} for OpenShift on OpenJ9</para>
</abstract>
<authorgroup>
<orgname>Red Hat Customer Content Services</orgname>
</authorgroup>
<legalnotice lang="en-US" version="5.0" xmlns="http://docbook.org/ns/docbook">
<para> Copyright <trademark class="copyright"></trademark> 2020 Red Hat, Inc. </para>
<para>Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</para>
<para>
<ulink url="http://www.apache.org/licenses/LICENSE-2.0"> http://www.apache.org/licenses/LICENSE-2.0</ulink>
</para>
<para>Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</para>
</legalnotice>

19
openshift-openj9/master.adoc Normal file
View file

@ -0,0 +1,19 @@
:toc:
:toclevels: 3
:numbered:
:linkattrs:
include::topics/templates/document-attributes-product.adoc[]
:project_templates_url: {project_templates_base_url}/openj9
:project_templates_version: {openshift_openj9_project_templates_version}
:openshift_name: {openshift_openj9_name}
:openshift_link: {openshift_openj9_link}
:openshift_image_platforms: {openshift_openj9_platforms}
:openshift_name_other: {openshift_openjdk_name}
:openshift_link_other: {openshift_openjdk_link}
:openshift:
= {openshift_openj9_name}
include::topics.adoc[]

46
openshift-openj9/pom.xml Normal file
View file

@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.keycloak.documentation</groupId>
<artifactId>documentation-parent</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../</relativePath>
</parent>
<name>Red Hat Single Sign-On for OpenShift on OpenJ9</name>
<artifactId>openshift-openj9</artifactId>
<packaging>pom</packaging>
<build>
<plugins>
<plugin>
<groupId>org.keycloak.documentation</groupId>
<artifactId>header-maven-plugin</artifactId>
<executions>
<execution>
<id>add-file-headers</id>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<executions>
<execution>
<id>asciidoc-to-html</id>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<id>echo-output</id>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

1
openshift-openj9/topics Symbolic link
View file

@ -0,0 +1 @@
../openshift/topics

1
openshift-openj9/topics.adoc Symbolic link
View file

@ -0,0 +1 @@
../openshift/topics.adoc

7
openshift/index.adoc
View file

@ -4,6 +4,13 @@
:linkattrs:
include::topics/templates/document-attributes-product.adoc[]
:project_templates_url: {project_templates_base_url}
:project_templates_version: {openshift_openjdk_project_templates_version}
:openshift_name: {openshift_openjdk_name}
:openshift_link: {openshift_openjdk_link}
:openshift_image_platforms: {openshift_openjdk_platforms}
:openshift_name_other: {openshift_openj9_name}
:openshift_link_other: {openshift_openj9_link}
:openshift:

2
openshift/master-docinfo.xml
View file

@ -1,7 +1,7 @@
<productname>{project_name_full}</productname>
<productnumber>{project_versionDoc}</productnumber>
<subtitle>For Use with {project_name_full} {project_versionDoc}</subtitle>
<title>{openshift_name}</title>
<title>{openshift_openjdk_name}</title>
<release>{project_versionDoc}</release>
<abstract>
<para>This guide consists of basic information and instructions to get started with {project_name_full} {project_versionDoc} for OpenShift</para>

7
openshift/master.adoc
View file

@ -4,6 +4,13 @@
:linkattrs:
include::topics/templates/document-attributes-product.adoc[]
:project_templates_url: {project_templates_base_url}
:project_templates_version: {openshift_openjdk_project_templates_version}
:openshift_name: {openshift_openjdk_name}
:openshift_link: {openshift_openjdk_link}
:openshift_image_platforms: {openshift_openjdk_platforms}
:openshift_name_other: {openshift_openj9_name}
:openshift_link_other: {openshift_openj9_link}
:openshift:

4
openshift/topics/before_you_begin.adoc
View file

@ -12,9 +12,9 @@ See the xPaaS part of the https://access.redhat.com/articles/2176281[OpenShift a
[IMPORTANT]
====
The {project_openshift_product_name} image version number 7.0 and 7.1 are deprecated and they will no longer receive updates of image and application templates.
The {project_openshift_product_name} image version number between 7.0 and 7.3 are deprecated and they will no longer receive updates of image and application templates.
*To deploy new applications, it is recommended to use the version 7.2 or {project_version} of the {project_openshift_product_name} image along with the application templates specific to these image versions.*
*To deploy new applications, it is recommended to use the version 7.4 or {project_version} of the {project_openshift_product_name} image along with the application templates specific to these image versions.*
====
=== Initial Setup

2
openshift/topics/get_started.adoc
View file

@ -43,7 +43,7 @@ $ for resource in {project_templates_version}-image-stream.json \
{project_templates_version}-x509-postgresql-persistent.json
do
oc replace -n openshift --force -f \
\https://raw.githubusercontent.com/jboss-container-images/redhat-sso-7-openshift-image/{project_templates_version}-dev/templates/${resource}
{project_templates_url}/$\{resource}
done
----
. Run the following command to install the {project_name} {project_version} OpenShift image streams in the `openshift` project:

2
openshift/topics/introduction.adoc
View file

@ -3,6 +3,8 @@
=== What Is {project_name}?
{project_name} is an integrated sign-on solution available as a Red Hat JBoss Middleware for OpenShift containerized image. The {project_openshift_product_name} image provides an authentication server for users to centrally log in, log out, register, and manage user accounts for web applications, mobile applications, and RESTful web services.
{openshift_name} is only available on the following platforms: *{openshift_image_platforms}*. For other available platforms, see link:{openshift_link_other}[{openshift_name_other}].
[[sso-templates]]
Red Hat offers multiple OpenShift application templates utilizing the {project_openshift_product_name} image version number {project_version}. These define the resources needed to develop {project_name} {project_version} server based deployment and can be split into the following two categories:

1
pom.xml
View file

@ -57,6 +57,7 @@
</properties>
<modules>
<module>openshift</module>
<module>openshift-openj9</module>
</modules>
</profile>
<profile>

12
topics/templates/document-attributes-product.adoc
View file

@ -8,7 +8,7 @@
:project_name_full: Red Hat Single Sign-On
:project_version: 7.4.0.GA
:project_versionDoc: 7.4
:project_templates_version: sso74
:project_templates_base_url: https://raw.githubusercontent.com/jboss-container-images/redhat-sso-7-openshift-image/sso74-dev/templates
:project_latest_image_tag: 1.0
:project_doc_base_url: https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/{project_versionDoc}/html-single
:maven_repository: https://maven.repository.redhat.com/ga/
@ -49,8 +49,14 @@
:upgradingguide_link: {project_doc_base_url}/upgrading_guide/
:releasenotes_name: Release Notes
:releasenotes_link: {project_doc_base_url}/release_notes/
:openshift_name: Red Hat Single Sign-On for OpenShift
:openshift_link: {project_doc_base_url}/red_hat_single_sign-on_for_openshift/
:openshift_openjdk_name: Red Hat Single Sign-On for OpenShift on OpenJDK
:openshift_openjdk_link: {project_doc_base_url}/red_hat_single_sign-on_for_openshift/
:openshift_openjdk_platforms: x86_64
:openshift_openjdk_project_templates_version: sso74
:openshift_openj9_name: Red Hat Single Sign-On for OpenShift on OpenJ9
:openshift_openj9_link: {project_doc_base_url}/red_hat_single_sign-on_for_openshift_on_openj9/
:openshift_openj9_platforms: s390x
:openshift_openj9_project_templates_version: sso74-openj9
:installguide_name: Server Installation and Configuration Guide
:installguide_link: {project_doc_base_url}/server_installation_and_configuration_guide/
:installguide_clustering_name: Clustering