Visit this site at http://openshift.github.io/openshift-java-client
+ +To run this site locally, checkout this gh-pages-awestruct branch, run "bundle install", and then run "awestruct -d"
+ +To deploy this site, checkout the gh-pages-awestruct branch, run "awestruct", then then run "awestruct -P production –deploy".
diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 706b3a93..3f998a3c --- a/README.md +++ b/README.md @@ -1,41 +1,8 @@ -OpenShift Java Client [](https://travis-ci.org/openshift/openshift-java-client) [](https://maven-badges.herokuapp.com/maven-central/com.openshift/openshift-java-client) -=========================== +OpenShift Java Client Website +===================== -Java client for the OpenShift REST API. It pretty much offers all features that are currently available in the rhc-* command line tools -(create/rename a domain, create/destroy applications, list applications, list available cartridges, add cartridges, etc.). +Visit this site at http://openshift.github.io/openshift-java-client -Only for Version 2 ----------------- -This client is used by JBoss Tools for OpenShift 2.x. -For later OpenShift versions see https://github.com/openshift/openshift-restclient-java/. - -Usage ------ -An exemplary usage of the client may look like the following: - - IOpenShiftConnection connection = - new OpenShiftConnectionFactory().getConnection("myApplicationId", "user", "password"); - IUser user = connection.getUser(); - IDomain domain = user.createDomain("myDomain"); - IApplication as7Application = domain.createApplication("myApplication", LatestVersionOf.jbossAs().get(user)); - IEmbeddedCartridge mySqlCartridge = as7Application.addEmbeddableCartridge(LatestVersionOf.mySQL().get(user)); - String unstructuredCredentials = mySqlCartridge.getCreationLog(); - String mySqlConnectionUrl = mySqlCartridge.getUrl(); - -There are also 2 blog posts on jboss.org which discuss the API in more details: - -* [show-domain-info: openshift-java-client in a nutshell](http://planet.jboss.org/post/show_domain_info_openshift_java_client_in_a_nutshell) -* [enable-openshift-ci: full example using openshift-java-client](https://community.jboss.org/wiki/Enable-openshift-ciFullExampleUsingOpenshift-java-client) - -Most insightful are the integration tests within the library which pretty much use the API in all details: - -* ApplicationResourceIntegrationTest -* DomainResourceIntegrationTest -* EmbeddedCartridgeResourceIntegrationTest -* etc. - -Download --------- -You may either build from source using maven (mvn clean package) or get the prebuilt artifact from the maven central. +To run this site locally, install the "Jekyll" gem, checkout this gh-pages branch, and run "jekyll serve --watch" diff --git a/Rakefile b/Rakefile new file mode 100644 index 00000000..2a7d0b91 --- /dev/null +++ b/Rakefile @@ -0,0 +1,200 @@ +# This file is a rake build file. The purpose of this file is to simplify +# setting up and using Awestruct. It's not required to use Awestruct, though it +# does save you time (hopefully). If you don't want to use rake, just ignore or +# delete this file. +# +# If you're just getting started, execute this command to install Awestruct and +# the libraries on which it depends: +# +# rake setup +# +# The setup task installs the necessary libraries according to which Ruby +# environment you are using. If you want the libraries kept inside the project, +# execute this command instead: +# +# rake setup[local] +# +# IMPORTANT: To install gems, you'll need development tools on your machine, +# which include a C compiler, the Ruby development libraries and some other +# development libraries as well. +# +# There are also tasks for running Awestruct. The build will auto-detect +# whether you are using Bundler and, if you are, wrap calls to awestruct in +# `bundle exec`. +# +# To run in Awestruct in development mode, execute: +# +# rake +# +# To clean the generated site before you build, execute: +# +# rake clean preview +# +# To deploy using the production profile, execute: +# +# rake deploy +# +# To get a list of all tasks, execute: +# +# rake -T +# +# Now you're Awestruct with rake! + +$use_bundle_exec = true +$install_gems = ['awestruct -v "~> 0.5.0"', 'rb-inotify -v "~> 0.9.0"'] +$awestruct_cmd = nil +task :default => :preview + +desc 'Setup the environment to run Awestruct' +task :setup, [:env] => :init do |task, args| + next if !which('awestruct').nil? + + if File.exist? 'Gemfile' + if args[:env] == 'local' + require 'fileutils' + FileUtils.remove_file 'Gemfile.lock', true + FileUtils.remove_dir '.bundle', true + system 'bundle install --binstubs=_bin --path=.bundle' + else + system 'bundle install' + end + else + if args[:env] == 'local' + $install_gems.each do |gem| + msg "Installing #{gem}..." + system "gem install --bindir=_bin --install-dir=.bundle #{gem}" + end + else + $install_gems.each do |gem| + msg "Installing #{gem}..." + system "gem install #{gem}" + end + end + end + msg 'Run awestruct using `awestruct` or `rake`' + # Don't execute any more tasks, need to reset env + exit 0 +end + +desc 'Update the environment to run Awestruct' +task :update => :init do + if File.exist? 'Gemfile' + system 'bundle update' + else + system 'gem update awestruct' + end + # Don't execute any more tasks, need to reset env + exit 0 +end + +desc 'Build and preview the site locally in development mode' +task :preview => :check do + run_awestruct '-d' +end + +# provide a serve task for those used to Jekyll commands +desc 'An alias to the preview task' +task :serve => :preview + +desc 'Generate the site using the specified profile (default: development)' +task :gen, [:profile] => :check do |task, args| + profile = args[:profile] || 'development' + profile = 'production' if profile == 'prod' + run_awestruct "-P #{profile} -g --force" +end + +desc 'Generate the site and deploy to production' +task :deploy => :check do + run_awestruct '-P production -g --force --deploy' +end + +desc 'Clean out generated site and temporary files' +task :clean, :spec do |task, args| + require 'fileutils' + dirs = ['.awestruct', '.sass-cache', '_site'] + if args[:spec] == 'all' + dirs << '_tmp' + end + dirs.each do |dir| + FileUtils.remove_dir dir unless !File.directory? dir + end +end + +# Perform initialization steps, such as setting up the PATH +task :init do + # Detect using gems local to project + if File.exist? '_bin' + ENV['PATH'] = "_bin#{File::PATH_SEPARATOR}#{ENV['PATH']}" + ENV['GEM_HOME'] = '.bundle' + end +end + +desc 'Check to ensure the environment is properly configured' +task :check => :init do + if !File.exist? 'Gemfile' + if which('awestruct').nil? + msg 'Could not find awestruct.', :warn + msg 'Run `rake setup` or `rake setup[local]` to install from RubyGems.' + # Enable once the rubygem-awestruct RPM is available + #msg 'Run `sudo yum install rubygem-awestruct` to install via RPM. (Fedora >= 18)' + exit 1 + else + $use_bundle_exec = false + next + end + end + + begin + require 'bundler' + Bundler.setup + rescue LoadError + $use_bundle_exec = false + rescue StandardError => e + msg e.message, :warn + if which('awestruct').nil? + msg 'Run `rake setup` or `rake setup[local]` to install required gems from RubyGems.' + else + msg 'Run `rake update` to install additional required gems from RubyGems.' + end + exit e.status_code + end +end + +# Execute Awestruct +def run_awestruct(args) + system "#{$use_bundle_exec ? 'bundle exec ' : ''}awestruct #{args}" +end + +# A cross-platform means of finding an executable in the $PATH. +# Respects $PATHEXT, which lists valid file extensions for executables on Windows +# +# which 'awestruct' +# => /usr/bin/awestruct +def which(cmd, opts = {}) + unless $awestruct_cmd.nil? || opts[:clear_cache] + return $awestruct_cmd + end + + $awestruct_cmd = nil + exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : [''] + ENV['PATH'].split(File::PATH_SEPARATOR).each do |path| + exts.each do |ext| + candidate = File.join path, "#{cmd}#{ext}" + if File.executable? candidate + $awestruct_cmd = candidate + return $awestruct_cmd + end + end + end + return $awestruct_cmd +end + +# Print a message to STDOUT +def msg(text, level = :info) + case level + when :warn + puts "\e[31m#{text}\e[0m" + else + puts "\e[33m#{text}\e[0m" + end +end diff --git a/_config.yml b/_config.yml new file mode 100644 index 00000000..dfa30df7 --- /dev/null +++ b/_config.yml @@ -0,0 +1,3 @@ +name: OpenShift Java Client +markdown: redcarpet +pygments: true diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 00000000..e79250a9 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,79 @@ +