BlueCat Networks Gateway Plugin
BlueCat Networks

This is a Plugin for Rundeck that provides the ability to call BlueCat Gateway endpoints from the Rundeck UI. This Plugin is built to utilize the rest_api workflow on Gateway versions 18.10.2 or greater. Prerequisites BlueCat Address Manager 3000 appliance


Rundeck BlueCat Gateway Plugin

This is a Plugin for Rundeck 3.0.8 that provides the ability to call BlueCat Gateway endpoints from the Rundeck UI. This Plugin is built to utilize the rest_api workflow on Gateway versions 18.10.2 or greater.

Prerequisites

  • BlueCat Address Manager 3000 appliance or greater running software version 8.2.0 or greater
  • BlueCat Gateway v18.10.2 or greater

Requirements

  • BlueCat Gateway has rest_api community workflow installed and permissioned properly
  • BlueCat Gateway container running
  • Rundeck Instance Running

Tutorial

  • Episode 3 of BlueCat's Making Gateway Work for You webinar series focuses on using Rundeck for scheduling workflows to enhance the efficiency of your organization’s DNS operations. In this episode, BlueCat’s Solution Consultant, Murtaza Haider, will walk you through the newly released integration between Gateway and Rundeck, an automated scheduling platform. Using example workflows, you’ll learn how to use Rundeck to schedule reports and easily change/revert IP objects. https://www.bluecatnetworks.com/resource/making-gateway-work-for-you-scheduling/

Installation

  1. Download and start Rundeck, or install the docker version <br /> <br />
  2. Download this repository as a .zip file <br /> <br />
  3. Drop it in your libext folder <br /> <br />
  4. Restart rundeck <br /> <br />

Installation via Docker

  1. If you are using Rundeck-docker you will need to mount a data volume to libext with: <br />
mkdir /plugins
docker run --name rundeck -v data:/home/rundeck/server/data -v /plugins:/home/rundeck/libext -p 4440:4440 -e RUNDECK_GRAILS_URL=http://<ip address of your host machine>:4440 rundeck/rundeck:3.0.8
  1. Copy the repo into a .zip file, then put the .zip file into /home/rundeck/libext with: <br />
docker cp rundeck-bluecat-gateway-plugin.zip rundeck:/home/rundeck/libext/
  1. Then restart the docker container with : <br />
docker stop rundeck 
docker rm rundeck 
docker run --name rundeck -v data:/home/rundeck/server/data -v /plugins:/home/rundeck/libext -p 4440:4440 -e RUNDECK_GRAILS_URL=http://<ip address of your host machine>:4440 rundeck/rundeck:3.0.8

Usage

  • Go to the webpage specificed by RUNDECK_GRAILS_URL in the docker command or where ever you configured it

  • On first login, use the credentials to log in <br /> Username: admin <br /> Password: admin

  • Create a Project then a job under the project

  • Select the gateway-workflow in the workflow tab

Screenshot3

  • When creating a job and fill in the boxes below

Alt Screenshot

  • NOTE: The additional data should always be in JSON format

Screenshot2

Documentation

  • For complete information on Rundeck refer to https://docs.rundeck.com/docs/