Devops - 1 ( Ansible, Github Action )

HD.Y·2024년 2월 19일

한화시스템 BEYOND SW

목록 보기

55/58

Ansible (앤서블) 이란❓

앤서블(Ansible)은 리눅스와 유닉스 기반 시스템의 설정 및 배포 작업을 자동화하기 위한 IT 자동화 도구 중 하나이다. 앤서블은 에이전트(agent)가 필요하지 않으며, YAML 형식으로 작성된 Playbook을 사용하여 간단하게 배포 작업을 수행할 수 있다.

또한 멱등성 ( Idempotency, 여러 번 적용해도 결과가 동일하며, 수정된 부분이 있다면 그 부분만 새롭게 반영됨 )의 특징이 있으며, 데이터 전송을 위해 OpenSSH를 이용한다.

➡ 에이전트란❓

다른 프로그램 또는 시스템과 통신하여 작업을 수행하거나 정보를 수집하는 소프트웨어이다. 클라이언트가 서버에 요청을 보내고, 서버는 그 요청에 따라 작업을 수행하고 결과를 반환하는데 에이전트는 이러한 요청을 받아서 작업을 수행하는 프로그램을 말한다.

하지만, 앤서블은 SSH를 통해 원격 시스템에 연결 및 관리하므로, 에이전트를 설치하거나 구성할 필요가 없다.

Ansible의 기본 개념 및 용어 🧐

제어 노드(Control node) ✅
➡ 앤서블을 실행하는 노드이다. 제어 노드에서 명령어로 매니지드 노드들을 관리한다.
매니지드 노드(Managed node) ✅
➡ 앤서블로 관리하는 서버 노드이다. 매니지드 노드는 호스트라고도 한다.
　매니지드 노드에는 앤서블이 설치 되지 않는다.

인벤토리(Inventory) ✅
➡ 호스트 파일이라고도 하며, 매니지드 노드 목록을 인벤토리라고 한다.
➡ 앤서블에 의해 제어될 대상을 정의한다. 각 매니지드 노드에 대한 IP 주소,
　호스트 정보, 변수와 같은 정보를 지정할 수 있다.

➡ 인벤토리 yaml 파일의 예시는 아래와 같다. 💻

all:
 hosts:                // 그룹을 구성하기 위한 모든 서버의 IP 지정
   77.77.77.200:   
   77.77.77.201:
   77.77.77.202:
 children:
   webservers:         // 이름 짓기 나름 ( 그룹 이름 )
     hosts:            // 웹서버가 2개라면 아래처럼 2개 적을 수 있음. 여러개 가능
       77.77.77.200:
       77.77.77.201:
   dbservers:          // 이름 짓기 나름 ( 그룹 이름 )
     hosts:
       77.77.77.202:

플레이북(Playbook) ✅

➡ 플레이북은 인벤토리 파일에서 정의한 대상들이 무엇을 수행할 것인지 정의하는
　역할을하며, yaml 파일 형식으로 작성한다.

➡ 앤서블을 사용하려면 이 플레이북을 잘 다룰줄 알아야하며, 단독으로 사용되는 것이
　아닌 인벤토리와 플레이북의 조합으로 같이 사용한다.

➡ 왠만한 명령어에 대한 플레이북은 홈페이지에서 찾아볼 수 있으며, 만약 없다면
　shell 을 사용하여 명령어를 실행시킬 수 있다.

➡ 플레이북 yaml 파일의 예시는 아래와 같다.

- hosts: ["77.77.77.200"]
  tasks:
    - name: define hostname   // 적절한 이름 임의 지정
      shell: |                // 플레이북 명령어가 없을 때 명령어를 직접 칠때 사용
        hostnamectl set-hostname worker03
      become: yes             // 관리자 권한으로 실행 의미
    - name: stop firewalld    // 플레이북 명령어 사용
      service:
        name: firewalld
        state: stopped

태스크(Task) ✅
➡ 앤서블의 작업 단위. 애드훅(ad-hoc)명령을 사용하여 단일 작업을 한 번
　실행할 수 있다.
모듈(Module) ✅
➡ 앤서블이 실행하는 코드 단위. 플레이북에서 Task가 어떻게 수행될지를 정한다.

🦁 Ansible 을 사용하기 위한 기본 설정

앤서블은 SSH로 제어노드와 매니지드 노드가 연결된다.
따라서, 앤서블을 사용하기 전에 각 서버에 authorized_keys 를 추가해준다.
나는 CentOS 8 가상머신 2대를 준비해놨다. ( IP 설정 완료 )
➡ 매니지드 노드 : nginx / 제어 노드 : ansible

1. 제어 노드에서 SSH로 접속한다 : ssh root@[ 매니지드 노드 IP 주소 ]

➡ 접속에 성공하면 제어노드에서 매니지드 노드로 바뀐것을 위처럼 볼 수 있다.

2. 제어노드에서 키를 생성한다.

생성하기 전, 매니지드 노드에서 키를 확인해보면 없다고 아래처럼 출력되고 있다.
제어노드에서 키 생성 : ssh-keygen
➡ 질문이 2개 정도 나오는데, 그냥 아무것도 입력하지 않고 Enter를 누르면 된다.

3. 제어노드에서 생성한 키를 복사한다. : ssh-copy-id root@[ 매니지드 노드 IP 주소 ]

➡ 매니지드 노드에서 .ssh 파일을 확인해보면 authorized_keys 가 생겼을 것이다.

🐼 Ansible 설치하기 ( 제어 노드 )

dnf -y install centos-release-ansible-29
sed -i -e "s/enabled=1/enabled=0/g" /etc/yum.repos.d/CentOS-SIG-ansible-29.repo
dnf --enablerepo=centos-ansible-29 -y install ansible

테스트 해보기

1. 제어노드에서 인벤토리 ( server.yml ) 생성

all:
  hosts: 
    77.77.77.200:   
    77.77.77.201:
  children:
    webservers:
      hosts:
        77.77.77.200:
        77.77.77.201:

2. 인벤토리 테스트 : ansible webservers -i server.yml -m ping

　➡ webservers : 인벤토리에 작성한 그룹명

　➡ server.yml : 인벤토리명

　➡ -m : 모듈 실행

　➡ ping : 핑 보내보는 명령어

3. 제어 노드에서 플레이북 작성 ( nginx 설치 ) : vi nginx-playbook.yml

- hosts: ["77.77.77.200"]
  tasks:
    - name: install nginx
      yum:
        name: httpd
        state: latest

4. 플레이북 실행 : ansible-playbook -i server.yml ./nginx-playbook.yml

🐷 GitHub Action 실습하기

실습내용 : VS Code에서 커밋 및 푸쉬 시 자동으로 EC2에 nginx 서버 설치(미설치 시)
　　　　　및 html 파일 적용

1. 깃허브 레포지토리 생성

2. AWS EC2 생성 및 인바운드 규칙 편집 ( 80번 및 443번 포트 )

3. EC2 생성 시 발급받은 .ppk 키 파일을 .pem 파일로 변환
　➡ 이유 : .ppk 파일은 Putty에서 사용할 목적으로 생성한 파일이지만, 깃허브 액션은
　　　　　리눅스 환경에서 실행되므로, .pem 형식의 키를 사용하여 SSH 연결을 설정한다.

　1) Puttygen 프로그램 실행

　2) Load 클릭 후 발급받은 .ppk 파일 입력

　3) Conversions 클릭 ➡ Export OpenSSH key 클릭 후 키 저장

2. 사용할 환경변수 등록

　1) 깃허브 레포지토리에서 Settings 클릭

　2) 왼쪽 메뉴탭에서 Secrets and variables - Actions 클릭

　3) New repository secret 클릭 - 사용할 변수명과 값 입력
　　➡ 사용할 변수만큼 계속 생성하면 된다.

  　　➡ 나는 위 사진과 같이 ４개의 환경변수를 생성했다.
   　　　1) REMOTE_HOST : EC2 IP 주소
   　　　2) REMOTE_PORT : 22 　　<-- SSH 프로토콜의 포트번호
   　　　3) REMOTE_USER : ubuntu
   　　　4) SSH_KEY : 발급받은 .pem 키 파일
  　　　　　➡ 파일의 제일 위 -----BEGIN RSA PRIVATE KEY----- 및
   　　　　　　제일 아래 -----END RSA PRIVATE KEY----- 도 포함시켜야 된다.

3. VS Code 열고, 생성한 깃허브 레포지토리로 원격 저장소 설정

4. test.html 파일 생성

<!DOCTYPE html>
<html>
  <head>
    <title>TEST</title>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  </head>
  <body>
    TEST 1111111111
  </body>
</html>

5. .github/workflows 디렉토리 생성

6. nginx 설치 및 실행을 위한 플레이북 작성 ( deploy.yml )

- hosts: ["EC2 IP 주소"]
  tasks:
    - name: Update APT package cache
      apt:
        update_cache: yes
      become: yes
    - name: Install Nginx
      apt:
        name: nginx
        state: present
      become: yes
    - name: Start Nginx service
      systemd:
        name: nginx
        state: started
        enabled: yes

7. EC2에 접속하여 nginx의 페이지를 변경하는 GitHub Action Workflow 작성

name: devops test

on:
  push:
    branches: [main]   // 깃허브로 Push 할 브랜치 명

jobs:
  deploy:
    name: Deploy to EC2
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Repository   // Push 한 내용을 Pull 해오기 위한 작업
        uses: actions/checkout@v3

      - name: Run Ansible playbook  // EC2에서 ubuntu 사용자로 접속하기 위한 작업
        uses: dawidd6/action-ansible-playbook@v2.8.0
        with:
          playbook: deploy.yml
          directory: ./
          key: ${{secrets.SSH_KEY}}
          inventory: |
            [all]
            43.200.163.229 ansible_ssh_user=ubuntu   // EC2 IP 주소로 작성

      - name: get code from github    // Push 한 내용으로 nginx 페이지를 교체하기 위한 작업
        uses: appleboy/ssh-action@v0.1.9
        with:
          host: ${{ secrets.REMOTE_HOST }}
          username: ${{ secrets.REMOTE_USER }}
          key: ${{ secrets.SSH_KEY }}
          port: ${{ secrets.REMOTE_PORT }}
          script: |
            sudo rm -rf ./action    // 깃허브 레포지토리명
            sudo git clone https://github.com/[계정명]/[레포지토리명]
            sudo mv -f ./action/*.html /var/www/html