mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-08 05:58:39 +00:00
cleanup website content for 1.0
This commit is contained in:
parent
bda26b4fa6
commit
120f4bd0fc
3 changed files with 5 additions and 11 deletions
|
@ -3,13 +3,11 @@ h1. Download the library
|
||||||
|
|
||||||
h2. Maven Central Repository
|
h2. Maven Central Repository
|
||||||
|
|
||||||
We plan on hosting the library on the [Maven Central Repository|http://search.maven.org/], with the groupId *org.rundeck* and the artifactId *rundeck-api-java-client*.
|
The library is hosted on the [Maven Central Repository|http://search.maven.org/], with the groupId *org.rundeck* and the artifactId *rundeck-api-java-client*.
|
||||||
|
|
||||||
You can see all versions and download the files with this query : [g:"org.rundeck" AND a:"rundeck-api-java-client"|http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.rundeck%22%20AND%20a%3A%22rundeck-api-java-client%22].
|
You can see all versions and download the files with this query : [g:"org.rundeck" AND a:"rundeck-api-java-client"|http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.rundeck%22%20AND%20a%3A%22rundeck-api-java-client%22].
|
||||||
|
|
||||||
{note}
|
Alternatively, you can download [releases|https://oss.sonatype.org/content/repositories/releases/org/rundeck/rundeck-api-java-client/] or [snapshots|https://oss.sonatype.org/content/repositories/snapshots/org/rundeck/rundeck-api-java-client/] from [Sonatype Nexus OSS instance|https://oss.sonatype.org/] (which is then synchronized to Macen Central).
|
||||||
For the moment, the library is not on the repository, so you will need to download it manually...
|
|
||||||
{note}
|
|
||||||
|
|
||||||
h2. Manual download
|
h2. Manual download
|
||||||
|
|
||||||
|
|
|
@ -5,17 +5,13 @@ Here are some examples of what you can do with this lib and a few lines of [Groo
|
||||||
|
|
||||||
We can use [Grape|http://groovy.codehaus.org/Grape] to download the lib (and its dependencies) from the [Maven Central Repository|http://search.maven.org/], so you don't have to install anything manually (except Groovy, of course).
|
We can use [Grape|http://groovy.codehaus.org/Grape] to download the lib (and its dependencies) from the [Maven Central Repository|http://search.maven.org/], so you don't have to install anything manually (except Groovy, of course).
|
||||||
|
|
||||||
{note}
|
|
||||||
Note that the lib is NOT in the Maven Central Repository for the moment... but hopefully it should be pretty soon ! You can still [download|./download.html] it manually.
|
|
||||||
{note}
|
|
||||||
|
|
||||||
h2. Basic usage
|
h2. Basic usage
|
||||||
|
|
||||||
Save the following script in a file named "{{rundeck.groovy}}", and execute it with "{{groovy rundeck.groovy}}". Feeling Groovy ? ;-)
|
Save the following script in a file named "{{rundeck.groovy}}", and execute it with "{{groovy rundeck.groovy}}". Feeling Groovy ? ;-)
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
// we use Grape (Ivy) to download the lib (and its dependencies) from Maven Central Repository
|
// we use Grape (Ivy) to download the lib (and its dependencies) from Maven Central Repository
|
||||||
@Grab(group='org.rundeck', module='rundeck-api-java-client', version='1.0-SNAPSHOT')
|
@Grab(group='org.rundeck', module='rundeck-api-java-client', version='1.0')
|
||||||
import org.rundeck.api.RundeckClient
|
import org.rundeck.api.RundeckClient
|
||||||
|
|
||||||
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
||||||
|
|
|
@ -3,9 +3,9 @@ h1. Java client for the RunDeck REST API
|
||||||
|
|
||||||
h2. What is it ?
|
h2. What is it ?
|
||||||
|
|
||||||
A Java library that maps the [RunDeck|http://rundeck.org] HTTP REST API. RunDeck is an open-source tool for automating tasks on multiple nodes, with a CLI, a web-based interface and an HTTP REST API. You can read more about its API on the [RunDeck User Manual|http://rundeck.org/docs/RunDeck-Guide.html#rundeck-api].
|
A Java client (library) for the [RunDeck|http://rundeck.org] HTTP REST API.
|
||||||
|
|
||||||
This library has been extracted from the [Jenkins RunDeck plugin|http://wiki.jenkins-ci.org/display/JENKINS/RunDeck+Plugin], so for the moment it is still incomplete (not all the RunDeck API is mapped). My goal is to have a complete mapping of the RunDeck API, and to publish the library on the [Maven Central Repository|http://search.maven.org/], so that it can easily be used by Java ([Maven|http://maven.apache.org]) and Groovy ([Grape|http://groovy.codehaus.org/Grape]) developers.
|
RunDeck is an open-source tool for automating tasks on multiple nodes, with a CLI, a web-based interface and an HTTP REST API. You can read more about its API on the [RunDeck User Manual|http://rundeck.org/docs/RunDeck-Guide.html#rundeck-api].
|
||||||
|
|
||||||
h2. What can I do with it ?
|
h2. What can I do with it ?
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue