인터페이스 설계

[namsic]

🔍 Description

• TODO

⏰ Implementation Idea

• ZooKeeper 설정 파일 구조 결정 #24

  kind: zookeeper
  path: /home/jam2in/arcus/zookeeper
  version: 3.5.9
  
  servers:
  - id: 1
    address: cache-01:2181
    internal_address: [ cache-01:2888:3888 ]
  - id: 2
    address: cache-02:2181
    internal_address: [ cache-02:2888:3888 ]
  - id: 3
    address: cache-03:2181
    internal_address: [ cache-03:2888:3888 ]

• Memcached 설정 파일 구조 결정 #23

  kind: memcached
  path: /home/jam2in/arcus/memcached
  version: 0.10.0-E
  
  zookeeper: cache-01:2181,cache-02:2181,cache-03:2181
  service_code: sample
  
  servers:
  - address: cache-01:11211
    group:
      name: g1
      address: cache-01:11311
  - address: cache-02:11212
    group:
      name: g1
      address: cache-02:11312
  
  - address: cache-02:11211
    group:
      name: g2
      address: cache-02:11311
  - address: cache-03:11212
    group:
      name: g2
      address: cache-03:11312
  
  - address: cache-03:11211
    group:
      name: g3
      address: cache-03:11311
  - address: cache-01:11212
    group:
      name: g3
      address: cache-01:11312

[namsic]

ACL

kind: acl

zookeeper: cache-01:2181,cache-02:2181,cache-03:2181

# Group metadata cannot be modified after the group is created.
group:
  name: sample
  adminUsername: sampleAdmin
  # If adminPassword is omitted, password will be prompted during apply
  adminPassword: pw1234!

# If password is omitted, password will be prompted during apply
#
# Available permissions: kv, list, set, map, btree
# - Read/Write: kv, list, set, map, btree
# - Common: attr, flush
# - Admin: admin

users:
- username: alice
  password: 1q2w3e4r
  permissions:
  - admin
  - flush
  - attr
  logAllCommand: true
- username: app
  password: zxcv4321
  permissions:
  - kv
  - list
  - set
  - map
  - btree

[namsic]

@oliviarla

아래 항목 중심으로 확인하고 의견 줄 수 있나요?

yaml 파일 구분 방식

1. kind 필드 사용 ./arcus-cli apply acl/sample.yaml
   • apply 명령 하나로 모든 작업 수행
   • yaml 내부에 kind 필드 두어 어떤 resource에 대한 스펙인지 확인
2. 명령 인자로 구분 ./arcus-cli apply acl acl/sample.yaml
   • 각 yaml 내부에는 각 리소스에 따라 정해진 형식으로 작성
   • 명령에서 yaml을 어떤 포맷으로 해석할지 알려주므로 내부에 kind 같은 구분용 필드 필요없음

acl 관련 인터페이스

• acl 기능을 최우선으로 적용해야 할 것으로 보임
• logAllCommand <= 수행하는 모든 명령 기록 여부. 이름이 이상함. 좋은 이름이 있을지?
• 기타 필드명 및 구조

[oliviarla]

• kind 필드 사용 ./arcus-cli apply acl/sample.yaml 방식이 사용하기 더 쉬울 것 같습니다.

• logAllCommand -> auditLogLevel 필드로 두어 always/dangerous (?) 같은 인자를 입력하도록 하는 건 어떤가요?

• 다음은 질문입니다.

  • 위 파일을 기준으로 group을 여러 개 두려면 어떻게 해야하는지?
  • permissions 목록을 수정 가능한지?
  • 비밀번호를 명시하지 않았을 때 변경하고자 하면 어떻게 해야 하는지?

[namsic]

위 파일을 기준으로 group을 여러 개 두려면 어떻게 해야하는지?

• 서비스코드 단위로 yaml 파일을 두듯이, 그룹 단위로 yaml 파일을 두고 apply하는 형태로 생각 중입니다.
• 막연히 드는 생각이지만, yaml의 문서 구분 기능을 활용하면 아래처럼 관리할 수 있지 않겠나 생각합니다.

1. all-in-one 방식 (클러스터 하나만 운영하는 경우)

kind: zookeeper
path: /home/jam2in/arcus/zookeeper
version: 3.5.9

servers:
# …

---
kind: memcached
path: /home/jam2in/arcus/memcached
version: 0.10.0-E

zookeeper: cache-01:2181,cache-02:2181,cache-03:2181
service_code: sample

servers:
# …
---
kind: acl

zookeeper: cache-01:2181,cache-02:2181,cache-03:2181

group:
  name: sample
# …

2. 리소스 별 모음

kind: acl

zookeeper: cache-01:2181,cache-02:2181,cache-03:2181

group:
  name: sample1
# …

---
kind: acl

zookeeper: cache-01:2181,cache-02:2181,cache-03:2181

group:
  name: sample2
# …

permissions 목록을 수정 가능한지?

아마 수정 가능한 형태가 될 것으로 생각합니다.
지금 서버 구현으로 볼 때, 권한을 수정하면 기존 연결은 old 권한으로 계속해서 동작하게 되고
신규 인증 or 재인증 시점에 최신 권한이 반영될 것입니다.

비밀번호를 명시하지 않았을 때 변경하고자 하면 어떻게 해야 하는지?

비밀번호가 비어있는 상태로 다시 apply하면 새로운 비밀번호를 입력받게 될 것입니다.
비밀번호 비어있는 상태로 apply 하면서 기존 비밀번호를 유지하도록 하려면 어떻게 해야 할지는 잘 모르겠습니다.