mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-09 14:39:09 +00:00
website update
This commit is contained in:
parent
09307e83c6
commit
3a17ffafb1
6 changed files with 22 additions and 7 deletions
|
@ -11,7 +11,9 @@ Alternatively, you can download [releases|https://oss.sonatype.org/content/repos
|
|||
|
||||
h2. Manual download
|
||||
|
||||
If you want to use this library from a [scripting language|./scripting.html], it is often easier to download a single *jar* file with all dependencies included.
|
||||
If you want to use this library from a [scripting language|./scripting.html], it is often easier to download a single *jar* file with all dependencies included (named "*rundeck-api-java-client-VERSION-jar-with-dependencies.jar *")
|
||||
|
||||
You can download such files on GitHub : [https://github.com/vbehar/rundeck-api-java-client/downloads]
|
||||
You can download such files on GitHub : [https://github.com/vbehar/rundeck-api-java-client/downloads] (for each release)
|
||||
|
||||
You can also download the latest version (not yet released) on Jenkins : [https://rundeck-api-java-client.ci.cloudbees.com/job/master/lastSuccessfulBuild/artifact/target/]
|
||||
|
||||
|
|
|
@ -3,18 +3,30 @@ h1. Java client for the RunDeck REST API
|
|||
|
||||
h2. What is it ?
|
||||
|
||||
A Java client (library) for the [RunDeck|http://rundeck.org] HTTP REST API.
|
||||
A Java client (library) for the RunDeck 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].
|
||||
[RunDeck|http://rundeck.org/] 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].
|
||||
|
||||
!images/rundeck.png!
|
||||
|
||||
h2. What can I do with it ?
|
||||
|
||||
* Use it to write [scripts|./scripting.html] (in [Groovy|./groovy.html], [JRuby|./jruby.html] or [Jython|./jython.html]), for example if you want to automate the execution of RunDeck jobs based on external events.
|
||||
* Use it in a Java application. A good example would be the [Jenkins RunDeck plugin|http://wiki.jenkins-ci.org/display/JENKINS/RunDeck+Plugin], that needs to trigger RunDeck jobs from within the [Jenkins|http://jenkins-ci.org] continuous-integration server.
|
||||
* Use it in a Java application. A good example would be the [Jenkins RunDeck plugin|http://wiki.jenkins-ci.org/display/JENKINS/RunDeck+Plugin], that needs to trigger RunDeck jobs from within the [Jenkins|http://jenkins-ci.org] continuous-integration server. Or the [RunDeck Remote CLI|https://github.com/vbehar/rundeck-remote-cli], that provides a java-based CLI on top of the API.
|
||||
|
||||
h2. Where can I get more information ?
|
||||
|
||||
* You can read the [API documentation|./apidocs/index.html], starting with the [RundeckClient|./apidocs/org/rundeck/api/RundeckClient.html] class.
|
||||
* And the code is available on [GitHub|https://github.com/vbehar/rundeck-api-java-client].
|
||||
* The Maven auto-generated pages : [project information|./project-info.html] and [project reports|./project-reports.html].
|
||||
* Or you can "Use the [Source|./source-repository.html], Luke !"
|
||||
* Read more on the Maven auto-generated pages : [project information|./project-info.html] and [project reports|./project-reports.html].
|
||||
|
||||
h2. Thanks to...
|
||||
|
||||
* [GitHub|https://github.com] for the [source code|./source-repository.html] and [website|./index.html] hosting
|
||||
* [CloudBees|http://cloudbees.com] for the [continuous integration|./integration.html] hosting
|
||||
* [Sonatype|http://www.sonatype.com] for the [Nexus repository|./distribution-management.html] hosting (and sync to Maven Central)
|
||||
|
||||
!images/github.png!
|
||||
|
||||
!images/cloudbees.png!
|
||||
|
||||
|
|
|
@ -5,6 +5,7 @@ h2. RunDeck API version 1
|
|||
|
||||
[Documentation of the RunDeck API version 1|http://rundeck.org/1.2.1/RunDeck-Guide.html#rundeck-api]
|
||||
|
||||
* Login-based authentication - OK
|
||||
* System Info - OK
|
||||
* Listing Jobs - OK
|
||||
* Running a Job - OK
|
||||
|
|
BIN
src/site/resources/images/cloudbees.png
Normal file
BIN
src/site/resources/images/cloudbees.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
BIN
src/site/resources/images/github.png
Normal file
BIN
src/site/resources/images/github.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.9 KiB |
BIN
src/site/resources/images/rundeck.png
Normal file
BIN
src/site/resources/images/rundeck.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4 KiB |
Loading…
Add table
Add a link
Reference in a new issue