docs(redis): Redis SDK 운영 문서를 한국어로 옮긴다
문제: docs/redis 아래 살아 있는 문서 4개가 영어였다(language 예외). 고친 방법: 뜻을 그대로 옮기고 식별자·명령·경로·표 구조는 원문으로 둔다. support-matrix.md의 표 첫 칸(package·capability·토폴로지 이름)과 증거 칸의 테스트 클래스 이름은 RedisSupportMatrixTest가 그대로 읽으므로 바꾸지 않았다. 번역하며 고친 것: - 「pinned to Lettuce 6.8.2」: build.gradle은 버전 없이 Boot BOM을 따른다. 숫자 대신 BOM과 leaf gradle.lockfile을 가리킨다. - 「five defects」 뒤 목록이 일곱 항목이라 「결함 일곱」으로 고쳤다. 위험·한계: 내용 감사는 하지 않았다. 검증: python3 scripts/check-docs.py에서 이 폴더 예외 줄 0. RedisSupportMatrixTest의 세 단언(package·capability가 첫 칸에 있음, 토폴로지 행이 있는 테스트 클래스를 댐)을 같은 규칙으로 문서에 돌려 보았다(빠진 것 0).
This commit is contained in:
@@ -1,49 +1,48 @@
|
||||
# Command policy
|
||||
# 명령 정책
|
||||
|
||||
`src/adapter/outbound/redis-sdk/src/main/resources/redis-sdk/redis-command-policy.yml` is the
|
||||
single source of truth for what this SDK is willing to do with each Redis command. Official server
|
||||
metadata decides what a command *is*; this file decides what we allow.
|
||||
`src/adapter/outbound/redis-sdk/src/main/resources/redis-sdk/redis-command-policy.yml`이 이 SDK가 Redis 명령마다
|
||||
무엇을 해도 되는지 정하는 유일한 정본이다. 명령이 *무엇인지*는 공식 서버 metadata가 정하고, 무엇을 허락할지는 이
|
||||
파일이 정한다.
|
||||
|
||||
A command that is not classified there is refused. Adding a command therefore means editing that
|
||||
file, not writing code — and the edit is where the risk decision is made and reviewed.
|
||||
거기에 분류되지 않은 명령은 거부한다. 그래서 명령을 더하는 것은 코드를 쓰는 일이 아니라 그 파일을 고치는 일이고, 위험
|
||||
판단을 내리고 검토하는 곳이 그 수정이다.
|
||||
|
||||
## Fields
|
||||
## 필드
|
||||
|
||||
| Field | Default | Meaning |
|
||||
| 필드 | 기본값 | 뜻 |
|
||||
| --- | --- | --- |
|
||||
| `risk` | required | `R1` routine, `R2` needs an explicit permit, `R3` administrative, `R4` never allowed |
|
||||
| `support` | required | `TYPED`, `ADVANCED_TYPED`, `RAW_ONLY`, `ADMIN_ONLY`, `VERSION_GATED`, `BLOCKED` |
|
||||
| `minimum-version` | `7.2` | lowest server version that carries the command |
|
||||
| `access` | derived from `support` | which ACL account may issue it |
|
||||
| `blocking` | `false` | occupies its connection until the server replies |
|
||||
| `optional-block` | `false` | the command also has a non-blocking form; only `XREAD` and `XREADGROUP` carry it |
|
||||
| `read-only` | `false` | never mutates the dataset |
|
||||
| `retry-safe` | `read-only` | may be retried after a failure that could have reached the server |
|
||||
| `may-be-ambiguous` | `!read-only` | a failure may leave the outcome unknown |
|
||||
| `timeout-profile` | derived | `FAST`, `COLLECTION`, `ADMIN`, `BLOCKING` |
|
||||
| `key-spec` | `1 1 1` | where the keys are, or `none`, or `movable` |
|
||||
| `required-policy` | – | the permit policy an R2 command demands |
|
||||
| `risk` | 필수 | `R1` 일상, `R2` 명시적 허가 필요, `R3` 관리, `R4` 절대 허락 안 함 |
|
||||
| `support` | 필수 | `TYPED`, `ADVANCED_TYPED`, `RAW_ONLY`, `ADMIN_ONLY`, `VERSION_GATED`, `BLOCKED` |
|
||||
| `minimum-version` | `7.2` | 그 명령이 있는 가장 낮은 서버 버전 |
|
||||
| `access` | `support`에서 정함 | 어느 ACL 계정이 보낼 수 있는지 |
|
||||
| `blocking` | `false` | 서버가 답할 때까지 connection을 잡는다 |
|
||||
| `optional-block` | `false` | 그 명령에 blocking 아닌 형태도 있다. `XREAD`와 `XREADGROUP`만 가진다 |
|
||||
| `read-only` | `false` | 데이터를 절대 바꾸지 않는다 |
|
||||
| `retry-safe` | `read-only` | 서버에 닿았을 수 있는 실패 뒤에도 재시도해도 된다 |
|
||||
| `may-be-ambiguous` | `!read-only` | 실패가 결과를 모르는 상태로 남길 수 있다 |
|
||||
| `timeout-profile` | 정함 | `FAST`, `COLLECTION`, `ADMIN`, `BLOCKING` |
|
||||
| `key-spec` | `1 1 1` | key가 있는 곳. 또는 `none`, `movable` |
|
||||
| `required-policy` | – | R2 명령이 요구하는 허가 정책 |
|
||||
|
||||
## Rules the catalog enforces
|
||||
## 목록이 강제하는 규칙
|
||||
|
||||
- An R2 `ADVANCED_TYPED` command must name the permit policy it requires. There is no R2 command
|
||||
that anyone may issue without an issued permit.
|
||||
- An R4 command must be `BLOCKED`, and an R3 command must be `ADMIN_ONLY`. The type system refuses
|
||||
the other combinations at load time.
|
||||
- A `BLOCKED` command carries no ACL account, so no path in the SDK can reach it.
|
||||
- A blocking command must use the `BLOCKING` timeout profile, and its request must declare a bounded
|
||||
server block — unless it also declares `optional-block`, which only the two stream reads do.
|
||||
- Deprecated command names stay `BLOCKED` even when the SDK offers their behaviour. The typed
|
||||
sorted-set ranges issue `ZRANGE ... BYSCORE|BYLEX|REV`, not `ZRANGEBYSCORE`, so what the guard was
|
||||
told and what reaches the wire are the same command.
|
||||
- R2 `ADVANCED_TYPED` 명령은 요구하는 허가 정책의 이름을 대야 한다. 발급한 허가 없이 누구나 보낼 수 있는 R2 명령은
|
||||
없다.
|
||||
- R4 명령은 `BLOCKED`여야 하고, R3 명령은 `ADMIN_ONLY`여야 한다. 그 밖의 조합은 불러올 때 타입 체계가 거부한다.
|
||||
- `BLOCKED` 명령에는 ACL 계정이 없다. 그래서 SDK의 어떤 경로도 그것에 닿을 수 없다.
|
||||
- blocking 명령은 `BLOCKING` timeout profile을 써야 하고, 그 요청은 상한 있는 서버 block을 선언해야 한다.
|
||||
`optional-block`도 선언하면 예외인데, stream 읽기 둘만 그렇다.
|
||||
- 폐기된 명령 이름은 SDK가 그 동작을 제공하더라도 `BLOCKED`로 남는다. 타입 있는 sorted-set 범위 조회는
|
||||
`ZRANGEBYSCORE`가 아니라 `ZRANGE ... BYSCORE|BYLEX|REV`를 보낸다. 그래서 guard가 들은 명령과 wire에 닿는 명령이
|
||||
같다.
|
||||
|
||||
## Where each support level is reachable from
|
||||
## 지원 등급마다 닿는 곳
|
||||
|
||||
| Support | Reachable from |
|
||||
| 지원 | 닿는 곳 |
|
||||
| --- | --- |
|
||||
| `TYPED` | the typed operations, no permit |
|
||||
| `ADVANCED_TYPED` | the typed operations, with the named permit |
|
||||
| `VERSION_GATED` | a capability bean that exists only when the probe found the feature |
|
||||
| `RAW_ONLY` | `sdk.raw`, and only with a deployment-registered approval |
|
||||
| `ADMIN_ONLY` | `sdk.admin`, read-only diagnostics only |
|
||||
| `BLOCKED` | nowhere |
|
||||
| `TYPED` | 타입 있는 연산, 허가 없이 |
|
||||
| `ADVANCED_TYPED` | 타입 있는 연산, 이름 댄 허가와 함께 |
|
||||
| `VERSION_GATED` | probe가 그 기능을 찾았을 때만 있는 capability bean |
|
||||
| `RAW_ONLY` | `sdk.raw`, 그리고 배포가 등록한 승인이 있을 때만 |
|
||||
| `ADMIN_ONLY` | `sdk.admin`, 읽기 전용 진단만 |
|
||||
| `BLOCKED` | 어디에도 없음 |
|
||||
|
||||
Reference in New Issue
Block a user