diff --git a/openshift/index.adoc b/openshift/index.adoc index 6e01925d19..557c47be93 100644 --- a/openshift/index.adoc +++ b/openshift/index.adoc @@ -7,6 +7,6 @@ include::topics/templates/document-attributes-product.adoc[] :openshift: -= {project_openshift_product_name} += {openshift_name} include::topics.adoc[] diff --git a/openshift/master.adoc b/openshift/master.adoc index 6e01925d19..557c47be93 100644 --- a/openshift/master.adoc +++ b/openshift/master.adoc @@ -7,6 +7,6 @@ include::topics/templates/document-attributes-product.adoc[] :openshift: -= {project_openshift_product_name} += {openshift_name} include::topics.adoc[] diff --git a/openshift/topics/introduction.adoc b/openshift/topics/introduction.adoc index 6e653fbd9a..48d07a54b8 100644 --- a/openshift/topics/introduction.adoc +++ b/openshift/topics/introduction.adoc @@ -1,33 +1,33 @@ == Introduction -=== What Is {project_openshift_product_name}? -{project_openshift_product_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. +=== 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. [[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_openshift_product_name} {project_version} server based deployment and can be split into the following two categories: +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: [[passthrough-templates]] -* Templates using HTTPS and JGroups keystores and a truststore for the {project_openshift_product_name} server, all prepared beforehand. These secure the TLS communication using link:https://docs.openshift.com/container-platform/latest/architecture/networking/routes.html#passthrough-termination[passthrough TLS termination]: +* Templates using HTTPS and JGroups keystores and a truststore for the {project_name} server, all prepared beforehand. These secure the TLS communication using link:https://docs.openshift.com/container-platform/latest/architecture/networking/routes.html#passthrough-termination[passthrough TLS termination]: -** *_{project_templates_version}-https_*: {project_openshift_product_name} {project_version} backed by internal H2 database on the same pod. -** *_{project_templates_version}-mysql_*: {project_openshift_product_name} {project_version} backed by ephemeral MySQL database on a separate pod. -** *_{project_templates_version}-mysql-persistent_*: {project_openshift_product_name} {project_version} backed by persistent MySQL database on a separate pod. -** *_{project_templates_version}-postgresql_*: {project_openshift_product_name} {project_version} backed by ephemeral PostgreSQL database on a separate pod. -** *_{project_templates_version}-postgresql-persistent_*: {project_openshift_product_name} {project_version} backed by persistent PostgreSQL database on a separate pod. +** *_{project_templates_version}-https_*: {project_name} {project_version} backed by internal H2 database on the same pod. +** *_{project_templates_version}-mysql_*: {project_name} {project_version} backed by ephemeral MySQL database on a separate pod. +** *_{project_templates_version}-mysql-persistent_*: {project_name} {project_version} backed by persistent MySQL database on a separate pod. +** *_{project_templates_version}-postgresql_*: {project_name} {project_version} backed by ephemeral PostgreSQL database on a separate pod. +** *_{project_templates_version}-postgresql-persistent_*: {project_name} {project_version} backed by persistent PostgreSQL database on a separate pod. [[reencrypt-templates]] -* Templates using OpenShift's internal link:https://docs.openshift.com/container-platform/latest/dev_guide/secrets.html#service-serving-certificate-secrets[service serving x509 certificate secrets] to automatically create the HTTPS keystore used for serving secure content. The JGroups cluster traffic is authenticated using the `AUTH` protocol and encrypted using the `ASYM_ENCRYPT` protocol. The {project_openshift_product_name} server truststore is also created automatically, containing the */var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt* CA certificate file, which is used to sign the certificate for HTTPS keystore. Moreover, the truststore for the {project_openshift_product_name} server is pre-populated with the all known, trusted CA certificate files found in the Java system path. These templates secure the TLS communication using link:https://docs.openshift.com/container-platform/latest/architecture/networking/routes.html#re-encryption-termination[re-encryption TLS termination]: +* Templates using OpenShift's internal link:https://docs.openshift.com/container-platform/latest/dev_guide/secrets.html#service-serving-certificate-secrets[service serving x509 certificate secrets] to automatically create the HTTPS keystore used for serving secure content. The JGroups cluster traffic is authenticated using the `AUTH` protocol and encrypted using the `ASYM_ENCRYPT` protocol. The {project_name} server truststore is also created automatically, containing the */var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt* CA certificate file, which is used to sign the certificate for HTTPS keystore. Moreover, the truststore for the {project_name} server is pre-populated with the all known, trusted CA certificate files found in the Java system path. These templates secure the TLS communication using link:https://docs.openshift.com/container-platform/latest/architecture/networking/routes.html#re-encryption-termination[re-encryption TLS termination]: -** *_{project_templates_version}-x509-https_*: {project_openshift_product_name} {project_version} with auto-generated HTTPS keystore and {project_openshift_product_name} truststore, backed by internal H2 database. The `ASYM_ENCRYPT` JGroups protocol is used for encryption of cluster traffic. -** *_{project_templates_version}-x509-mysql-persistent_*: {project_openshift_product_name} {project_version} with auto-generated HTTPS keystore and {project_openshift_product_name} truststore, backed by persistent MySQL database. The `ASYM_ENCRYPT` JGroups protocol is used for encryption of cluster traffic. -** *_{project_templates_version}-x509-postgresql-persistent_*: {project_openshift_product_name} {project_version} with auto-generated HTTPS keystore and {project_openshift_product_name} truststore, backed by persistent PostgreSQL database. The `ASYM_ENCRYPT` JGroups protocol is used for encryption of cluster traffic. +** *_{project_templates_version}-x509-https_*: {project_name} {project_version} with auto-generated HTTPS keystore and {project_name} truststore, backed by internal H2 database. The `ASYM_ENCRYPT` JGroups protocol is used for encryption of cluster traffic. +** *_{project_templates_version}-x509-mysql-persistent_*: {project_name} {project_version} with auto-generated HTTPS keystore and {project_name} truststore, backed by persistent MySQL database. The `ASYM_ENCRYPT` JGroups protocol is used for encryption of cluster traffic. +** *_{project_templates_version}-x509-postgresql-persistent_*: {project_name} {project_version} with auto-generated HTTPS keystore and {project_name} truststore, backed by persistent PostgreSQL database. The `ASYM_ENCRYPT` JGroups protocol is used for encryption of cluster traffic. -Other templates that integrate with {project_openshift_product_name} are also available: +Other templates that integrate with {project_name} are also available: -* *_eap64-sso-s2i_*: {project_openshift_product_name}-enabled Red Hat JBoss Enterprise Application Platform 6.4. -* *_eap71-sso-s2i_*: {project_openshift_product_name}-enabled Red Hat JBoss Enterprise Application Platform 7.1. -* *_datavirt63-secure-s2i_*: {project_openshift_product_name}-enabled Red Hat JBoss Data Virtualization 6.3. +* *_eap64-sso-s2i_*: {project_name}-enabled Red Hat JBoss Enterprise Application Platform 6.4. +* *_eap71-sso-s2i_*: {project_name}-enabled Red Hat JBoss Enterprise Application Platform 7.1. +* *_datavirt63-secure-s2i_*: {project_name}-enabled Red Hat JBoss Data Virtualization 6.3. -These templates contain environment variables specific to {project_openshift_product_name} that enable automatic {project_openshift_product_name} client registration when deployed. +These templates contain environment variables specific to {project_name} that enable automatic {project_name} client registration when deployed. -See xref:Auto-Man-Client-Reg[Automatic and Manual {project_openshift_product_name} Client Registration Methods] for more information. +See xref:Auto-Man-Client-Reg[Automatic and Manual {project_name} Client Registration Methods] for more information. diff --git a/topics/templates/document-attributes-product.adoc b/topics/templates/document-attributes-product.adoc index e6c9a5f6f6..567e2f98c5 100644 --- a/topics/templates/document-attributes-product.adoc +++ b/topics/templates/document-attributes-product.adoc @@ -8,7 +8,6 @@ ifeval::[{project_product_cd}==false] :project_name_full: Red Hat Single Sign-On -:project_openshift_product_name: {project_name_full} for OpenShift :project_version: 7.3.0.GA :project_versionDoc: 7.3 :project_templates_version: sso73 @@ -19,7 +18,6 @@ endif::[] ifeval::[{project_product_cd}==true] :project_name_full: Red Hat Single Sign-On Continuous Delivery -:project_openshift_product_name: {project_name_full} :project_version: 6 :project_versionDoc: 6 :project_templates_version: sso-cd @@ -28,6 +26,7 @@ ifeval::[{project_product_cd}==true] :maven_repository: https://maven.repository.redhat.com/earlyaccess/ endif::[] +:project_openshift_product_name: {project_name} for OpenShift :project_dirref: RHSSO_HOME @@ -60,6 +59,7 @@ endif::[] :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/ :installguide_name: Server Installation and Configuration Guide :installguide_link: {project_doc_base_url}/server_installation_and_configuration_guide/