nicolas
/
OpenShift-Demo-NodeJS
mirror of https://github.com/nmasse-itix/OpenShift-Demo-NodeJS.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

document template parameters

pull/2/head
Nicolas Massé 9 years ago
parent
45a62d512b
commit
c5628ef5bc
1 changed files with 13 additions and 11 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 24
      doc/INSTALL.md

24
doc/INSTALL.md
View File

@ -32,17 +32,21 @@ Where parameters are :
| Parameter Name | Required ? | Default Value | Description | | Parameter Name | Required ? | Default Value | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| DEV_PROJECT | No | demo-dev | TODO | | TEST_ROUTE_HOSTNAME | Yes | - | The route to create in the TEST environment and which we will use to run the integration tests |
| BUILD_PROJECT | No | demo-build | TODO | | PROD_ROUTE_HOSTNAME | Yes | - | The route to create in the PROD environment |
| TEST_PROJECT | No | demo-test | TODO | | NPM_EMAIL | Yes | - | Email address of your NPM Account |
| PROD_PROJECT | No | demo-prod | TODO | | NPM_CREDENTIALS_ID | No | npm-secret | The Jenkins Credentials ID that holds login and password to login on NPM Registry |
| NPM_REGISTRY | No | https://registry.npmjs.org | Private NPM registry to log in to |
TODO | GIT_REPO | No | https://github.com/nmasse-itix/OpenShift-Demo-NodeJS.git | The GIT repository to use. This will be useful if you clone this repo. |
| NODEJS_IMAGE_STREAM_TAG | No | nodejs:latest | Name of the ImageStreamTag to be used for the NodeJS image. Change this if you plan to use your own NodeJS S2I image. |
| NODEJS_IMAGE_STREAM_NAMESPACE | No | openshift | The OpenShift Namespace where the NodeJS ImageStream resides. |
| DEV_PROJECT | No | demo-dev | The name of the OpenShift Project to that holds the dev environment |
| BUILD_PROJECT | No | demo-build | The name of the OpenShift Project to that holds the build environment |
| TEST_PROJECT | No | demo-test | The name of the OpenShift Project to that holds the test environment |
| PROD_PROJECT | No | demo-prod | The name of the OpenShift Project to that holds the prod environment |
## Manual Setup ## Manual Setup
### Prepare OpenShift
Create the four environments : Create the four environments :
``` ```
oc new-project demo-dev oc new-project demo-dev
@ -142,6 +146,4 @@ oc set triggers dc/openshift-demo-nodejs-blue --from-image=demo-build/openshift-
oc set triggers dc/openshift-demo-nodejs-green --from-image=demo-build/openshift-demo-nodejs:ready-for-prod --manual=true -c openshift-demo-nodejs-green -n demo-prod oc set triggers dc/openshift-demo-nodejs-green --from-image=demo-build/openshift-demo-nodejs:ready-for-prod --manual=true -c openshift-demo-nodejs-green -n demo-prod
``` ```
### Create the Jenkins Pipeline Then, configure Jenkins [as described here](CONFIGURE_JENKINS.md).
Configure Jenkins [as described here](CONFIGURE_JENKINS.md).

Write Preview
Loading…
Cancel
Save