Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions README.md
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.

[![Build Status](https://travis-ci.org/rundeck-plugins/http-step.svg?branch=master)](https://travis-ci.org/ohioit/rundeck-http-plugin) [![Dependency Status](https://www.versioneye.com/user/projects/576036d1122a7600131e41b6/badge.svg?style=flat)](https://www.versioneye.com/user/projects/561e86d336d0ab00160001a9) [![Test Coverage](http://codecov.io/github/ikogan/rundeck-http-plugin/coverage.svg?branch=master)](http://codecov.io/github/ikogan/rundeck-http-plugin?branch=master) [![Coverty Scan](https://scan.coverity.com/projects/6665/badge.svg?flat=1)](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.
Comment thread
gschueler marked this conversation as resolved.

## 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.
Comment thread
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.
Loading