이 페이지는 메트릭 레퍼런스 문서를 생성하는 방법을 보여준다.
리눅스 또는 macOS 로 구동되는 개발 환경이 필요하다.
다음의 도구들이 설치되어 있어야 한다.
Go 바이너리와 python과 같은, 요구되는 빌드 도구들이 PATH 환경 변수에 포함되어 있어야 한다.
GitHub 리포지터리로 풀 리퀘스트를 생성하는 방법을 알고 있어야 한다. 이를 위해서는 리포지터리를 직접 포크해야 한다. 자세한 내용은 로컬 포크에서 작업하기를 참조한다.
메트릭 생성은 쿠버네티스 리포지터리에서 이루어진다. 리포지터리를 클론하려면, 클론을 두려는 디렉터리로 이동한다.
그런 다음 아래 명령을 실행한다.
git clone https://www.github.com/kubernetes/kubernetes
이렇게 하면 현재 작업 디렉터리에 kubernetes 폴더가 생성된다.
클론한 쿠버네티스 리포지터리 안에서
test/instrumentation/documentation 디렉터리를 찾는다.
메트릭 문서는 이 디렉터리에 생성된다.
릴리스마다 새로운 메트릭이 추가된다. 메트릭 문서 생성 스크립트를 실행한 뒤에는, 메트릭 문서를 쿠버네티스 웹사이트로 복사하고 갱신된 메트릭 문서를 게시한다.
최신 메트릭을 생성하려면, 클론한 쿠버네티스 디렉터리 루트에 있는지 확인한다. 그런 다음 아래 명령을 실행한다.
./test/instrumentation/update-documentation.sh
변경 사항을 확인하려면, 다음을 실행한다.
git status
출력은 다음과 비슷하다.
./test/instrumentation/documentation/documentation.md
./test/instrumentation/documentation/documentation-list.yaml
쿠버네티스 웹사이트 루트 환경 변수를 설정한다.
다음 명령을 실행하여 웹사이트 루트를 설정한다.
export WEBSITE_ROOT=<path to website root>
생성된 메트릭 파일을 쿠버네티스 웹사이트 리포지터리로 복사한다.
cp ./test/instrumentation/documentation/documentation.md "${WEBSITE_ROOT}/content/en/docs/reference/instrumentation/metrics.md"
chown을 사용하여 파일 소유권을 자신의 사용자로 되돌릴 수 있다.풀 리퀘스트를 생성하려면, 풀 리퀘스트 열기의 안내를 따른다.