Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cesarvr/okd-runner

Write self-deploying Node.js applications for OpenShift and soon in Kubernetes.
https://github.com/cesarvr/okd-runner

kubernetes nodejs openshi

Last synced: about 1 month ago
JSON representation

Write self-deploying Node.js applications for OpenShift and soon in Kubernetes.

Awesome Lists containing this project

README 

        
## OKD-runner

This library helps to write self-deploying Node.js applications for *OpenShift* and **soon** in *Kubernetes*.



#### Setup

Now this guide assume you got an OpenShift cluster up and running, if you don't, you still can get access to [OpenShift Online](https://manage.openshift.com/) for free or setup one in your computer via [Minishift](https://github.com/minishift/minishift) or [oc cluster-up](https://github.com/cesarvr/Openshift#ocup).



Once you have OpenShift sorted out, you'll need to create a project/namespace manually, you can do this by login into the console and clicking into new project, thats the only limitation of the module at the moment of not being able to create it for you.



### Getting Started



Before continue you'll need an OpenShift cluster up and running, the easiest way is to subscribe here [OpenShift Online](https://manage.openshift.com/) for free or if you *feel strong* you can setup one in your computer via [Minishift](https://github.com/minishift/minishift) or [oc cluster-up](https://github.com/cesarvr/Openshift#ocup).



Once you have OpenShift sorted out, you'll need to create a project/namespace manually, you can do this by login into the web console and clicking into new project.



![](https://github.com/cesarvr/hugo-blog/blob/master/static/self-deploy/making-project.gif?raw=true)






    

### Self Deploying



Now we should get back to our working directory and install ``okd-runner`` [module from npm](https://www.npmjs.com/package/okd-runner), this is the module that does the *magic*:



```sh

npm install install okd-runner --save

```



We add the module:



```js

let count = 0



const run = require('okd-runner') // <- self-deploy module



require('http')

    .createServer((req, res) => {

        res.end(`

                    
Hello From -> ${process.platform}


                    
Visitor: ${count++} 


                `)

        console.log(`response: ${Date.now()}`)

    }).listen(8080)

```



By adding this module you still can run your application locally, the only difference is that now you can choose a different execution runtime by passing the ``--cloud`` flag, this flag will tell your JS program to run in OpenShift:



```sh

  node app --cloud   # or node app -c for short

```



* The first time it will ask you for your cluster credentials:



![](https://github.com/cesarvr/hugo-blog/blob/master/static/self-deploy/credentials.png?raw=true)



* And also to choose the namespace/project:



![](https://github.com/cesarvr/hugo-blog/blob/master/static/self-deploy/namespace.png?raw=true)



##### Runtime



After that your application will start the deployment:



![](https://github.com/cesarvr/hugo-blog/blob/master/static/self-deploy/self-deployment.gif?raw=true)



```sh

...

building  ok

URL:  http://my-app-dev-01.7e14.starter-us-west-2.openshiftapps.com

...

...

npm info using [email protected]

npm info lifecycle [email protected]~prestart: [email protected]

npm info lifecycle [email protected]~start: [email protected]



> [email protected] start /opt/app-root/src

> node app.js



response: 1550511176623

...

```



Here you can see the logs of you container plus the URL, to exit you just need to press ``Ctrl-C`` and you will get back to your console.



##### Updating



From now everything is similar as to run your application locally, let's add a line of code to get the pods name, this way showcase how we can make an update:



```js

let count = 0

const run = require('okd-runner')

console.log('listening in 8080')

require('http')

    .createServer((req, res) => {

        res.end(`

                    
Hello From ${process.platform}


                    
Visitors ${count++} 



                    

                    
Pod ${require('os').hostname()}


                    

                    



                `)

        console.log(`response: ${Date.now()}`)

    }).listen(8080)



```



We run our application again:



```sh

  node app --cloud

```



This time it goes straight to deployment.



![](https://github.com/cesarvr/hugo-blog/blob/master/static/self-deploy/oc-update.gif?raw=true)



##### Cleaning up



To remove your application you just need to pass the ``-rm`` flag:



```js

node app -rm

```



You see not a single YAML file, hope this module helps you simplify your workflow while developing Node.JS micro-services. Also this module is still under development so feel free to [contribute](https://github.com/cesarvr/okd-runner) by sending suggestions, pull request, improvements or by opening an [issue](https://github.com/cesarvr/okd-runner/issues).