nodejs study

프로그라피 6기 nodejs 스터디 레포입니다. 이 스터디는 Typescript와 express를 활용한 서버 애플리케이션 제작을 목표로 하는 서버 기초 스터디입니다. node 버젼은 latest LTS인 v12(작성일 기준 v12.16.1)을 사용합니다. 컴퓨터에 없다면 미리 준비해오기 바랍니다. 설치 방법은 각 OS별로 다르니 nodejs 공식 홈페이지에서 확인후에 설치하면 됩니다. 에디터는 국룰 vscode를 기준으로 진행합니다.

자료: https://drive.google.com/drive/folders/1LH1M6KR0lZwTW4-eal2X_s_J6-IWGmlp

Table of contents

1. 개발환경 셋팅하기

   1. Typescript
   2. js와 ts 비교
   3. lint
   4. 테스트(jest)

2. 서버

   1. 서버 만들기
   2. e2e 테스트

3. 데이터베이스 사용하기

   1. prisma
   2. CRUD 개발
   3. e2e 테스트

4. 도커로 올려보기

   1. 가상화와 도커에 대해 이해하기
   2. 도커 기초 실습
      1. Dockerfile 작성
      2. 이미지 빌드하기
      3. 컨테이너 생성하기
   3. 도커 여러개를 한번에 켜고 끄기
      1. docker-compose.yml 작성

5. ElasticBeanstalk로 서비스 배포하기

   1. IAM으로 권한 생성하기
   2. eb cli 설치하기
   3. 배포하기

---

1.개발환경 셋팅하기

NodeJS 개발 환경은 사실 nodejs만 설치하면 끝입니다.꼭 블로그 따라하면 실행 안됨 마냥 따라 설치하면 되더라. 보다는 왜 설치하는지 알고 설치를 하면 좋습니다. 이 스터디에서는 기본 node에서 나아가 타입을 적용합니다. 다음의 스크립트 순서대로 Typescript, eslint, jest 각각 설치합니다.

i.Typescript

타입스크립트(Typescript)는 nodejs에서 타입을 사용할 수 있게 도와주는 라이브러리입니다. javascript 코딩 중에는 타입에 대해서 신경쓸 필요가 없기 때문에 자유를 느끼며 마구마구 작성할 수 있지만, 작성하다보면 런타임에서 발생한 에러를 잡는 데에 엄청난 시간을 쏟는 대참사를 경험 할 수 있습니다.(특히 오타로 발생하는 오류) 타입을 추가하면, 코드 작성 단계에서 런타임에 발생할 수 있는 오류를 미리 감지할 수 있습니다. 타입이 이걸 해냅니다. 참고로 타입스크립트 공식문서에서 보면 static type checker라고 표현하고 있습니다.

타입스크립트를 사용하려면, 컴파일러 역할을 하는 라이브러리를 받아야 합니다. Typescript를 받아주세요. 설치 후에는 컴파일 설정 파일인 tsconfig.json을 생성하면 준비가 끝납니다.

# typescript 설치
npm i --save-dev typescript

# tsconfig.json 초기 파일 생성
npx tsc --init

# 컴파일
npx tsc

코드 작업은 자바스크립트 확장자인 .js 대신에 .ts를 사용합니다. .ts 파일에 코드를 작성한 후에 npx tsc 명령어를 이용하면 .js파일로 컴파일 할 수 있습니다. 엥? 열심히 타입스크립트로 썼는데 왜 다시 자바스크립트로 돌아가죠? 하고 의문점을 느낄 수도 있는데, 타입스크립트는 코드 작성에 도움을 주는 라이브러리고 결국 런타임은 nodeJS 입니다. 그래서 자바스크립트로 돌아가야합니다.코드를 깔끔하게 사용하기 위해 타입스크립트를 사용하는 것입니다.

타입스크립트를 쓰다보면 라이브러리를 못찾는 오류가 발생합니다. 아주 잘아는 서버 프레임워크인 express를 쓸 때도 라이브러리를 못찾을 수 있습니다. 이럴 때는 @types/express 를 설치하면 사용할 수 있습니다. @types/ 뒤에 사용하려는 라이브러리 이름을 써서 받으면 해당 라이브러리의 타이핑 파일을 받을 수 있습니다. 타이핑 파일은 자바스크립트 라이브러리를 타입스크립트 처럼 사용할 수 있게 도와줍니다. @types/ 로 시작하는 것은 타입스크립트에서 공식지원하는 라이브러리로 보시면됩니다. 최근에는 라이브러리들 마다 타이핑을 제공해서 받지 않아도 사용가능하기도 합니다. 간혹가다 아예 타이핑이 제공되지 않는 라이브러리들이 있는데, 타입스크립트 사용시에는 해당 라이브러리를 안쓰기를 적극 권장합니다. 같은 기능을 하는 다른 라이브러리를 사용할 수 있습니다. 아니면, 직접 타이핑 파일을 만들어서 사용할 수 있습니다. **.d.ts라는 네이밍으로 사용합니다. 타이핑을 직접 만드는 방법은 타입스크립트 공식 홈페이지에서 찾아보세요.

iii.js와 ts 비교

js와 ts의 코드 스타일을 비교해봅니다. 다음은 계산기 기능을 가지고 있는 기본적인 Calculator 클래스를 사용해서 화면에 결과값을 출력하는 예제입니다.

class Calculator {
   add(a, b) {
      return a + b;
   }
   privateSubtract(a, b) {
      return a - b;
   }
}

const calculator = new Calculator();
console.log(calculator.add(1, 2)); // 1. 정상 실행
console.log(calculator.privateSubtract(2, 1)); // 2. 정상 실행
console.log(calculator.multiply(3, 4)); // 3. 런타임상 오류 발생 - 없는 메서드
console.log(calculator.add('a', 'b')); // 4. 런타임상 오류 발생 - 'ab' 리턴

자바스크립트는 실행하기 전까지 오류가 날지 확인이 힘듭니다. eslint를 사용했을 때 힌트를 얻을 수도 있습니다만, 런타임상에서의 오류를 모두 잡기엔 턱없이 부족합니다.

class Calculator {
   public add(a: number, b: number) {
      return a + b;
   }
   private subtract(a: number, b: number) {
      return a - b;
   }
}

const calculator = new Calculator();
console.log(calculator.add(1, 2)); // 1. 정상 실행
console.log(calculator.subtract(2, 1)); // 2. 코드상 오류로 걸림 - private 메서드 접근 불가
console.log(calculator.multiply(3, 4)) // 3. 코드상 오류로 걸림 - 없는 메서드
console.log(calculator.add('a', 'b')); // 4. 코드상 오류로 걸림 - 파라미터 타입 불일치

타입스크립트로 작업을 하면 각 메서드에 받을 변수의 타입을 지정할 수 있습니다. 또한 접근지정자(public, private, protected)를 지정할 수 있어서 캡슐화를 구현할 수 있습니다. 코드 상에서 발생할 수 있는 에러를 미리 알려주기 때문에 코드의 에러율이 현저히 줄어드는 것을 경험할수 있습니다. 처음 코딩을 접하는 사람들에겐 타입에 대해서 이해하는 것부터 힘든 점들이 있겠지만, 어느정도 익숙해지고나서는 코딩이 굉장히 편해집니다.

ii.lint

미리 에러가 나는 것을 방지해주는 typescript도 있지만, 코드 스타일을 예쁘게 만들어주는 툴도 있습니다. lint는 코드 스타일 규칙을 정해서, 규칙에 맞지 않으면 맞지 않은 것을 알려주거나 npx eslint --fix 명령어를 통해 한번에 코드의 일관성을 유지할 수 있는 강력한 도구 입니다. 젯브레인 에디터(안드로이드 스튜디오, 인텔리제이 등)을 사용하시는 분들이라면 Ctrl + Alt + L을 사용하는 것이라고 생각하면 됩니다.(젯브레인 코드스타일이 있음) 이 스터디에서는 VSCODE를 사용하기 때문에, lint를 도와주는 라이브러리 설치가 필요합나다. eslint와 prettier를 받아주세요.

# eslint, prettier 설치
npm install --save-dev eslint prettier

# eslint 초기화
npx eslint --init

# 자동 픽스
npx eslint --fix

매번 cli 명령어로 수정하기 귀찮다면, vscode 익스텐션을 설치하여 파일 저장시에 자동으로 맞출 수도 있습니다.

• eslint
• prettier

iv.테스트(jest)

이 스터디에서는 이미 개발된 기능에 대한 테스트를 진행합니다. 테스트를 알고 사용했을 때의 장점은 첫번째 디버깅이 훨씬 용이해집니다. 포스트맨으로 날려보고 데이터 확인하고, 서버 로그 찍어서 어디서 데이터가 이상해지는지 확인하고 이런 과정을 할 필요가 없습니다.(console.log 안녕~) 둘째로 기능을 추가하거나 버그를 수정했을 때, 수정이 낳는 버그를 막을 수 있습니다. 버그를 수정하다보면 잘되던 코드에서 버그가 발생하는 현상을 경험하기도 하는데, 배포 하기 전에 버그가 있는지 확인할 수가 있습니다. 세번째로 TDD(테스트 주도 개발)에 더 가까워질 수 있습니다.

좀 더 철저한 e2e(엔드 투 엔드, 서버에 요청에 대한 응답을 테스트) 테스트를 미리 작성해두고 개발을 하면 프론트엔드(앱, 웹)에서는 어떻게 요청을 보내고 응답이 어떻게 나오는지를 미리 알 수 있기 때문에 프론트에서 서버가 완성되기 기다리는 개발 공백을 없앨 수 있습니다.

이 스터디에서는 테스트 프레임워크로 페이스북에서 개발한 jest를 사용합니다.

• jest
• ts-jest(타입스크립트 지원 라이브러리)

# jest, ts-jest 설치
npm install --save-dev jest ts-jest

# jest.config.js 파일 생성
npx jest --init

jest.config.js 파일에 ts-jest 설정을 해줘야 하는데, 이 파일을 보고 수정하면 될 것 같습니다. tests 폴더를 생성하고 테스트 파일을 작성해줍니다. tests/Calculator.spec.ts을 작성합니다.

import { Calculator } from '../src/Calculator';

describe('test start', () => {
  const calculator = new Calculator();
  test('calculator.add', () => {
    expect(calculator.add(1, 2)).toBe(3);
  });
});

이제 테스트를 실행해 보세요

# test 실행
npx jest

명령어 뿐만 아니라 테스트를 vscode에서 버튼으로 실행시킬 수 있습니다. vscode에서 테스트 실행 환경을 정의해야합니다. .vscode/launch.json 를 만들고 아래의 코드를 넣어주세요.

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Jest All test files",
      "program": "${workspaceFolder}/node_modules/.bin/jest",
      "args": ["--runInBand"],
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",
      "disableOptimisticBPs": true,
      "windows": {
        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
      },
    }, {
      "type": "node",
      "request": "launch",
      "name": "Jest Current File",
      "program": "${workspaceFolder}/node_modules/.bin/jest",
      "args": [
        "${fileDirname}/${fileBasenameNoExtension}",
        "--config",
        "jest.config.js"
      ],
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",
      "disableOptimisticBPs": true,
      "windows": {
        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
      },
    }
  ]
}

테스트 메서드는 이것 말고도 굉장히 다양하게 있는데, 더 궁금하다면 jest 홈페이지를 참고해주세요

---

1서버 프레임워크

이제 서버를 만듭니다. 타입을 썼을 때 도움이 많이 되는 라이브러리를 이용해보겠습니다. 아래의 라이브러리들을 받아주세요

• express
• routing-controllers
• class-validator
• class-transformer

npm i --save express reflect-metadata routing-controllers class-validator class-transformer
npm i --save-dev @types/express

i.서버 만들기

routing-controllers문서를 보면 간단하게 따라할 수 있습니다.

src/app.ts

import express from 'express';
import { useExpressServer } from 'routing-controllers';

const app = express();

useExpressServer(app, {
  controllers: [`${__dirname}/controllers/**`]
})

export {
  app
}

src/index.ts

import { app } from './app';

app.listen(3000, () => {
  console.log(`server is running on ${3000}`);
})

src/controllers/TodoController.ts

import { BaseController } from './BaseController';
import { JsonController, Get, Param } from 'routing-controllers';

@JsonController('/todos')
export class TodoController extends BaseController {
  @Get()
  public index() {
    return [
      {
        id: 1,
        title: 'first task',
        description: 'create express app'
      }
    ]
  }

  @Get('/:todoId')
  public retrieve(@Param('todoId') todoId: number) {
    return {
      id: todoId,
      title: 'new todo title',
      description: 'todo description',
    }
  }
}

npx tsc && node dist를 통해서 서버 실행하는 것을 알 수 있습니다.

ii.e2e 테스트

이제 만들어진 서버를 테스트 하는 방법을 알아봅니다. jest 환경에 더불어서 supertest 를 설치하여 서버 테스트를 해보겠습니다.

npm i --save supertest
npm i --save-dev @types/supertest

tests/features/Todo.spec.ts

import supertest from 'supertest';
import { app } from '../../src/app';

describe('test Todo', () => {
  const client = supertest(app);

  test('test index todos', async () => {
    const response = await client.get('/todos');
    // 기본 상태코드로 테스트
    expect(response.status).toBe(200);
    // 응답 내용이 배열인지 구분하는 테스트
    expect(Array.isArray(response.body)).toBe(true);
  })
})

위의 테스트 코드를 실행시켜보면 서버가 잘 작동하는 지 알 수 있습니다. 좀더 deep하게 테스트를 한다면, 응답의 내용에 원하는 키값이 잘 들어 있는지 판단해볼 수 있습니다.

tests/features/Todo.spec.ts

import supertest from 'supertest';
import { app } from '../../src/app';

// 키값이 모두 있는지 검사하는 함수를 생성
const assertItem = (item) => {
  const expectedKeys = ['id', 'title', 'description'];
  Object.keys(item).forEach((key) => {
    const idx = expectedKeys.indexOf(key);
    if (idx > -1) {
      expectedKeys.splice(idx, 1);
    }
  })
  expect(expectedKeys).toBe([]);
}

describe('test Todo', () => {
  const client = supertest(app);

  test('test index todos', async () => {
    const response = await client.get('/todos');
    expect(response.status).toBe(200);
    expect(Array.isArray(response.body)).toBe(true);
    // 배열 내의 모든 아이템에 대하여 검사
    for (const item of response.body) {
      assertItem(item);
    }
  })
})

여기까지 서버를 테스트 하는 방법을 알아봤습니다.

3.데이터베이스 사용하기

서버를 만들면 클라이언트(프론트)와 여러 데이터 통신이 오가야합니다. 이 과정에서 저장해야되는 데이터가 생기는데 저장을 위해서 Mysql, MariaDB, Postgres, MongoDB 등의 데이터베이스를 사용해야 저장과 데이터 검색이 용이해 집니다. 목적에 따라서 RDB 또는 NoSQL을 선택할 수 있고, 쿼리를 편하게 쓰기 위해서 ORM을 사용하기도 합니다. 이 스터디에서는 ORM은 아니지만, 데이터베이스 사용이 용이한 prisma를 다뤄봅니다.

i.prisma

다음의 라이브러리를 설치해봅니다.

• prisma

prisma는 특이하게 아래처럼 두개의 라이브러릴 따로 받아서 사용합니다.

npm install --save-dev @prisma/cli
npm install --save @prisma/client

이제 모델파일을 만들어봅니다. url에 들어가는 내용은 데이터베이스 접근 uri schema로 만듭니다. mysql://{ID}:{PASSORD}@{ENDPOINT}/{DATABASE} 의 형식으로 작성할 수 있습니다. 아래는 위의 url을 환경변수에서 가져온다는 코드입니다.

datasource mysql {
  url      = env("DB_URL")
  provider = "mysql"
}

generator client {
  provider = "prisma-client-js"
}

model Todo {
  id          Int      @default(autoincrement()) @id
  createdAt   DateTime @default(now()) @map("created_at")
  updatedAt   DateTime @map("updated_at") @updatedAt
  title       String
  description String?

  @@map("todos")
}

prisma는 .prisma 형식의 파일을 만들어서 모델을 관리하고 npx prisma migrate save로 마이그레이션을 관리할 수 있고, npx prisma migrate up 과 npx prisma migrate down 으로 실제 데이터베이스에 반영할 수 있습니다.

모델 파일(.prisma)이 정의 되어 있는 상태에서 npx prisma generate 를 사용하여, 모델 타이핑을 생성할 수 있습니다. 데이터베이스를 접근하는 타이핑이 생성되어서 코딩이 편해집니다.

아래 와 같은 방법으로 데이터베이스에 접근할 수 있습니다.

const client = new PrismaClient();
await client.todo.create({
  data: {
    title: 'New Todo Item',
    description: 'do something!'
  },
});

ii.CRUD 개발

import { BaseController } from './BaseController';
import {
  JsonController,
  Get,
  Param,
  Post,
  BodyParam,
  Put,
  Delete,
} from 'routing-controllers';
import { PrismaClient } from '@prisma/client';

@JsonController('/todos')
export class TodoController extends BaseController {
  private client: PrismaClient;

  constructor() {
    super();
    this.client = new PrismaClient();
  }

  @Get()
  public index() {
    return this.client.todo.findMany();
  }

  @Get('/:todoId')
  public retrieve(@Param('todoId') todoId: number) {
    return this.client.todo.findOne({ where: { id: Number(todoId) } });
  }

  @Post()
  public async create(
    @BodyParam('title') title: string,
    @BodyParam('description') description: string
  ) {
    return this.client.todo.create({
      data: {
        title,
        description,
      },
    });
  }

  @Put('/:todoId')
  public async update(
    @Param('todoId') todoId: number,
    @BodyParam('title') title: string,
    @BodyParam('description') description: string
  ) {
    return this.client.todo.update({
      where: { id: Number(todoId) },
      data: {
        title,
        description,
      },
    });
  }

  @Delete('/:todoId')
  public async delete(@Param('todoId') todoId: number) {
    return this.client.todo.delete({ where: { id: Number(todoId) } });
  }
}

iii.e2e 테스트

실제로 데이터가 저장이 잘 되었는지 테스트를 작성해보겠습니다. 엔드포인트로 요청을 넣었을 때, 실제로 디비에 저장이 되었는지를 확인할 수 있습니다.

import supertest from 'supertest';
import { app } from '../../src/app';
import { PrismaClient } from '@prisma/client';

describe('test Todo', () => {
  const client = supertest(app);
  test('test index todos', async () => {
    const response = await client.get('/todos');
    expect(response.status).toBe(200);
    const actual = await new PrismaClient().todo.findOne({
      where: { id: Number(response.body.id) },
    });
    expect(actual.description).toBe(response.body.description);
    expect(actual.title).toBe(response.body.title);
  });
});

4.도커로 올려보기

i.가상화와 도커에 대해 이해하기

얕은지식으로 쓰는 것보단 잘 설명되어 있는 블로그를 통해 학습을 하면 좀더 편할 것 같습니다.

• 초보를 위한 도커 안내서 - 도커란 무엇인가?
• 초보를 위한 도커 안내서 - 설치하고 컨테이너 실행하기
• 초보를 위한 도커 안내서 - 이미지 만들고 배포하기

다른 가상환경이랑 이해하는 방법은 같은데, 우리는 아래 3가지만 하면 됩니다.

1. Dockerfile 작성
2. 도커 이미지 생성
3. 도커 컨테이너 생성

ii.도커 기초 실습

a.Dockerfile 작성

여러가지 도커파일 명령어들이 있다. 내용은 도커 도큐먼트내에서 확인이 가능하다. Dockerfile best practice을 쓰윽 읽어보면 좋을 것 같다.

이 스터디에서 작성한 도커파일을 보자

# 은 주석을 쓸 수 있다.

# 다른 이미지를 상속받아 구현한다. node 버젼 12를 가지고 있는 이미지를 받는다.
FROM node:12

# 도커파일 내에서 사용하는 변수 선언
ARG PROJECT_PATH=/web/service/api

# 현재 디렉토리에서 이미지로 파일 복사
COPY package.json ${PROJECT_PATH}/package.json
COPY package-lock.json ${PROJECT_PATH}/package-lock.json

# 명령어를 기본 실행하는 컨테이너 내부 경로 설정(아까 ARG로 설정한 내용을 쓴다)
WORKDIR ${PROJECT_PATH}

# 명령어 실행
RUN npm install

# 프로젝트 파일 복사(ADD와 COPY 두가지 명령어가 복사라는 역할을 하는데 둘의 차이는 문서에서 확인해보자)
COPY . ${PROJECT_PATH}

# 프로젝트 빌드
RUN npm run build

# 도커 외부에 보여줄 이 컴퓨터가 제공할 포트 정의
EXPOSE 3000

# 컨테이너가 실행 될 때 처음에 실행할 명령어 정의 같은 역할을 하는 ENTRYPOINT가 있다. 문서에서 둘의 차이가 무엇인지 찾아보자
CMD ["npm", "start"]

b.이미지 빌드하기

위에서 작성한 내용을 빌드합니다. 빌드는 docker build라는 명령어로 할 수 있습니다. 아래와 같은 방법으로 할 수 있습니다.

docker build -t {태그} {Dockerfile 경로}

태그는 이미지에 불힐 이름이라고 생각하면 됩니다. 이미지 이름 + 버젼으로도 명시할 수 있습니다. simple-server:latest, simple-server:2 등등 의 방법으로 이미지 이름과 버젼으로 버젼관리를 할 수 있습니다. 이미지 이름을 안쓰는 경우 무작위 이름을 지어줍니다.

ex)

docker build -t simple-server .

c.컨테이너 생성하기

컨테이너 생성은 run으로 할 수 있습니다. 몇가지 옵션을 알아두면 도움이 되겠다.

• --rm: 컨테이너가 꺼지면 바로 삭제하는 옵션
• -v, --volume: 컨테이너의 디렉토리와 컴퓨터의 디렉토리를 연결하는 옵션, 환경은 컨테이너, 파일은 컴퓨터를 사용할 수 있다. -v {컴퓨터 경로}:{컨테이너 경로}
• -p, --publish: 컨테이너의 포트와 컴퓨터의 포트를 연결하는 옵션, -p {컴퓨터 포트}:{컨테이너 포트}
• --entrypoint: 컨테이너 실행시 기존에 Dockerfile에 정의된 CMD나 ENTRYPOINT를 Overriding 하는 옵션, 실제 서버 실행을 안하고 다른 기능을 수행할 수 있다.
• --name: 컨테이너에 이름을 붙이는 옵션
• -it: 컨테이너를 실행할 때 터미널로 인터랙션(로그 확인 등) 을 할 수 있다.
• -d: -it의 반대, detached 옵션, 백그라운드에서만 돌아가도록 설정한다.
• --link: 이미 작동중인 다른 컨테이너에 연결하는 옵션, 이 옵션이 없으면 기본적으로 컨테이너들 끼리 연결이 안된다.

docker run {image-name}

ex)

docker run -it \
-p 3000:3000 \
-v (PWD):/web/service/api \
--name simple-container \
simple-server

이후에 컨테이너를 켜고 끄려면

# 현재 실행중인 컨테이너 목록
docker ps

# 모든 컨테이너 목록
docker ps -a

# 컨테이너 종료(가상 컴퓨터 종료)
docker stop {컨테이너 ID 또는 이름}

# 컨테이너 시작(가상 컴퓨터 실행)
docker start {컨테이너 ID 또는 이름}

# 컨테이너 재시작
docker restart {컨테이너 ID 또는 이름}

# 컨테이너 삭제
docker rm {컨테이너 ID 또는 이름}

iii.도커 여러개를 한번에 켜고 끄기

도커 여러개를 한번에 켜고 끌 수 있다. docker-compose.yml을 사용하면 가능한다. 스택이나 팟을 만들어도 가능한데 초보자의 입장에선 이것만으로도 가능하다.

기본적으로 --link 옵션을 사용해야 컨테이너들 끼리 연결이 가능한데, 컨테이너의 종속성이 꼬이는 경우가 생길 수 있다. 이때 도커 네트워크를 만들고 하나의 네트워크에 컨테이너들을 연결해주면 다른 설정을 해주지 않아도 컨테이너끼리 연결이 가능하다.

a.docker-compose.yml 작성

docker-comnpose.yml 를 아래처럼 수정해서 써보세요

# docker-compose 버젼
version: "3.7"

# 컨테이너 목록
services:
  # 컨테이너 이름 변수처럼 직접 고르면 된다.
  db:
    # 컨테이너에 사용할 이미지
    image: mysql:latest
    # 포트 연결 설정
    ports:
      - 3306:3306
    # 컨테이너 실행시에 환경변수 사용
    environment:
      MYSQL_ROOT_PASSWORD: 1016
      MYSQL_DATABASE: sample
    # 재시작하는 조건
    restart: on-failure
    # 컨테이너에 연결할 볼륨 연결
    volumes:
      - ./db/conf.d:/etc/mysql/conf.d
      - ./db/data:/var/lib/mysql
    # 네트워크 설정
    networks:
      default:
        ipv4_address: 172.16.2.2

  server:
    # 컨테이너에 사용할 Dockerfile이 있는 경로, image 대신에 쓰면, 없는 경우 이미지를 자동으로 빌드하고 컨테이너를 생성한다.
    build: .
    ports:
      - 3000:3000
    environment:
      HOST: 0.0.0.0
      PORT: 3000
      DB_URL: mysql://root:1016@172.16.2.2/sample
    # 기본적으로 써있는 CMD나 ENTRYPOINT에 덮어쓸 내용
    entrypoint: "npm run dev"
    networks:
      default:
        ipv4_address: 172.16.2.3

networks:
  default:
    driver: bridge
    ipam:
      config:
        - subnet: 172.16.2.0/24

위의 파일은 따지고 보면 docker run 명령어를 텍스트로 작성해뒀다고 생각하면 된다. 이제 이 파일이 있으면 누구나 손쉬운 명령어로 도커 컨테이너를 켜고 끌 수 있다.

# 이미지가 없다면 빌드후 먼테이너 오픈(docker-compose.yml 파일에 변화가 있는 경우 컨테이너 재 생성)
docker-compose up -d(detached 옵션, 이게 없으면 서버와 디비 모두 콘솔이 켜진 상태가 된다.)

# 컨테이너 종료 후 이미지 삭제(build 옵션의 경우에만)
docker-compose down

# 컹테이너만 켜고 끄고 재시작
docker-compose start
docker-compose stop
docker-compose restart

# 이미지 빌드만 실행
docker-compose build

이렇게 할 수 있다.

ex)

docker-compose up -d

5.ElasticBeanstalk로 서비스 배포하기

아마존에서 제공하는 ElasticBeanstalk를 이용해서 배포를 한다. 왜 이걸 쓰냐면, ec2 인스턴스 받고 개발환경 설정하고 터미널로 접속해서 서버 실행 하고를 하는게 아니라 내 컴퓨터의 로컬 환경에서 터미널 커맨드 하나만로 배포를 할 수 있기 때문에 너무 편해서 쓴다.

i.IAM으로 권한 생성하기

eb는 아마존의 콘솔에서도 생성해서 쓸 수 있다. 하지만 cli로 하기 위해서는 IAM 권한이 필요하다. 권한을 위해 사용자 설정을 해보자

1. IAM 사용자 추가 버튼 클릭

2. IAM 사용자 이름과 접근 방식 정의

3. ElasticBeanstalkFullAccess 권한 추가

4. IAM 사용자 태그(옵션)

5. IAM 사용자 등록 완료

6. 사용자 추가 완료 - aws-access-key 와 aws-secret-key를 기억해두자(복사를 해도 되고, csv 파일을 받아서 저장할 수 있다)

ii.eb cli 설치하기

eb cli를 로컬환경에서 설치하려면 eb cli 프로그램 설치가 필요하다. 설치할때는 pip를 이용하는게 정신건강에 이롭다. 나는 죽어도 파이썬을 설치하기 싫다면, 파이썬용 도커 컨테이너를 만들어서 설정을 할 수도 있다. (참고)

1. ebcli 설치

iii.배포하기

1. eb init으로 권한 설정

2. IAM에서 확인한 aws-access-key 와 aws-secret-key를 적는다.

3. 배포할때 필요한 파일 설명

   • .ebextensions/**: 배포시 필요한 환경 설정을 관리하는 파일. 환경변수(git에 포함되면 안된다)와 timezone, 모니터링, 로드밸런서 등등
   • Dockerrun.aws.json: 도커 실행시 필요한 내용 정의(docker-compose.yml 처럼 실행시 사용할 port, volume, 로깅, 시작 명령어 등을 정의) - 참고: aws문서 - 단일 컨테이너 Docker 구성
   • .ebignore: 배포시 제외 시킬 파일을 정의, 숨김파일(.으로 시작하는 파일 또는 폴더) 내용은 업로드가 안되는데, .ebextensions 내용을 사용하기 위해 .ebignore에 등록된 내용을 제외하고 모두 포함시키기 위해 사용한다.

4. eb create로 첫 배포

5. 다시 배포할 때는 eb deploy를 쓰면 된다.

6. 삭제시에는 eb teminate를 쓰면 된다.