Merge pull request #3 from AobaIwaki123/iwaki/lint-ansible

Ansible Lint Workflowを追加

.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+# .github/workflows/ansible-lint.yml
+name: ansible-lint
+run-name: Ansible Lint
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'roles/**'
+      - 'playbooks/**'
+jobs:
+  build:
+    name: Ansible Lint # Naming the build is important to use it as a status check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run ansible-lint
+        uses: ansible/ansible-lint@main
+        with:
+          setup_python: "true"
+          working_directory: ${{ github.workspace }}

Makefile

@@ -1,7 +1,19 @@
 ROLE_NAME ?= default_env
+HOST_NAME ?= ""
+TAG_NAME ?= ""
 
 role:
 	@ansible-galaxy init roles/$(ROLE_NAME)
 
 ping:
 	@ansible -i inventory/hosts all -m ping
+
+check-diff:
+	@ansible-playbook -i inventory/hosts site.yml --check --diff --limit $(HOST_NAME) --tags $(TAG_NAME)
+
+apply-role:
+	@ansible-playbook -i inventory/hosts site.yml --limit $(HOST_NAME) --tags $(TAG_NAME)
+
+clean-branch:
+	@git remote prune origin
+	@git branch | xargs git branch -d

README.md

@@ -1,42 +1,43 @@
+[![ansible-lint](https://github.com/AobaIwaki123/ansible/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/AobaIwaki123/ansible/actions/workflows/lint.yml)
+
 # 自宅サーバーの構成管理用のAnsible
 
 ## Envirionment
 
+- Conda: 24.9.2
 - Python: 3.13.0
 - Ansible: 11.0.0, https://github.com/ansible/ansible
   - Ansible Core: 2.18.0
 
-## Ansible Roleの作成
+## Ansible Roleの雛形の作成
 
 ```sh
 $ make role ROLE_NAME=role_name
 ```
 
-## 接続先サーバーへの接続確認
+## 疎通確認
 
 ```sh
 $ make ping
 ```
 
-## Playbookの実行
+## Ansible Playbookの実行
 
-- Check Diff After Running Playbook with Tags
+### Roleの実行前に差分を確認
 
 ```sh
-$ ansible-playbook -i inventory/hosts site.yml --check --diff --tags init-vm
+$ make check-diff TAG_NAME={TAG_NAME} # Tagを指定して実行
+$ make check-diff HOST_NAME={HOST_NAME} # Hostを指定して実行
 ```
 
-- Apply Playbook with Tags
+### Roleの実行
 
 ```sh
-$ ansible-playbook -i inventory/hosts site.yml --tags init-vm
+$ make apply-role TAG_NAME={TAG_NAME} # Tagを指定して実行
+$ make apply-role HOST_NAME={HOST_NAME} # Hostを指定して実行
 ```
 
-- Limit Host to apply Ansible Playbook
-
-```sh
-$ ansible-playbook -i inventory/hosts site.yml --limit {HOSTNAME}
-## Show All Ansible Facts
+## Ansible Factsを全て表示するタスク
 
 ```yaml
 - name: Print all available facts

docs/ansible-cmd.md

@@ -23,3 +23,9 @@ $ ansible-playbook -i inventory/hosts site.yml --check --diff --tags init-vm
 ```sh
 $ ansible-playbook -i inventory/hosts site.yml --tags init-vm
 ```
+
+- Limit Host to apply Ansible Playbook
+
+```sh
+$ ansible-playbook -i inventory/hosts site.yml --limit {HOSTNAME}
+```

playbooks/init-lxc/playbook.yml

@@ -2,6 +2,6 @@
 - name: Initialize LXC
   hosts: proxmox_lxc
   roles:
-    - {role: basic-apt-package, apt_upgrade: false}
-    - default-configs
-    - install-docker
+    - {role: basic_apt_package, basic_apt_package_apt_upgrade: false}
+    - default_configs
+    - install_docker

playbooks/init-vm/playbook.yml

@@ -2,4 +2,4 @@
 - name: Initialize VM
   hosts: proxmox_vm
   roles:
-    - basic-apt-package # 必須のパッケージをインストール
+    - basic_apt_package # 必須のパッケージをインストール

roles/basic_apt_package/tests/test.yml

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: MIT-0
+---
+- name: Test basic_apt_package role
+  hosts: localhost
+  remote_user: root
+  roles:
+    - basic_apt_package

roles/default_configs/tests/test.yml

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: MIT-0
+---
+- name: Test default_configs role
+  hosts: localhost
+  remote_user: root
+  roles:
+    - default_configs

roles/install-docker/README.md → roles/install_docker/README.md

@@ -2,4 +2,4 @@
 
 ## Ref
 
-- https://medium.com/@GarisSpace/how-to-install-docker-using-ansible-01a674086f8c
+- https://medium.com/@GarisSpace/how-to-install_docker-using-ansible-01a674086f8c

roles/install_docker/defaults/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# defaults file for roles/install_docker

roles/install_docker/handlers/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# handlers file for roles/install_docker

roles/install-tailscale/meta/main.yml → roles/install_docker/meta/main.yml

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: MIT-0
 galaxy_info:
-  author: your name
-  description: your role description
-  company: your company (optional)
+  author: AobaIwaki
+  description: Install Docker
+  company: ""
 
   # If the issue tracker for your role is not on github, uncomment the
   # next line and provide a value
@@ -15,9 +15,9 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
-  min_ansible_version: 2.1
+  min_ansible_version: '2.1'
 
   # If this a Container Enabled role, provide the minimum Ansible Container version.
   # min_ansible_container_version:

roles/install-docker/tasks/main.yml → roles/install_docker/tasks/main.yml

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT-0
 ---
-# tasks file for roles/install-docker
+# tasks file for roles/install_docker
 - name: Install prerequisites for Docker repository
   become: true
   ansible.builtin.apt:

roles/install_docker/tests/test.yml

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: MIT-0
+---
+- name: Test install_docker role
+  hosts: localhost
+  remote_user: root
+  roles:
+    - install_docker

roles/install-docker/vars/main.yml → roles/install_docker/vars/main.yml

@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: MIT-0
 ---
-# vars file for roles/install-docker
+# vars file for roles/install_docker

roles/install_tailscale/defaults/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# defaults file for roles/install_tailscale

roles/install_tailscale/handlers/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# handlers file for roles/install_tailscale

roles/install-docker/meta/main.yml → roles/install_tailscale/meta/main.yml

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: MIT-0
 galaxy_info:
-  author: your name
-  description: your role description
-  company: your company (optional)
+  author: AobaIwaki
+  description: Install Tailscale
+  company: ""
 
   # If the issue tracker for your role is not on github, uncomment the
   # next line and provide a value
@@ -15,9 +15,9 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
-  min_ansible_version: 2.1
+  min_ansible_version: '2.1'
 
   # If this a Container Enabled role, provide the minimum Ansible Container version.
   # min_ansible_container_version:

roles/install_tailscale/tasks/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# tasks file for roles/install_tailscale

roles/install_tailscale/tests/test.yml

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: MIT-0
+---
+- name: Test install_tailscale role
+  hosts: localhost
+  remote_user: root
+  roles:
+    - install_tailscale

roles/install_tailscale/vars/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# vars file for roles/install_tailscale

roles/setup_exporter/defaults/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# defaults file for roles/setup_exporter

roles/setup_exporter/handlers/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# handlers file for roles/setup_exporter

roles/setup-exporter/meta/main.yml → roles/setup_exporter/meta/main.yml

@@ -1,8 +1,8 @@
 # SPDX-License-Identifier: MIT-0
 galaxy_info:
-  author: your name
-  description: your role description
-  company: your company (optional)
+  author: AobaIwaki
+  description: Setup Prometheus Node Exporter
+  company: ""
 
   # If the issue tracker for your role is not on github, uncomment the
   # next line and provide a value
@@ -15,9 +15,9 @@ galaxy_info:
   # - GPL-3.0-only
   # - Apache-2.0
   # - CC-BY-4.0
-  license: license (GPL-2.0-or-later, MIT, etc)
+  license: MIT
 
-  min_ansible_version: 2.1
+  min_ansible_version: '2.1'
 
   # If this a Container Enabled role, provide the minimum Ansible Container version.
   # min_ansible_container_version:

roles/setup_exporter/tasks/main.yml

@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: MIT-0
+---
+# tasks file for roles/setup_exporter

roles/setup_exporter/tests/test.yml

@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: MIT-0
+---
+- name: Test setup_exporter role
+  hosts: localhost
+  remote_user: root
+  roles:
+    - setup_exporter

roles/setup-exporter/vars/main.yml → roles/setup_exporter/vars/main.yml

@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: MIT-0
 ---
-# vars file for roles/setup-exporter
+# vars file for roles/setup_exporter