Ansible Tutorial 18: Sharing Roles with Ansible Galaxy

In the previous article, we explored how to create and use Ansible roles. This article focuses on sharing and consuming community-developed roles via Ansible Galaxy—a powerful platform that enables developers to publish their roles while providing users with a vast library of ready-to-use roles, significantly improving efficiency in configuration management and automated deployments.

What Is Ansible Galaxy?

Ansible Galaxy is a public role repository that helps users discover, share, and reuse Ansible roles. With Galaxy, you can easily integrate community-authored roles into your projects—saving substantial time on development and maintenance.

How to Use Ansible Galaxy to Fetch Roles

Fetching roles is straightforward. Follow these steps:

1. Install Ansible Galaxy: Ensure Ansible is installed. You can install it using:

   pip install ansible
   

   Then use the ansible-galaxy command-line tool to manage roles.

2. Search for Roles: You can search roles either through the web interface (Ansible Galaxy Website) or directly from the command line. For example, to search for nginx-related roles:

   ansible-galaxy search nginx
   

3. Download a Role: Once you’ve identified a suitable role, download it with:

   ansible-galaxy install <role_name>
   

   For instance, if you locate the role geerlingguy.nginx, run:

   ansible-galaxy install geerlingguy.nginx
   

   This downloads the role to the default directory: ~/.ansible/roles/.

Configuring and Using Downloaded Roles

After downloading a role, reference it in your Ansible playbook. Here’s an example using the nginx role:

---
- hosts: web_servers
  become: true
  roles:
    - geerlingguy.nginx

In this example, the geerlingguy.nginx role is applied to the web_servers host group. The role automatically configures Nginx according to its defined tasks.

Creating and Sharing Your Own Role

If you’ve built a useful role and wish to share it with others, follow these steps to publish it on Ansible Galaxy:

1. Prepare Your Role: Ensure your role has a complete structure—including essential files like README.md and meta/main.yml.

2. Create an Ansible Galaxy Account: If you don’t yet have one, sign up at Galaxy.ansible.com, then log in via CLI:

   ansible-galaxy login
   

3. Upload Your Role Using the Galaxy CLI: Run the following command to publish your role:

   ansible-galaxy import <your_username> <role_name>
   

   Your role will now be publicly available on Galaxy for others to download and use.

Hands-On Example: Deploying Nginx for a Web Application

Suppose you want to deploy Nginx for your web application—and plan to leverage a Galaxy-provided role for configuration. Below is a complete playbook example:

---
- hosts: web_servers
  become: true
  roles:
    - geerlingguy.nginx

  handlers:
    - name: restart nginx
      service:
        name: nginx
        state: restarted

Running the Playbook

Execute the playbook using:

ansible-playbook deploy_nginx.yml

Make sure your target hosts are properly configured in your inventory and SSH access is set up beforehand.

Upon successful execution, Nginx should be installed, started, and serving your web application.

Summary

By leveraging Ansible Galaxy, you can rapidly acquire high-quality, community-vetted roles—dramatically accelerating your automation workflows. Publishing your own roles contributes back to the ecosystem, enabling knowledge sharing and collective improvement. In our next article, we’ll explore common real-world use cases—covering system administration and automated deployment scenarios—to deepen your mastery of Ansible. Stay tuned!