명명 규칙
샘플 리소스 이름
섹션 제목: “샘플 리소스 이름”샘플 및 데모 리소스 이름은 케밥 케이스(kebab-case)로 example- 접두사를 사용합니다.
이를 통해 에코시스템 전반에 걸쳐 문서, API 사양, 코드 샘플, 생성된 구성을
일관되게 유지할 수 있습니다.
metadata: name: example-http-lb namespace: example-namespace샘플 리소스 이름에는 my-, test-, foo-, demo-, sample- 또는
mycompany와 같은 회사명 형태의 자리 표시자 대신 example-을 사용하십시오. 이는 다음에 적용됩니다:
- 예시에서 리소스
name필드, - 워크플로우 및 파라미터 사양의
example:값, - OpenAPI 예시 값,
- 샘플 Terraform(
.tf) 파일.
적용되지 않는 항목
섹션 제목: “적용되지 않는 항목”이 규칙은 샘플 리소스 이름에만 적용됩니다. 다음 항목은 변경하지 마십시오:
- 속성 및 필드 이름(예:
test_key), - 실제 테스트 코드 및
test/디렉터리, - 패키지 및 의존성 이름,
- 이미 규칙을 따르고 있는 예시 도메인 및 이메일
(
app.example.com,user@example.com).
| 대신 사용하지 않을 것 | 사용할 것 |
|---|---|
my-origin-pool | example-origin-pool |
test-namespace | example-namespace |
demo-app | example-app |
mycompany | example-company |