OpenShift Node.js module for interfacing with OpenShift from Node.js.
# install module
npm install --save rhcjs
var rhc = require('rhcjs)({
username : 'test@test.com',
password : 'test123',
target : 'openshift.redhat.com', // optional - defaults to openshift.redhat.com
domain : 'test' // optional - if ommitted, app operations won't work
});
var rhc = require('rhcjs)({
username : 'test@test.com',
token : '1a2b3c', // bearer auth token
domain : 'test'
});
This is useful when you need to do a list domains before deciding which one to use with the rhc client.
rhc.apps(function(err, res){
// Res will be an array of apps
});
rhc.app.show({ app : 'Some app name' }, function(err, res){
// Res will be app info
});
rhc.app.create({
name : 'Some app name',
cartridges : ['Cartridge(s) to create using']
empty : true|false, // optional - default false. If true, creates with empty git repo
fromCode : 'git://somePublicGitRepo' // optional - if set, initialises repo with code pulled from specified public git repo
}, function(err, res){
});
rhc.app.configure({ app : 'Some app name', auto_deploy : true, deployment_branch : 'master' }, function(err, res){
});
// List
rhc.app.env.list({ app : 'Some app name'}, function(err, envvars){});
// Set
rhc.app.env.set({
app : 'Some app name',
vars : [
{ name : 'envVarName', value : 'envVarValue'}
]
}, function(err, envvars){
});
// Unset
rhc.app.env.unset({
app : 'Some app name',
vars : [
{ name : 'someVarName' } // note we don't specify the value here to unset
]
});
rhc.app.del({ app : 'Some app name' }, function(err, res){
});
rhc.ssh.add({ name : 'Ssh key name', key : 'SSH key content' }, function(err, res){
});
rhc.ssh.remove({ name : 'Ssh key name' }, function(err, res){
});
rhc.cartridges(function(err, res){
});
rhc.domains.list(function(err, res){
});
rhc.domains('domainName', function(err, res){
});
rhc.authorize(function(err, res){
});
rhc.alias.add({id : 'appId', name : 'aliasName'}, function(err, createResult){
});
rhc.alias.create({id : 'appId' }, function(err, aliasesList){
});
rhc.alias.remove({id : 'appId', name : 'aliasName'}, function(err, removeResult){
});
{
"responseBody": "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n<html><head>\n<title>401 Authorization Required</title>\n</head><body>\n<h1>Authorization Required</h1>\n<p>This server could not verify that you\nare authorized to access the document\nrequested. Either you supplied the wrong\ncredentials (e.g., bad password), or your\nbrowser doesn't understand how to supply\nthe credentials required.</p>\n<hr>\n<address>Apache/2.2.15 (Red Hat) Server at openshift.com Port 80</address>\n</body></html>\n",
"code": 401,
"error": "Not authenticated (401)",
"url": "https://invalid:invalid@openshift.com/broker/rest/domain/invalid/applications",
"method": "post",
"body": {
"name": "myfirstapp",
"cartridges": [
"diy-1.0"
],
"initial_git_url": "empty"
}
}
{
"responseBody": {
"api_version": 1.3,
"data": null,
"messages": [
{
"exit_code": 100,
"field": "name",
"index": null,
"severity": "error",
"text": "The supplied application name 'myfirstapp' already exists"
}
],
"status": "unprocessable_entity",
"supported_api_versions": [],
"type": null,
"version": "1.3"
},
"code": 422,
"error": "The supplied application name 'myfirstapp' already exists (422)",
"url": "https://test%40example.com:password@openshift.com/broker/rest/domain/mydomain/applications",
"method": "post",
"body": {
"name": "myfirstapp",
"cartridges": [
"diy-0.1"
]
}
}
{
"responseBody": {
"api_version": 1.3,
"data": null,
"messages": [
{
"exit_code": 101,
"field": null,
"index": null,
"severity": "error",
"text": "Application 'mysecondapp' not found."
}
],
"status": "not_found",
"supported_api_versions": [],
"type": null,
"version": "1.3"
},
"code": 404,
"error": "Application 'mysecondapp' not found. (404)",
"url": "https://test%40example.com:password@openshift.com/broker/rest/domain/mydomain/application/mysecondapp?include=cartridges"
}
npm test
##Or for acceptance tests
export OPENSHIFT_USERNAME="unamehere"
export OPENSHIFT_PASSWORD="pwdhere"
./node_modules/.bin/mocha -A -u exports --recursive -t 30000 test/accept.js
FAQs
OpenShift interface, rhc-like, for Node.js.
We found that rhcjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Socket found a Rust typosquat (finch-rust) that loads sha-rust to steal credentials, using impersonation and an unpinned dependency to auto-deliver updates.
Research
/Security Fundamentals
A pair of typosquatted Go packages posing as Googleâs UUID library quietly turn helper functions into encrypted exfiltration channels to a paste site, putting developer and CI data at risk.
Security News
November CVE publications fell 25% YoY even as 2025 totals rose, showing how a few major CNAs can swing âglobalâ counts and skew perceived risk.