[Keycloak, Docker, Mac] 다양한 설치 방법을 알아보고 Keycloak을 Docker로 직접 설치해보자. (1)

 

 

Keycloak을 사용할 수 있는
여러 방법을 살펴보고
직접 설치해보자!

 

 

 

 

 

만약 실제로 keycloak을 사용할 예정인 프로젝트를 하고 있다면?

• 카테고리에도 있지만 VIP 초대장이라는 프로젝트에서 Keycloak을 사용했습니다. 저같은 경우는 처음 Keycloak을 사용하다보니, 어떤 순서로 진행해야하는지 고민이 되더라고요. 제가 한 순서가 정답은 아니겠지만 혹시라도 도움이 되실 분들을 위해 남겨보겠습니다.
• VIP 초대장에는 고객 관리 페이지와 관리자를 관리하는 관리자 관리 페이지가 있습니다. 그 중 관리자페이지에 Keycloak을 이용했습니다. 관리자는 최고관리자와 일반관리자로 역할이 나뉘고 최고관리자는 일반관리자를 관리할 수 있는 권한이 있습니다. 그래서 Keycloak을 통해 관리자페이지엔 최고관리자만 들어가도록 만들었습니다.
• 이때 제가 한 고민은, 코드를 먼저 작성해야할지 만약 작성한다면 어떤 코드부터 작성해야하는지 아니면 Keycloak을 먼저 설치해야하는지 등 순서에 대해 고민했습니다. 각자 프로젝트의 내용과 진행하는 방향이 다르기 때문에 제가 한 방법이 정답이라고 말할 순 없지만, 저의 경우는 [프론트 작성 -> keycloak과 무관하다고 판단되는 기능들의 백엔드 코드 작성 ->  keycloak 설치 -> 백엔드와 keycloak 연결 및 관련 코드 추가 및 수정] 순서로 진행했습니다.
• 저의 경우는 프론트, 백엔드를 혼자서 다하다보니까 이런 순서로 진행할 수 있었던 것 같네요. (다만 이렇게 진행하면 목업이나 테스트 코드 짜는 실력이 거의 없다고 봐야...;; 그래서 다음에 백엔드부터 해서 테스트 코드 진행을 해보려 합니다) 

 

 

 

---

 

 

 

 

Keycloak을 설치하는 여러가지 방법

• Docker
  - 가장 빠르고 간편하게 Keycloak을 설치할 수 있다.
  - 개발 환경부터 소규모 운영 환경까지 폭넓게 사용가능하다.
  - Docker Hub 이미지를 사용하여 docker run 또는 docker-compose로 즉시 실행 가능하다.
  - Docker는 개발, 테스트, 운영 환경을 동일하게 유지하기 매우 쉽다.
  - 호스트 시스템에 Java 등을 설치할 필요 없이 독립적으로 구동된다. 
  - 이미지 태그만 바꾸면 되므로 업데이트와 롤백이 간편하다.
  - 다만 컨테이너 네트워킹 및 볼륨 설정 등 사전 지식이 약간 요구되는 편이다.
  - 저는 ElasticSearch 때문에 Docker를 사용한 입장이라 이 방법으로 설치했습니다. Docker에 관련된 내용 포스팅은 밑에 남겨두겠습니다.
  
  
• Kubernetes(Operator)
  - 엔터프라이즈(대규모 조직용 솔루션)환경이나 마이크로서비스 아키텍처(MSA)에서 가장 권장되는 방식이다.
  - Helm Chart를 이용하거나, Keycloak 팀에서 직접 관리하는 Operator를 통해 배포한다.
  - Operator가 클러스터 상태를 감시하며 자동 복구, 롤링 업데이트 등을 수행하여 자동화된 관리를 제공한다.  →  롤링 업데이트란, 쿠버네티스에서 시스템 전체를 한 번에 교체하지 않고, 서비스 중단 없이 파드(Pod)인스턴스를 점진적으로 새 버전으로 교체하는 배포 방식을 말한다.
  - 트래픽 증가 시 인스턴스(Pod) 수를 동적으로 조절하기 매우 유리하다.
  - 모든 설정을 코드(YAML)로 관리할 수 있어 인프라 관리가 체계적이다.  →  YAML은 메모와 비슷한데 이를 소프트웨어처럼 활용할 수 있게 한다. 여러 장점이 있지만 쉽게 설명하면, YAML을 이용하면 수동설정(일일이 지시) 없이 최종상태만 기술하면 되어서 장애가 줄어든다.
  - 쿠버네티스 인프라 구축 및 유지보수 비용이 높다는게 단점이다.
  
  
• Podman
  - Docker와 거의 동일한 명령어를 사용하지만, 구조적으로 더 안전하고 가볍게 설계된 컨테이너 관리 도구이다.
  - Keycloak은 RedHat 프로젝트이기 때문에 RedHat 계열 OS(RHEL 등)에서는 Docker 대신 Podman을 사용한다.
  - 관리자 권한(root) 없이 컨테이너를 실행할 수 있어서 보안상 좋다.
  - Docker처럼 백그라운드에서 실행되는 프로세스가 없어도 작동한다. podman run...과 같이 Docker 명령어를 podman으로 바꾸면 거의 똑같이 작동한다.
  

 

 

- 더 다양한 설치 방법

Guides

 

 

- Docker 설치 방법

[Spring, React, Mac] Elasticsearch를 위해 Docker 설치하기.

 

 

 

 

 

---

 

 

 

 

Keycloak 설치하기

• 폴더 만들기
  : 프로젝트 바깥 혹은 안에 터미널로 들어가서 keycloak-docker라는 폴더를 만들자.
  여기서 잠깐!!!! 프로젝트 안에 만드는 걸 추천합니다... 그래야 나중에 keycloak 로그인 화면을 수정할 때 어려움을 덜 겪습니다.  저는 몰라서 아무곳에다 만들었다가 후회했어요. ㅠ0ㅠ

mkdir keycloak-docker
cd keycloak-docker

 

 

• docker-compose.yml 만들기
  : 아까 만든 폴더 안에 yml을 만들면 됩니다.

services:
  keycloak:
    image: quay.io/keycloak/keycloak:26.5.6
    container_name: invitevip-keycloak
    ports:
      - "8180:8080"
    environment:
      KC_BOOTSTRAP_ADMIN_USERNAME: admin
      KC_BOOTSTRAP_ADMIN_PASSWORD: admin1234!
    command: start-dev

image는 Keycloak의 공식 이미지를 가져온다. 여기서 quay.io는 Red Hat에서 운영하는 이미지 저장소이다. 최신 버전이 26.5.6을 가져왔다.
container_name은 실행될 컨테이너의 이름이다. 설정하지 않으면 docker가 알아서 임의의 이름을 붙인다. 아무래도 지정해두면 명령어 칠 때 편리하다.
ports는 네트워크 포트를 설정한 것이다. 호스트 컴퓨터와 컨테이너 사이의 포트를 연결하는데, 8080이 컨테이너 내부에서 Keycloak이 실제로 떠 있는 포트이고 8180이 Keycloak 화면으로 연결되는 포트이다. (keycloak을 설치하면 realm, user, client, role 등을 설정하는 화면을 주는데 그걸 8180으로 받는 것이다)
environment는 초기관리자 설정하는 것이다. 8180 페이지로 들어가면 로그인 화면이 나오는데, 이때 설정한 아이디와 비밀번호를 넣어야 들어갈 수 있다.
command: start-dev는 keycloak을 개발 모드로 실행한 것이다. 실무 환경은 start라고 적는데, start-dev 모드에서는 HTTP로도 접속이 가능해 로컬 테스트가 편리하고 DB 연결이나 호스트 이름 체크 등을 개발 편의를 위해 느슨하게 처리한다.

 

 

• 컨테이너 실행하기
  

docker compose up -d

Docker에 들어가서 실행해도 되고, 명령어를 넣어도 된다.

 

 

• keycloak에 들어가기
  이제 아까 연결했던 포트를 기억하며 localhost:8180으로 들어가준다.

아까 설정했던 아이디와 비밀번호를 입력하면 된다.

 

 

• realm 만들기
  - Manage realms에 들어가기

 

 

    -  Realm 이름 설정하기

 

 

    - realm 생성 완료

 

 

 

---

 

 

 

 

다음에 할 것

이번 포스팅은 설치까지 마무리했다. 다음 포스팅 때 client, role, user 등을 설정해보겠다.

[Keycloak, Docker, Mac] Keycloak에서 client, role, users 등 설정하고 React 연결하기