puppet-graphql

This module provides a helper function to retrieve information from a GraphQL endpoint during catalog compilation.

Table of Contents

1. Description
2. Setup - The basics of getting started with graphql
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

This module has been implemented mainly for the use-case of retrieving IP addresses from Netbox IPAM. But it can be used for any kind of GraphQL HTTP API.

Setup

This module only needs Ruby's built-in NEt::HTTP library. No further setup needed

Usage

Currently there is only a single function you can use in your puppet code:

$query = @(EOT)
    {
      site_list {
        id,
        slug,
        name,
      }
    }
    | EOT

$result = graphql::graphql_query({
    'url'     => 'https://netbox.tld/graphql/',
    'headers' => { 'Authorization' => "Token somenetboxtoken" },
    'query'   => $query,
})

# $result could be undef in case an error occured
# the error will be logged to the puppetserver logs and a notify resource will be created
if $result {
  $my_sites = $result['data']['site_list']
}


# ...

Limitations

This functions in this module - as all Puppet functions - can only be executed on the puppetmaster host during catalog compile time.

Development

Pull requests welcome.

If you submit a change to this module, be sure to regenerate the reference documentation as follows:

puppet strings generate --format markdown --out REFERENCE.md

Reference

Table of Contents

Functions

• graphql::graphql_query: Query a GraphQL API via HTTP.

Functions

graphql::graphql_query

Type: Ruby 4.x API

Query a GraphQL API via HTTP.

graphql::graphql_query(Hash[String[1], Any] $opts)

Query a GraphQL API via HTTP.

Returns: Optional[Hash] A hash containing the response data or nil when an error occurred.

opts

Data type: Hash[String[1], Any]

A Hash with the keys url (value String), headers (value Hash) and query (value String).

Changelog

v0.1.2 (2022-11-25)

Full Changelog

Merged pull requests:

• Remove graphql-client dependency #3 (phihos)

v0.1.1 (2022-11-07)

Full Changelog

v0.1.0 (2022-10-20)

Full Changelog

Merged pull requests:

• More tests and docs #2 (phihos)
• Fix CI pipeline #1 (phihos)

* This Changelog was automatically generated by github_changelog_generator