mirror of
https://github.com/jlengrand/sample-node-api.git
synced 2026-03-10 08:41:23 +00:00
Modified README to match new ext. installation procedures
Signed-off-by: Jadin Luong <Jadin.Luong@ibm.com>
This commit is contained in:
42
README.md
42
README.md
@@ -21,16 +21,16 @@ npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
Open your local browser and try accessing
|
||||
`https://localhost:18000/accounts/`
|
||||
`https://localhost:18000/accounts/1`
|
||||
`https://localhost:18000/accounts/1/cars/`
|
||||
Open your local browser and verify the sample-node-api is working by accessing:
|
||||
`http://localhost:18000/accounts/`
|
||||
`http://localhost:18000/accounts/1`
|
||||
`http://localhost:18000/accounts/1/cars/`
|
||||
|
||||
|
||||
### 2) Transfer project files from local to remote host
|
||||
|
||||
**Note**
|
||||
Don't transfer `node_modules` folder, we can do install npm install later on remote server itself to pull down required node packages
|
||||
The `node_modules` folder will not be transferred, we can do npm install later on remote server itself to pull down required node packages
|
||||
|
||||
```
|
||||
cd sample-node-api
|
||||
@@ -38,24 +38,27 @@ npm run build
|
||||
scp -r dist ibmuser@my.mainframe.com:</usr/lpp/extender>/sample-node-api
|
||||
```
|
||||
|
||||
For the next step, ensure that you have node installed on z/OS and your PATH includes nodejs/bin directory.
|
||||
|
||||
```
|
||||
ssh ibmuser@my.mainframe.com
|
||||
. ~/.profile - (Skip if you can already run "npm" on z/OS)
|
||||
cd </usr/lpp/extender>/sample-node-api
|
||||
npm install
|
||||
```
|
||||
|
||||
## Method 2: From Artifactory
|
||||
### 1) Download latest pax from artifactory
|
||||
Get latest package from [artifactory](https://zowe.jfrog.io/zowe/webapp/#/artifacts/browse/tree/General/libs-snapshot-local/org/zowe/sample-node-api/1.0.0-SNAPSHOT)
|
||||
Get latest package from [artifactory](https://zowe.jfrog.io/artifactory/libs-snapshot-local/org/zowe/sample-node-api/1.0.0-SNAPSHOT)
|
||||
|
||||
Copy latest pax url and use curl to download:
|
||||
```
|
||||
# on local or directly on z/OS
|
||||
curl -O https://zowe.jfrog.io/zowe/libs-snapshot-local/org/zowe/sample-node-api/1.0.0-SNAPSHOT/sample-node-api-1.0.0-snapshot-1-20200903170045.pax
|
||||
```
|
||||
Choose the latest pax build provided from the link above and download it into your local storage.
|
||||
|
||||
### 2) Transfer and unpax on z/OS
|
||||
```
|
||||
# From local - if downloaded on z/OS skip this
|
||||
sftp ibmuser@mymainframe.ibm.com
|
||||
put <pax-name>.pax
|
||||
```
|
||||
|
||||
|
||||
## PART II: Deploy with Zowe on server
|
||||
|
||||
### 1) login
|
||||
@@ -65,15 +68,18 @@ ssh ibmuser@my.mainframe.com
|
||||
|
||||
### 2) install component using zowe-install-component.sh script
|
||||
```
|
||||
|
||||
./<zowe-runtime-dir>/bin/zowe-install-component.sh -d <zowe-extensions-dir> -i <zowe-instance-dir> -o <component-pax-file> -l <log-folder>
|
||||
|
||||
./<zowe-runtime-dir>/bin/zowe-install-component.sh -d <zowe-extensions-dir> -i <zowe-instance-dir> -o <component-file-path> -l <log-folder>
|
||||
```
|
||||
```
|
||||
<zowe-extensions-dir> - Directory that will hold all external extensions installed onto zowe
|
||||
<zowe-instance-dir> - Current installed Zowe's instance directory
|
||||
<component-file-path> - The path to the component being installed (the component file transferred from local to z/OS in PART I)
|
||||
<log-file> - Directory that will hold the logs of the component installation
|
||||
```
|
||||
|
||||
### 3) Lifecycle scripts of the component
|
||||
|
||||
We expect following in service folder `start.sh`.
|
||||
In our case its bin folder with relevant scripts.
|
||||
We expect following in service folder `start.sh`. In our case its bin folder with relevant scripts.
|
||||
|
||||
`start.sh` starts node app on configured port
|
||||
`env.sh` its custom script use to configure port for our node app, feel free to use your desired way
|
||||
|
||||
Reference in New Issue
Block a user