{"id":18562084,"url":"https://github.com/timstaley/ansible-tkp","last_synced_at":"2025-05-15T17:35:00.892Z","repository":{"id":144783548,"uuid":"48183686","full_name":"timstaley/ansible-tkp","owner":"timstaley","description":null,"archived":false,"fork":false,"pushed_at":"2015-12-17T16:58:22.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T12:45:28.993Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timstaley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-17T15:53:11.000Z","updated_at":"2015-12-17T15:53:42.000Z","dependencies_parsed_at":"2023-04-16T06:22:02.423Z","dependency_job_id":null,"html_url":"https://github.com/timstaley/ansible-tkp","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/timstaley%2Fansible-tkp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timstaley%2Fansible-tkp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timstaley%2Fansible-tkp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timstaley%2Fansible-tkp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timstaley","download_url":"https://codeload.github.com/timstaley/ansible-tkp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254388240,"owners_count":22063011,"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-06T22:08:43.623Z","updated_at":"2025-05-15T17:35:00.868Z","avatar_url":"https://github.com/timstaley.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Ansible Role Template\n======================\n\nA template role, adding Vagrant-testing support to the default Ansible-role\nskeleton.\n\nAnsible is a great tool, and trying things out with a virtual-machine is a\ngreat way to learn, try things out, and test changes. But if you're trying\nto learn Ansible and Vagrant/Virtualbox all at once, configuring a test-setup\njust right can be a steep learning curve. This template demonstrates how\nto set-up Vagrant to test your new Ansible role.\n\n\nNotes\n------\n*Vagrantfile* sets up a testing virtual-machine, named `roletestingvm`.\nThis should be renamed to something sensible for your role so you can\nrecognise it if you have multiple VM's up and running, e.g. when running::\n\n    vagrant global-status\n\n... to remind yourself where all your RAM went.\n\nThe *ansible.cfg* file is not strictly necessary, but allows you to specify\na central location for storing roles, and also makes it possible to run\nAnsible manually against your VM via the command line, rather than indirectly\nby re-running Vagrant commands - this can speed up testing.\nNote you will need to edit the `ssh_args` entry in *ansible.cfg*\nso that the path matches the name of your VM.\n\nFor the testing playbook (*tests/test-roletemplate.yml*) to work correctly,\nthe relative import path has to match the folder-name you've checked out this\nrepository under. So e.g. for the unmodified template to run correctly, you\nshould clone it using:\n\n    git clone git@github.com:timstaley/ansible-role-template.git roletemplate\n\nRequirements\n------------\n\n[Vagrant-cachier](http://fgrehm.viewdocs.io/vagrant-cachier/) is recommended,\nbut optional.\n\nThis template includes an ansible-galaxy requirements file that pulls in\nthe [timstaley.base](https://github.com/timstaley/ansible-base) role, used\nfor configuring basic utilities on a fresh virtual-machine.\nHowever, this is not a hard dependency, since users of a role may have their\nown preferences as to e.g. exactly how `pip` gets installed.\nTo retrieve a copy of the roles listed in a requirements file, run::\n\n    ansible-galaxy install -r requirements.txt\n\nor\n\n    ansible-galaxy install --force -r requirements.txt\n\nto forcibly update old copies.\n\nNote that *ansible.cfg* is configured such that roles will be installed under\n*~/.ansible_roles*.\n\nRole Variables\n--------------\n\nA description of the settable variables for this role should go here, including\nany variables that are in defaults/main.yml, vars/main.yml, and any variables\nthat can/should be set via parameters to the role. Any variables that are read\nfrom other roles and/or the global scope (ie. hostvars, group vars, etc.) should\nbe mentioned here as well.\n\nDependencies\n------------\n\nA list of other roles hosted on Galaxy should go here, plus any details in\nregards to parameters that may need to be set for other roles, or variables that\nare used from other roles.\n\nExample Playbook\n----------------\n\nIncluding an example of how to use your role (for instance, with variables\npassed in as parameters) is always nice for users too:\n\n    - hosts: servers roles: - { role: username.rolename, x: 42 }\n\nLicense\n-------\n\nBSD\n\nAuthor Information\n------------------\n\nAn optional section for the role authors to include contact information, or a\nwebsite (HTML is not allowed).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimstaley%2Fansible-tkp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimstaley%2Fansible-tkp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimstaley%2Fansible-tkp/lists"}