playbooks endpoint, socket to tcp

Author: lfkdev

CHANGELOG.md

@@ -1,7 +1,5 @@
 #### General 🚀
-- Install script now sets up a production-ready installation of ansible-link
-  - Fetches the latest version of ansible-link from GitHub
-  - Includes Gunicorn for handling requests
-  - Configures Unix sockets for communication
-  - Sets up a Python virtual environment (venv)
-- Updated README for install script instructions
+- Updated gunicorn to use TCP instead of socket
+- Minor fixes in README
+- `/available-playbooks` can now be used to query available playbooks (inkl. subdirs)
+- Added tests for `/available-playbooks`

README.md

@@ -34,11 +34,11 @@ Searched for a way to run our playbooks automated without the need of AWX or oth
 ## Installation
 The fastest way to set up Ansible-Link is by using the provided `install.sh` script:
 
-1. **Download and run the install script:**
-   ```shell
-   wget https://raw.githubusercontent.com/lfkdev/ansible-link/main/install.sh
-   sudo bash install.sh
-   ```
+**Download and run the install script:**
+```shell
+wget https://raw.githubusercontent.com/lfkdev/ansible-link/main/install.sh
+sudo bash install.sh
+```
 
 This script will:
 - Check for necessary dependencies and install them if missing.
@@ -134,18 +134,25 @@ You can use the install script `install.sh` to get a production-ready environmen
 The install script will:
 - Set up a Python VENV
 - Configure a systemd service to manage Ansible-Link
-- Utilize Gunicorn as the WSGI server.
+- Utilize Gunicorn as the WSGI server
+- Start Ansible-Link to liste only on localhost
 
 You can use a webserver like Caddy to add Basic Authentication and TLS to your Ansible-Link setup.
 
+Also, if you're using a webserver, you can change Gunicorn to use sockets instead. For example:
+```shell
+ExecStart=$VENV_DIR/bin/gunicorn --workers 1 --bind unix:$INSTALL_DIR/ansible_link.sock -m 007 wsgi:application
+```
+
+
 ### unitD example
 ```
 [Unit]
 Description=Ansible Link Service
 After=network.target
 
 [Service]
-ExecStart=$VENV_DIR/bin/gunicorn --workers 1 --bind unix:$INSTALL_DIR/ansible_link.sock -m 007 wsgi:application
+ExecStart=$VENV_DIR/bin/gunicorn --workers 1 --bind 127.0.0.1:$ANSIBLE_LINK_PORT wsgi:application
 WorkingDirectory=$INSTALL_DIR
 Restart=always
 User=root

install.sh

@@ -4,6 +4,7 @@
 set -e
 
 ANSIBLE_LINK_VERSION="2.1.1"
+ANSIBLE_LINK_PORT=5001
 INSTALL_DIR="/opt/ansible-link"
 TEMP_DIR="/tmp/ansible-link-install$RANDOM"
 VENV_DIR="$INSTALL_DIR/venv"
@@ -136,7 +137,7 @@ Description=Ansible Link Service
 After=network.target
 
 [Service]
-ExecStart=$VENV_DIR/bin/gunicorn --workers 1 --bind unix:$INSTALL_DIR/ansible_link.sock -m 007 wsgi:application
+ExecStart=$VENV_DIR/bin/gunicorn --workers 1 --bind 127.0.0.1:$ANSIBLE_LINK_PORT wsgi:application
 WorkingDirectory=$INSTALL_DIR
 Restart=always
 User=root
@@ -199,14 +200,14 @@ main() {
     update_config
     setup_service
     cleanup
-
+    echo
     log "INFO" "Ansible-Link has been installed and configured. ✔"
     log "INFO" "The service is running and will start automatically on boot. ✔"
     log "INFO" "You can check the status with: systemctl status ansible-link. ✔"
     log "WARN" "Ansible user defaults to root. ⚠"
     log "INFO" "Change the default values in $INSTALL_DIR/config.yml if needed."
     echo 
-    log "INFO" "To access Ansible-Link, go to: http://localhost:9090. ✔"
+    log "INFO" "To access Ansible-Link, go to: http://localhost:${ANSIBLE_LINK_PORT}. ✔"
 }
 
 main

src/ansible_link.py

@@ -56,6 +56,10 @@
     'errors': fields.List(fields.String, description='List of error messages, if any', allow_none=True)
 })
 
+available_playbooks_model = api.model('AvailablePlaybooks', {
+    'playbooks': fields.List(fields.String, description='List of available playbook paths')
+})
+
 def load_config():
     current_dir = Path(__file__).parent.absolute()
     default_config_path = current_dir / 'config.yml'
@@ -286,6 +290,20 @@ def get(self, job_id):
             api.abort(404, f"Job {job_id} not found")
         return job
 
+@ns.route('/available-playbooks')
+class AvailablePlaybooks(Resource):
+    @ns.marshal_with(available_playbooks_model)
+    def get(self):
+        playbook_dir = Path(config['playbook_dir'])
+        available_playbooks = []
+
+        for file in playbook_dir.glob('**/*.yml'):
+            relative_path = file.relative_to(playbook_dir)
+            if file.is_file() and (not compiled_whitelist or any(pattern.match(str(relative_path)) for pattern in compiled_whitelist)):
+                available_playbooks.append(str(relative_path))
+
+        return {'playbooks': available_playbooks}
+
 # simple healthcheck placeholder
 @app.route('/health')
 def health_check():

src/test_ansible_link.py

@@ -104,5 +104,17 @@ def test_job_creation_and_retrieval(self):
         for key in expected_keys:
             self.assertIn(key, file_data, f"Expected key '{key}' not found in job file")
 
+    def test_available_playbooks_endpoint(self):
+        response = self.client.get(f'{API_PATH}/ansible/available-playbooks')
+        self.assertEqual(response.status_code, 200)
+        data = json.loads(response.data)
+        self.assertIn('playbooks', data)
+        self.assertIsInstance(data['playbooks'], list)
+        
+        self.assertIn('test_playbook.yml', data['playbooks'], "test_playbook.yml is not in the list of available playbooks")
+        
+        for playbook in data['playbooks']:
+            self.assertTrue(playbook.endswith('.yml'), f"Playbook {playbook} does not end with .yml")
+
 if __name__ == '__main__':
     unittest.main()

src/version.py

@@ -1,4 +1,4 @@
-VERSION = "2.1.3"
+VERSION = "2.2.0"
 
 def get_version():
     return VERSION