{ "kind": "Template", "apiVersion": "template.openshift.io/v1", "metadata": { "name": "nodejs-postgresql-example", "creationTimestamp": null, "annotations": { "description": "An example Node.js application with a PostgreSQL database. For more information about using this template, including OpenShift considerations, see https://github.com/nodeshift-starters/nodejs-rest-http-crud/blob/master/README.md.\n\nWARNING: Any data stored will be lost upon pod destruction. Only use this template for testing.", "iconClass": "icon-nodejs", "openshift.io/display-name": "Node.js + PostgreSQL (Ephemeral)", "openshift.io/documentation-url": "https://github.com/nodeshift-starters/nodejs-rest-http-crud", "openshift.io/long-description": "This template defines resources needed to develop a NodeJS application, including a build configuration, application deployment configuration, and database deployment configuration. The database is stored in non-persistent storage, so this configuration should be used for experimental purposes only.", "openshift.io/provider-display-name": "Red Hat, Inc.", "openshift.io/support-url": "https://access.redhat.com", "tags": "quickstart,nodejs", "template.openshift.io/bindable": "false" } }, "message": "The following service(s) have been created in your project: ${NAME}, ${DATABASE_SERVICE_NAME}.\n\nFor more information about using this template, including OpenShift considerations, see https://github.com/nodeshift-starters/nodejs-rest-http-crud/blob/master/README.md.", "objects": [ { "apiVersion": "v1", "kind": "Secret", "metadata": { "name": "${NAME}" }, "stringData": { "database-admin-password": "${DATABASE_ADMIN_PASSWORD}", "database-password": "${DATABASE_PASSWORD}", "database-user": "${DATABASE_USER}" } }, { "apiVersion": "v1", "kind": "Service", "metadata": { "annotations": { "description": "Exposes and load balances the application pods", "service.alpha.openshift.io/dependencies": "[{\"name\": \"${DATABASE_SERVICE_NAME}\", \"kind\": \"Service\"}]" }, "name": "${NAME}" }, "spec": { "ports": [ { "name": "web", "port": 8080, "targetPort": 8080 } ], "selector": { "name": "${NAME}" } } }, { "apiVersion": "route.openshift.io/v1", "kind": "Route", "metadata": { "name": "${NAME}" }, "spec": { "host": "${APPLICATION_DOMAIN}", "to": { "kind": "Service", "name": "${NAME}" } } }, { "apiVersion": "image.openshift.io/v1", "kind": "ImageStream", "metadata": { "annotations": { "description": "Keeps track of changes in the application image" }, "name": "${NAME}" } }, { "apiVersion": "build.openshift.io/v1", "kind": "BuildConfig", "metadata": { "annotations": { "description": "Defines how to build the application", "template.alpha.openshift.io/wait-for-ready": "true" }, "name": "${NAME}" }, "spec": { "output": { "to": { "kind": "ImageStreamTag", "name": "${NAME}:latest" } }, "postCommit": {}, "source": { "contextDir": "${CONTEXT_DIR}", "git": { "ref": "${SOURCE_REPOSITORY_REF}", "uri": "${SOURCE_REPOSITORY_URL}" }, "type": "Git" }, "strategy": { "sourceStrategy": { "env": [ { "name": "NPM_MIRROR", "value": "${NPM_MIRROR}" } ], "from": { "kind": "ImageStreamTag", "name": "nodejs:${NODEJS_VERSION}", "namespace": "${NAMESPACE}" } }, "type": "Source" }, "triggers": [ { "type": "ImageChange" }, { "type": "ConfigChange" }, { "github": { "secret": "${GITHUB_WEBHOOK_SECRET}" }, "type": "GitHub" }, { "generic": { "secret": "${GENERIC_WEBHOOK_SECRET}" }, "type": "Generic" } ] } }, { "apiVersion": "apps.openshift.io/v1", "kind": "DeploymentConfig", "metadata": { "annotations": { "description": "Defines how to deploy the application server", "template.alpha.openshift.io/wait-for-ready": "true" }, "labels": { "app.openshift.io/runtime": "nodejs" }, "name": "${NAME}" }, "spec": { "replicas": 1, "selector": { "name": "${NAME}" }, "strategy": { "type": "Recreate" }, "template": { "metadata": { "labels": { "app.openshift.io/runtime": "nodejs", "name": "${NAME}" }, "name": "${NAME}" }, "spec": { "containers": [ { "env": [ { "name": "DATABASE_SERVICE_NAME", "value": "${DATABASE_SERVICE_NAME}" }, { "name": "POSTGRESQL_USER", "valueFrom": { "secretKeyRef": { "key": "database-user", "name": "${NAME}" } } }, { "name": "POSTGRESQL_PASSWORD", "valueFrom": { "secretKeyRef": { "key": "database-password", "name": "${NAME}" } } }, { "name": "POSTGRESQL_DATABASE", "value": "${DATABASE_NAME}" }, { "name": "POSTGRESQL_ADMIN_PASSWORD", "valueFrom": { "secretKeyRef": { "key": "database-admin-password", "name": "${NAME}" } } } ], "image": " ", "livenessProbe": { "httpGet": { "path": "/", "port": 8080 }, "initialDelaySeconds": 30, "timeoutSeconds": 3 }, "name": "nodejs-postgresql-example", "ports": [ { "containerPort": 8080 } ], "readinessProbe": { "httpGet": { "path": "/", "port": 8080 }, "initialDelaySeconds": 3, "timeoutSeconds": 3 }, "resources": { "limits": { "memory": "${MEMORY_LIMIT}" } } } ] } }, "triggers": [ { "imageChangeParams": { "automatic": true, "containerNames": [ "nodejs-postgresql-example" ], "from": { "kind": "ImageStreamTag", "name": "${NAME}:latest" } }, "type": "ImageChange" }, { "type": "ConfigChange" } ] } }, { "apiVersion": "v1", "kind": "Service", "metadata": { "annotations": { "description": "Exposes the database server" }, "name": "${DATABASE_SERVICE_NAME}" }, "spec": { "ports": [ { "name": "postgresql", "port": 5432, "targetPort": 5432 } ], "selector": { "name": "${DATABASE_SERVICE_NAME}" } } }, { "apiVersion": "apps.openshift.io/v1", "kind": "DeploymentConfig", "metadata": { "annotations": { "description": "Defines how to deploy the database", "template.alpha.openshift.io/wait-for-ready": "true" }, "name": "${DATABASE_SERVICE_NAME}" }, "spec": { "replicas": 1, "selector": { "name": "${DATABASE_SERVICE_NAME}" }, "strategy": { "type": "Recreate" }, "template": { "metadata": { "labels": { "name": "${DATABASE_SERVICE_NAME}" }, "name": "${DATABASE_SERVICE_NAME}" }, "spec": { "containers": [ { "env": [ { "name": "POSTGRESQL_USER", "valueFrom": { "secretKeyRef": { "key": "database-user", "name": "${NAME}" } } }, { "name": "POSTGRESQL_PASSWORD", "valueFrom": { "secretKeyRef": { "key": "database-password", "name": "${NAME}" } } }, { "name": "POSTGRESQL_DATABASE", "value": "${DATABASE_NAME}" }, { "name": "POSTGRESQL_ADMIN_PASSWORD", "valueFrom": { "secretKeyRef": { "key": "database-admin-password", "name": "${NAME}" } } } ], "image": " ", "livenessProbe": { "initialDelaySeconds": 30, "tcpSocket": { "port": 5432 }, "timeoutSeconds": 1 }, "name": "postgresql", "ports": [ { "containerPort": 5432 } ], "resources": { "limits": { "memory": "${MEMORY_POSTGRESQL_LIMIT}" } }, "volumeMounts": [ { "mountPath": "/var/lib/postgresql/data", "name": "${DATABASE_SERVICE_NAME}-data" } ] } ], "volumes": [ { "emptyDir": { "medium": "" }, "name": "${DATABASE_SERVICE_NAME}-data" } ] } }, "triggers": [ { "imageChangeParams": { "automatic": true, "containerNames": [ "postgresql" ], "from": { "kind": "ImageStreamTag", "name": "postgresql:${POSTGRESQL_VERSION}", "namespace": "${NAMESPACE}" } }, "type": "ImageChange" }, { "type": "ConfigChange" } ] } } ], "parameters": [ { "name": "NAME", "displayName": "Name", "description": "The name assigned to all of the frontend objects defined in this template.", "value": "nodejs-postgresql-example", "required": true }, { "name": "NAMESPACE", "displayName": "Namespace", "description": "The OpenShift Namespace where the ImageStream resides.", "value": "openshift", "required": true }, { "name": "NODEJS_VERSION", "displayName": "Version of NodeJS Image", "description": "Version of NodeJS image to be used (18-ubi8, 20-ubi8, or latest).", "value": "18-ubi8", "required": true }, { "name": "POSTGRESQL_VERSION", "displayName": "Version of PostgreSQL Image", "description": "Version of PostgreSQL image to be used (12-el8, or latest).", "value": "12-el8", "required": true }, { "name": "MEMORY_LIMIT", "displayName": "Memory Limit", "description": "Maximum amount of memory the Node.js container can use.", "value": "256Mi", "required": true }, { "name": "MEMORY_POSTGRESQL_LIMIT", "displayName": "Memory Limit (PostgreSQL)", "description": "Maximum amount of memory the PostgreSQL container can use.", "value": "256Mi", "required": true }, { "name": "SOURCE_REPOSITORY_URL", "displayName": "Git Repository URL", "description": "The URL of the repository with your application source code.", "value": "https://github.com/nodeshift-starters/nodejs-rest-http-crud.git", "required": true }, { "name": "SOURCE_REPOSITORY_REF", "displayName": "Git Reference", "description": "Set this to a branch name, tag or other ref of your repository if you are not using the default branch." }, { "name": "CONTEXT_DIR", "displayName": "Context Directory", "description": "Set this to the relative path to your project if it is not in the root of your repository." }, { "name": "APPLICATION_DOMAIN", "displayName": "Application Hostname", "description": "The exposed hostname that will route to the Node.js service, if left blank a value will be defaulted." }, { "name": "GITHUB_WEBHOOK_SECRET", "displayName": "GitHub Webhook Secret", "description": "Github trigger secret. A difficult to guess string encoded as part of the webhook URL. Not encrypted.", "generate": "expression", "from": "[a-zA-Z0-9]{40}" }, { "name": "GENERIC_WEBHOOK_SECRET", "displayName": "Generic Webhook Secret", "description": "A secret string used to configure the Generic webhook.", "generate": "expression", "from": "[a-zA-Z0-9]{40}" }, { "name": "DATABASE_SERVICE_NAME", "displayName": "Database Service Name", "value": "postgresql", "required": true }, { "name": "DATABASE_USER", "displayName": "PostgreSQL Username", "description": "Username for PostgreSQL user that will be used for accessing the database.", "generate": "expression", "from": "user[A-Z0-9]{3}" }, { "name": "DATABASE_PASSWORD", "displayName": "PostgreSQL Password", "description": "Password for the PostgreSQL user.", "generate": "expression", "from": "[a-zA-Z0-9]{16}" }, { "name": "DATABASE_NAME", "displayName": "Database Name", "value": "my_data", "required": true }, { "name": "DATABASE_ADMIN_PASSWORD", "displayName": "Database Administrator Password", "description": "Password for the database admin user.", "generate": "expression", "from": "[a-zA-Z0-9]{16}" }, { "name": "NPM_MIRROR", "displayName": "Custom NPM Mirror URL", "description": "The custom NPM mirror URL" } ], "labels": { "app": "nodejs-postgresql-example", "template": "nodejs-postgresql-example" } }