Skip to content
This repository was archived by the owner on Nov 15, 2018. It is now read-only.

Commit c9cf212

Browse files
committed
Added prereqs, initial setup, TODOs, and LICENSE info
1 parent 2359030 commit c9cf212

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ If you have a scalable application, a `git push` will result in your latest chan
77

88
This is an external solution to allow deploying binary artifacts to OpenShift applications without the need to use git. It consists of a single command line script called "deploy" that performs several actions, described below.
99

10-
But first, some information on binary artifacts and what they are.
10+
## Prerequisites
11+
All of the following must be installed both locally and on all OpenShift nodes:
12+
13+
* ruby (1.8+)
14+
* rubygems
15+
* bundler
1116

1217
## Binary Artifacts
1318
Binary artifacts are compressed tar files (.tar.gz). They contain everything you would expect to see in a normal OpenShift application:
@@ -20,6 +25,15 @@ Binary artifacts are compressed tar files (.tar.gz). They contain everything you
2025
Prior to executing the commands below, create a binary artifact and upload it to a web server (e.g., for Java-based deployments, deploying your artifacts to a Maven repository server such as Nexus or Artifactory is a good option).
2126

2227
# Usage
28+
## Preparing the tooling
29+
First, clone this repo, e.g. `git clone https://github.com/ncdc/openshift-binary-deployment-solution.git`.
30+
31+
Next, change into the cli directory: `cd openshift-binary-deployment-solution/cli`
32+
33+
Run `bundle install`
34+
35+
Now you can run all of the `deploy` commands listed below.
36+
2337
## Init
2438
Usage: `deploy init APP`
2539

@@ -150,4 +164,11 @@ Example output:
150164
20130606121412 - 34e2c81bc295d8b769d9531c44532390d4104705 - myapp-1.0.tar.gz
151165

152166
Gear 51b0e665a7cfd1abf20000a5
153-
20130606121412 - 34e2c81bc295d8b769d9531c44532390d4104705 - myapp-1.0.tar.gz
167+
20130606121412 - 34e2c81bc295d8b769d9531c44532390d4104705 - myapp-1.0.tar.gz
168+
169+
# TODO
170+
* consider making this a gem
171+
* consider creating an RPM spec file
172+
173+
# LICENSE
174+
Licensed under the Apache License, Version 2.0. Please see the LICENSE file for complete details.

0 commit comments

Comments
 (0)