{ "kind": "Template", "apiVersion": "template.openshift.io/v1", "metadata": { "annotations": { "iconClass" : "icon-sso", "tags" : "sso,keycloak,jboss", "version": "7.6.7.GA", "openshift.io/display-name": "Red Hat Single Sign-On 7.6 on OpenJDK + PostgreSQL (Persistent) for OpenShift 4.X", "openshift.io/provider-display-name": "Red Hat, Inc.", "description": "An example application based on RH-SSO 7.6 on OpenJDK image. For more information about using this template, see https://github.com/jboss-container-images/redhat-sso-7-openshift-image/tree/sso76-dev/docs.", "template.openshift.io/long-description": "This template defines resources needed to develop Red Hat Single Sign-On 7.6 on OpenJDK server based deployment, deployment configuration for PostgreSQL using persistence, and securing RH-SSO communication using re-encrypt TLS. It is intended to be used solely on OpenShift 4.X versions. For OpenShift 3.X variant of this template refer to the 'sso76-ocp3-x509-postgresql-persistent' one.", "template.openshift.io/documentation-url": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/", "template.openshift.io/support-url": "https://access.redhat.com" }, "name": "sso76-ocp4-x509-postgresql-persistent" }, "labels": { "template": "sso76-ocp4-x509-postgresql-persistent", "rhsso": "7.6.7.GA" }, "message": "A new persistent RH-SSO service (using PostgreSQL) has been created in your project. The admin username/password for accessing the master realm via the RH-SSO console is ${SSO_ADMIN_USERNAME}/${SSO_ADMIN_PASSWORD}. The username/password for accessing the PostgreSQL database \"${DB_DATABASE}\" is ${DB_USERNAME}/${DB_PASSWORD}. The HTTPS keystore used for serving secure content, the JGroups keystore used for securing JGroups communications, and server truststore used for securing RH-SSO requests were automatically created via OpenShift's service serving x509 certificate secrets by using a CA bundle that is automatically injected into any configMap annotated with 'service.beta.openshift.io/inject-cabundle=true' annotation. Refer to: https://github.com/openshift/openshift-docs/blob/enterprise-4.1/release_notes/ocp-4-1-release-notes.adoc#service-ca-bundle-changes for additional details about this CA bundle. To enable also dual-network clusters that support both IPv4 and IPv6 address families, all services defined by this template are configured having the 'spec.ipFamilyPolicy' field set to 'PreferDualStack' by default.", "parameters": [ { "displayName": "Application Name", "description": "The name for the application.", "name": "APPLICATION_NAME", "value": "sso", "required": true }, { "displayName": "Custom RH-SSO Server Hostname", "description": "Custom hostname for the RH-SSO server.", "name": "SSO_HOSTNAME", "value": "", "required": false }, { "displayName": "JGroups Cluster Password", "description": "The password for the JGroups cluster.", "name": "JGROUPS_CLUSTER_PASSWORD", "from": "[a-zA-Z0-9]{32}", "generate": "expression", "required": true }, { "displayName": "Database JNDI Name", "description": "Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql", "name": "DB_JNDI", "value": "java:jboss/datasources/KeycloakDS", "required": false }, { "displayName": "Database Name", "description": "Database name", "name": "DB_DATABASE", "value": "root", "required": true }, { "displayName": "Datasource Minimum Pool Size", "description": "Sets xa-pool/min-pool-size for the configured datasource.", "name": "DB_MIN_POOL_SIZE", "required": false }, { "displayName": "Datasource Maximum Pool Size", "description": "Sets xa-pool/max-pool-size for the configured datasource.", "name": "DB_MAX_POOL_SIZE", "required": false }, { "displayName": "Datasource Transaction Isolation", "description": "Sets transaction-isolation for the configured datasource.", "name": "DB_TX_ISOLATION", "required": false }, { "displayName": "PostgreSQL Maximum number of connections", "description": "The maximum number of client connections allowed. This also sets the maximum number of prepared transactions.", "name": "POSTGRESQL_MAX_CONNECTIONS", "required": false }, { "displayName": "PostgreSQL Shared Buffers", "description": "Configures how much memory is dedicated to PostgreSQL for caching data.", "name": "POSTGRESQL_SHARED_BUFFERS", "required": false }, { "displayName": "Database Username", "description": "Database user name", "name": "DB_USERNAME", "from": "user[a-zA-Z0-9]{3}", "generate": "expression", "required": true }, { "displayName": "Database Password", "description": "Database user password", "name": "DB_PASSWORD", "from": "[a-zA-Z0-9]{32}", "generate": "expression", "required": true }, { "displayName": "Database Volume Capacity", "description": "Size of persistent storage for database volume.", "name": "VOLUME_CAPACITY", "value": "1Gi", "required": true }, { "displayName": "ImageStream Namespace", "description": "Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project.", "name": "IMAGE_STREAM_NAMESPACE", "value": "openshift", "required": true }, { "displayName": "RH-SSO Administrator Username", "description": "RH-SSO Server administrator username", "name": "SSO_ADMIN_USERNAME", "from": "[a-zA-Z0-9]{8}", "generate": "expression", "required": true }, { "displayName": "RH-SSO Administrator Password", "description": "RH-SSO Server administrator password", "name": "SSO_ADMIN_PASSWORD", "from": "[a-zA-Z0-9]{32}", "generate": "expression", "required": true }, { "displayName": "RH-SSO Realm", "description": "Realm to be created in the RH-SSO server (e.g. demorealm).", "name": "SSO_REALM", "value": "", "required": false }, { "displayName": "RH-SSO Service Username", "description": "The username used to access the RH-SSO service. This is used by clients to create the appliction client(s) within the specified RH-SSO realm.", "name": "SSO_SERVICE_USERNAME", "value": "", "required": false }, { "displayName": "RH-SSO Service Password", "description": "The password for the RH-SSO service user.", "name": "SSO_SERVICE_PASSWORD", "value": "", "required": false }, { "displayName": "PostgreSQL Image Stream Tag", "description": "The tag to use for the \"postgresql\" image stream. Typically, this aligns with the major.minor version of PostgreSQL.", "name": "POSTGRESQL_IMAGE_STREAM_TAG", "value": "13-el8", "required": true }, { "displayName": "Container Memory Limit", "description": "Container memory limit.", "name": "MEMORY_LIMIT", "value": "1Gi", "required": false } ], "objects": [ { "kind": "ConfigMap", "apiVersion": "v1", "metadata": { "annotations": { "description": "ConfigMap providing service ca bundle.", "service.beta.openshift.io/inject-cabundle": "true" }, "labels": { "application": "${APPLICATION_NAME}" }, "name": "${APPLICATION_NAME}-service-ca" } }, { "kind": "Service", "apiVersion": "v1", "spec": { "ipFamilyPolicy": "PreferDualStack", "ports": [ { "port": 8443, "targetPort": 8443 } ], "selector": { "deploymentConfig": "${APPLICATION_NAME}" } }, "metadata": { "name": "${APPLICATION_NAME}", "labels": { "application": "${APPLICATION_NAME}" }, "annotations": { "description": "The web server's https port.", "service.alpha.openshift.io/serving-cert-secret-name": "sso-x509-https-secret", "service.alpha.openshift.io/dependencies": "[{\"name\": \"${APPLICATION_NAME}-postgresql\", \"kind\": \"Service\"}]" } } }, { "kind": "Service", "apiVersion": "v1", "spec": { "ipFamilyPolicy": "PreferDualStack", "ports": [ { "port": 5432, "targetPort": 5432 } ], "selector": { "deploymentConfig": "${APPLICATION_NAME}-postgresql" } }, "metadata": { "name": "${APPLICATION_NAME}-postgresql", "labels": { "application": "${APPLICATION_NAME}" }, "annotations": { "description": "The database server's port." } } }, { "kind": "Service", "apiVersion": "v1", "spec": { "clusterIP": "None", "ipFamilyPolicy": "PreferDualStack", "ports": [ { "name": "ping", "port": 8888 } ], "publishNotReadyAddresses": true, "selector": { "deploymentConfig": "${APPLICATION_NAME}" } }, "metadata": { "name": "${APPLICATION_NAME}-ping", "labels": { "application": "${APPLICATION_NAME}" }, "annotations": { "service.alpha.openshift.io/serving-cert-secret-name": "sso-x509-jgroups-secret", "description": "The JGroups ping port for clustering." } } }, { "kind": "Route", "apiVersion": "route.openshift.io/v1", "id": "${APPLICATION_NAME}-https", "metadata": { "name": "${APPLICATION_NAME}", "labels": { "application": "${APPLICATION_NAME}" }, "annotations": { "description": "Route for application's https service." } }, "spec": { "to": { "name": "${APPLICATION_NAME}" }, "tls": { "termination": "reencrypt" } } }, { "kind": "DeploymentConfig", "apiVersion": "apps.openshift.io/v1", "metadata": { "name": "${APPLICATION_NAME}", "labels": { "application": "${APPLICATION_NAME}" } }, "spec": { "strategy": { "type": "Recreate" }, "triggers": [ { "type": "ImageChange", "imageChangeParams": { "automatic": true, "containerNames": [ "${APPLICATION_NAME}" ], "from": { "kind": "ImageStreamTag", "namespace": "${IMAGE_STREAM_NAMESPACE}", "name": "sso76-openshift-rhel8:7.6" } } }, { "type": "ConfigChange" } ], "replicas": 1, "selector": { "deploymentConfig": "${APPLICATION_NAME}" }, "template": { "metadata": { "name": "${APPLICATION_NAME}", "labels": { "deploymentConfig": "${APPLICATION_NAME}", "application": "${APPLICATION_NAME}" } }, "spec": { "terminationGracePeriodSeconds": 75, "containers": [ { "name": "${APPLICATION_NAME}", "image": "${APPLICATION_NAME}", "imagePullPolicy": "Always", "resources": { "limits": { "memory": "${MEMORY_LIMIT}" } }, "volumeMounts": [ { "name": "sso-x509-https-volume", "mountPath": "/etc/x509/https", "readOnly": true }, { "name": "sso-x509-jgroups-volume", "mountPath": "/etc/x509/jgroups", "readOnly": true }, { "mountPath": "/var/run/configmaps/service-ca", "name": "service-ca", "readOnly": true }, { "name": "sso-probe-netrc-volume", "mountPath": "/mnt/rh-sso", "readOnly": false } ], "livenessProbe": { "exec": { "command": [ "/bin/bash", "-c", "/opt/eap/bin/livenessProbe.sh" ] }, "failureThreshold": 10, "initialDelaySeconds": 30, "periodSeconds": 30, "successThreshold": 1, "timeoutSeconds": 22 }, "readinessProbe": { "exec": { "command": [ "/bin/bash", "-c", "/opt/eap/bin/readinessProbe.sh" ] }, "failureThreshold": 10, "initialDelaySeconds": 40, "periodSeconds": 30, "successThreshold": 1, "timeoutSeconds": 22 }, "ports": [ { "name": "jolokia", "containerPort": 8778, "protocol": "TCP" }, { "name": "http", "containerPort": 8080, "protocol": "TCP" }, { "name": "https", "containerPort": 8443, "protocol": "TCP" }, { "name": "ping", "containerPort": 8888, "protocol": "TCP" } ], "env": [ { "name": "SSO_HOSTNAME", "value": "${SSO_HOSTNAME}" }, { "name": "DB_SERVICE_PREFIX_MAPPING", "value": "${APPLICATION_NAME}-postgresql=DB" }, { "name": "DB_JNDI", "value": "${DB_JNDI}" }, { "name": "DB_USERNAME", "value": "${DB_USERNAME}" }, { "name": "DB_PASSWORD", "value": "${DB_PASSWORD}" }, { "name": "DB_DATABASE", "value": "${DB_DATABASE}" }, { "name": "TX_DATABASE_PREFIX_MAPPING", "value": "${APPLICATION_NAME}-postgresql=DB" }, { "name": "DB_MIN_POOL_SIZE", "value": "${DB_MIN_POOL_SIZE}" }, { "name": "DB_MAX_POOL_SIZE", "value": "${DB_MAX_POOL_SIZE}" }, { "name": "DB_TX_ISOLATION", "value": "${DB_TX_ISOLATION}" }, { "name": "JGROUPS_PING_PROTOCOL", "value": "dns.DNS_PING" }, { "name": "OPENSHIFT_DNS_PING_SERVICE_NAME", "value": "${APPLICATION_NAME}-ping" }, { "name": "OPENSHIFT_DNS_PING_SERVICE_PORT", "value": "8888" }, { "name": "X509_CA_BUNDLE", "value": "/var/run/configmaps/service-ca/service-ca.crt /var/run/secrets/kubernetes.io/serviceaccount/ca.crt" }, { "name": "JGROUPS_CLUSTER_PASSWORD", "value": "${JGROUPS_CLUSTER_PASSWORD}" }, { "name": "SSO_ADMIN_USERNAME", "value": "${SSO_ADMIN_USERNAME}" }, { "name": "SSO_ADMIN_PASSWORD", "value": "${SSO_ADMIN_PASSWORD}" }, { "name": "SSO_REALM", "value": "${SSO_REALM}" }, { "name": "SSO_SERVICE_USERNAME", "value": "${SSO_SERVICE_USERNAME}" }, { "name": "SSO_SERVICE_PASSWORD", "value": "${SSO_SERVICE_PASSWORD}" } ] } ], "volumes": [ { "name": "sso-x509-https-volume", "secret": { "secretName": "sso-x509-https-secret" } }, { "name": "sso-x509-jgroups-volume", "secret": { "secretName": "sso-x509-jgroups-secret" } }, { "name": "service-ca", "configMap": { "name": "${APPLICATION_NAME}-service-ca" } }, { "name": "sso-probe-netrc-volume", "emptyDir": { "medium": "Memory" } } ] } } } }, { "kind": "DeploymentConfig", "apiVersion": "apps.openshift.io/v1", "metadata": { "name": "${APPLICATION_NAME}-postgresql", "labels": { "application": "${APPLICATION_NAME}" } }, "spec": { "strategy": { "type": "Recreate" }, "triggers": [ { "type": "ImageChange", "imageChangeParams": { "automatic": true, "containerNames": [ "${APPLICATION_NAME}-postgresql" ], "from": { "kind": "ImageStreamTag", "namespace": "${IMAGE_STREAM_NAMESPACE}", "name": "postgresql13-for-sso76-openshift-rhel8:${POSTGRESQL_IMAGE_STREAM_TAG}" } } }, { "type": "ConfigChange" } ], "replicas": 1, "selector": { "deploymentConfig": "${APPLICATION_NAME}-postgresql" }, "template": { "metadata": { "name": "${APPLICATION_NAME}-postgresql", "labels": { "deploymentConfig": "${APPLICATION_NAME}-postgresql", "application": "${APPLICATION_NAME}" } }, "spec": { "terminationGracePeriodSeconds": 60, "containers": [ { "name": "${APPLICATION_NAME}-postgresql", "image": "postgresql", "imagePullPolicy": "Always", "ports": [ { "containerPort": 5432, "protocol": "TCP" } ], "readinessProbe": { "timeoutSeconds": 10, "initialDelaySeconds": 90, "successThreshold:": 1, "failureThreshold": 3, "exec": { "command": [ "/bin/sh", "-i", "-c", "psql -h 127.0.0.1 -U $POSTGRESQL_USER -q -d $POSTGRESQL_DATABASE -c 'SELECT 1'"] } }, "livenessProbe": { "timeoutSeconds": 10, "initialDelaySeconds": 90, "successThreshold:": 1, "failureThreshold": 3, "tcpSocket": { "port": 5432 } }, "volumeMounts": [ { "mountPath": "/var/lib/pgsql/data", "name": "${APPLICATION_NAME}-postgresql-pvol" } ], "env": [ { "name": "POSTGRESQL_USER", "value": "${DB_USERNAME}" }, { "name": "POSTGRESQL_PASSWORD", "value": "${DB_PASSWORD}" }, { "name": "POSTGRESQL_DATABASE", "value": "${DB_DATABASE}" }, { "name": "POSTGRESQL_MAX_CONNECTIONS", "value": "${POSTGRESQL_MAX_CONNECTIONS}" }, { "name": "POSTGRESQL_MAX_PREPARED_TRANSACTIONS", "value": "${POSTGRESQL_MAX_CONNECTIONS}" }, { "name": "POSTGRESQL_SHARED_BUFFERS", "value": "${POSTGRESQL_SHARED_BUFFERS}" } ] } ], "volumes": [ { "name": "${APPLICATION_NAME}-postgresql-pvol", "persistentVolumeClaim": { "claimName": "${APPLICATION_NAME}-postgresql-claim" } } ] } } } }, { "kind": "PersistentVolumeClaim", "apiVersion": "v1", "metadata": { "name": "${APPLICATION_NAME}-postgresql-claim", "labels": { "application": "${APPLICATION_NAME}" } }, "spec": { "accessModes": [ "ReadWriteOnce" ], "resources": { "requests": { "storage": "${VOLUME_CAPACITY}" } } } } ] }