{"id":21085439,"url":"https://github.com/magec/puppetlabs-consul_inventory","last_synced_at":"2025-03-14T05:14:04.380Z","repository":{"id":66829740,"uuid":"248748854","full_name":"magec/puppetlabs-consul_inventory","owner":"magec","description":"Bolt inventory plugin for consul","archived":false,"fork":false,"pushed_at":"2020-04-08T04:31:57.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-21T00:17:45.571Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-20T12:22:40.000Z","updated_at":"2020-04-08T04:31:59.000Z","dependencies_parsed_at":"2023-05-04T06:04:27.607Z","dependency_job_id":null,"html_url":"https://github.com/magec/puppetlabs-consul_inventory","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fpuppetlabs-consul_inventory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fpuppetlabs-consul_inventory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fpuppetlabs-consul_inventory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magec%2Fpuppetlabs-consul_inventory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magec","download_url":"https://codeload.github.com/magec/puppetlabs-consul_inventory/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243526942,"owners_count":20305115,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T20:33:18.251Z","updated_at":"2025-03-14T05:14:04.349Z","avatar_url":"https://github.com/magec.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# consul_inventory\n\n#### Table of Contents\n\n1. [Description](#description)\n2. [Requirements](#requirements)\n3. [Installation](#installation)\n4. [Usage](#usage)\n\n## Description\n\nThis module includes a Bolt plugin to generate Bolt targets from a consul servers.\n\n## Requirements\n\nThis module have two requirements [`diplomat`](https://rubygems.org/gems/diplomat) and [`net-ssh-gateway`](https://rubygems.org/gems/net-ssh-gateway). You need to install them\nmanually using bolt's gem command.\n\n```\n/opt/puppetlabs/bolt/bin/gem install diplomat net-ssh-gateway\n```\n\n## Installation\n\nAdd this line to your Puppetfile:\n\n```\nmod 'puppetlabs-consul_inventory', :git =\u003e 'https://github.com/magec/puppetlabs-consul_inventory.git'\n```\n\nand execute:\n\n```\n$ bolt puppetfile install\n```\n\n\n## Usage\n\nThe Consul plugin support these config attributes.\n\n- `host`: Consul host\n- `port`: Consul port\n- `use_hostname`: Set this to true if you want your targets to be added using Consul node name instead of ip address.\n- `bastion_host`: If consul is behind a firewall (odds are that this would be the case), you can specify a bastion host to connect to, before connecting to consul (proxyjump).\n- `bastion_user`: User to use to connect to bastion host.\n- `bastion_ssh_options`: Ssh options to use for connecting to bastion host.\n\n### Examples\n\n`inventory.yaml`\n```yaml\ngroups:\n  - name: nodes\n    targets:\n      - _plugin: consul_inventory\n        host: localhost\n        port: 8500\n        bastion_host: gateway.example.com\n        bastion_user: user\n    config:\n      ssh:\n        user: user\n        proxyjump: user@gateway.example.com\n        host-key-check: false\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagec%2Fpuppetlabs-consul_inventory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagec%2Fpuppetlabs-consul_inventory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagec%2Fpuppetlabs-consul_inventory/lists"}