forked from ohioit/rundeck-http-plugin
-
Notifications
You must be signed in to change notification settings - Fork 15
Update and clean up readme #66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,32 @@ | ||
| # Rundeck HTTP Workflow Step Plugin | ||
| This plugin provides a way to send HTTP requests as part of | ||
| a [Rundeck](http://rundeck.org) workflow step. It is somewhat | ||
| based on https://github.com/rvs-fluid-it/rundeck-httppost-plugin. | ||
|
|
||
| [](https://travis-ci.org/ohioit/rundeck-http-plugin) [](https://www.versioneye.com/user/projects/561e86d336d0ab00160001a9) [](http://codecov.io/github/ikogan/rundeck-http-plugin?branch=master) [](https://scan.coverity.com/projects/ikogan-rundeck-http-plugin) | ||
| This plugin provides a way to send HTTP requests as a workflow step or | ||
| node step in a [Rundeck](https://rundeck.org) job. | ||
|
|
||
| This plugin is bundled with the Rundeck application, so no separate | ||
| installation is required. It is built and maintained as part of the | ||
| [rundeck/rundeck](https://github.com/rundeck/rundeck) project. | ||
|
|
||
| ## Features | ||
|
|
||
| - GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS | ||
| - Authentication: BASIC or OAuth 2.0 | ||
| - HTTP methods: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS | ||
| - Authentication: Basic, Bearer Token, or OAuth 2.0 (Client Credentials Grant) | ||
| - Project or Framework level configuration | ||
| - Support for Self Signed SSL Certificates | ||
| - Support for self-signed SSL certificates | ||
|
|
||
| ## Usage | ||
|
|
||
| Add "HTTP Workflow Step" or "HTTP Node Step" to a job as a workflow step | ||
| or node step, and configure the URL, method, headers, body, and | ||
| authentication as needed. | ||
|
|
||
| See the [HTTP Request Workflow Step documentation](https://docs.rundeck.com/docs/manual/jobs/job-plugins/workflow-steps/http-request.html) | ||
| for full reference on this plugin's options. | ||
|
|
||
| ## Caveats | ||
|
|
||
| OAuth 2.0 only supports the Client Credentials Grant Type. The OAuth | ||
| configuration is per-project or per-framework. This means that each job | ||
| will share the entire project or entire frameworks credentials. However, | ||
| this allows those credentials to be externalized into the framework | ||
| configuration and avoids them being exported with projects. | ||
|
|
||
| ## Todo | ||
|
|
||
| - Support request parameters from config and/or data | ||
| will share the entire project's or entire framework's credentials. | ||
|
gschueler marked this conversation as resolved.
|
||
| However, this allows those credentials to be externalized into the | ||
| framework configuration and avoids them being exported with projects. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.