Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenpau/go-ansible-db
Ansible Inventory and Vault management client library written in Go.
https://github.com/greenpau/go-ansible-db
ansible ansible-inventory ansible-vars ansible-vault ansible-vault-utility golang golang-library golang-package
Last synced: about 1 month ago
JSON representation
Ansible Inventory and Vault management client library written in Go.
- Host: GitHub
- URL: https://github.com/greenpau/go-ansible-db
- Owner: greenpau
- License: apache-2.0
- Created: 2018-12-12T20:34:19.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T00:31:10.000Z (about 1 year ago)
- Last Synced: 2024-05-23T00:34:55.802Z (6 months ago)
- Topics: ansible, ansible-inventory, ansible-vars, ansible-vault, ansible-vault-utility, golang, golang-library, golang-package
- Language: Go
- Size: 38.1 KB
- Stars: 17
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-ansible-db
[](https://goreportcard.com/report/github.com/greenpau/go-ansible-db)
Ansible Inventory and Vault management client library written in Go.
## Table of Contents
* [Overview](#overview)
* [Getting Started](#getting-started)
* [Inventory Search](#inventory-search)
## Overview
Ansible inventory and secrets management is being handled well by native
Ansible tools. The inventory format is well defined and the vault usage
is well understood. Ansible is written in Python and therefore integrates
nicely with Python code.
What happens when a user wants to read inventory and secrets for use in
Go applications?
This library allows:
* Reading Ansible ini-style inventory files
* Reading Ansible vault files
* Getting Ansible variables for a host or a group of hosts
* Getting Ansible secrets (credentials) for a host or a group of hosts
## Getting Started
To demonstrate the use of the library, please consider the following files:
* `assets/inventory/hosts`: Ansible inventory file
* `assets/inventory/vault.yml`: Ansible vault file
* `assets/inventory/vault.key`: The file with the password for the vault
The following code snippet would load the inventory and vault content.
```golang
invFile := "../../assets/inventory/hosts"
vltFile := "../../assets/inventory/vault.yml"
vltKeyFile := "../../assets/inventory/vault.key"
// Create a new inventory file.
inv := NewInventory()
// Load the contents of the inventory from an input file.
if err := inv.LoadFromFile(invFile); err != nil {
t.Fatalf("error reading inventory: %s", err)
}
// Create a new vault file.
vlt := NewVault()
// Read the password for the vault file from an input file.
if err := vlt.LoadPasswordFromFile(vltKeyFile); err != nil {
t.Fatalf("error reading vault key file: %s", err)
}
// Load the contents of the vault from an input file.
if err := vlt.LoadFromFile(vltFile); err != nil {
t.Fatalf("error reading vault: %s", err)
}
```
## Inventory Search
After that, the code retrieves the inventory record for `ny-sw01` and makes
a subsequent call to retrieve the credentials for accessing `ny-sw01`.
```golang
h := "ny-sw01"
host, err := inv.GetHost(h)
if err != nil {
t.Fatalf("error getting host %s from inventory: %s", h, err)
}
creds, err := vlt.GetCredentials(host.Name)
if err != nil {
t.Fatalf("error getting credentials for host %s: %s", host.Name, err)
}
```