https://github.com/adieu/cue-ansible

Write Ansible playbooks in CUE
https://github.com/adieu/cue-ansible

ansible cue cuelang

Last synced: about 12 hours ago
JSON representation

Write Ansible playbooks in CUE

• Host: GitHub
• URL: https://github.com/adieu/cue-ansible
• Owner: adieu
• Created: 2019-11-21T15:48:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-15T16:41:12.000Z (over 4 years ago)
• Last Synced: 2024-08-02T17:33:10.705Z (3 months ago)
• Topics: ansible, cue, cuelang
• Language: Go
• Homepage:
• Size: 8.35 MB
• Stars: 34
• Watchers: 7
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-cue - cue-ansible - Write Ansible Playbooks in CUE --> (Projects)

README

        
# cue-ansible

Write Ansible Playbooks in CUE

## Why

Users write YAML files for [Ansible](https://www.ansible.com/). The experience could be enhanced using

[CUE](https://cuelang.org/) with package importing, schema validation and more.

This repo provides you ready to use CUE packages for schema validation and guidance on

how to integrate CUE with Ansible.

I created this project to get my hands dirty with CUE by putting it into a real usecase.

You can use this repo as a reference to rewrite your Ansible Playbooks in CUE

or learn some basic usage pattern of CUE.

## Installation

You should install Ansible and CUE before using this repo. Some features are not

included in the latest release of CUE. So please install CUE with

`go get -u cuelang.org/go/cmd/cue`.

## Write Playbook

Create a new folder called `playbook` and write your playbook in CUE. You could

use [example](https://github.com/adieu/cue-ansible/blob/master/example/playbook.cue)

as a reference.  It's almost the same like writing the playbook in YAML but you

could use CUE to organize your code in packages and use module schemas to validate

the task options.

## Run Playbook

`cue cmd play ./playbook` will eval your playbook and write the result to `playbook.yml`.

Then `ansible-playbook` will be executed to run the playbook as well.

You can put your legacy YAML based tasks in `roles` folder and use `include_role`

module to load them in your playbook. In this way, you can migrate from YAML

to CUE gradually.

## Reference

 - [CUE Homepage](https://cuelang.org/)

 - [CUE Repository on GitHub](https://github.com/cuelang/cue)

 - [CUE Documents](https://cuelang.org/docs/)