인스턴스 메타데이터 저장 및 검색

모든 인스턴스는 메타데이터 서버에 메타데이터를 저장합니다. 이 메타데이터 서버는 인스턴스 내부 및 Compute Engine API에서 프로그래매틱 방식으로 쿼리할 수 있습니다. 인스턴스의 호스트 이름, 인스턴스 ID, 시작 및 종료 스크립트, 커스텀 메타데이터 및 서비스 계정 정보와 같은 인스턴스 정보를 쿼리할 수 있습니다. 인스턴스는 추가 승인 없이 메타데이터 서버 API에 자동으로 액세스할 수 있습니다.

메타데이터 서버를 시작종료 스크립트와 함께 사용하면 특히 유용합니다. 메타데이터 서버를 프로그래매틱 방식으로 사용하여 추가 승인 없이 인스턴스에 대한 고유한 정보를 얻을 수 있기 때문입니다. 예를 들면 인스턴스의 외부 IP에 대한 메타데이터 키/값 쌍을 가져오는 시작 스크립트를 작성하고 스크립트에서 해당 IP를 사용하여 데이터베이스를 설정할 수 있습니다. 기본 메타데이터 키는 모든 인스턴스에서 동일하므로 스크립트를 모든 인스턴스마다 업데이트할 필요 없이 재사용할 수 있습니다. 따라서 덜 불안정한 애플리케이션 코드를 작성할 수 있습니다.

메타데이터는 key:value 형식으로 저장됩니다. 모든 인스턴스가 액세스할 수 있는 메타데이터 항목의 기본 집합이 있습니다. 커스텀 메타데이터를 설정할 수도 있습니다.

메타데이터 서버에 액세스하려면 메타데이터 URL을 쿼리하면 됩니다.

현재 버전: v1

Compute Engine은 두 개 이상의 메타데이터 버전을 제공할 수 있지만 항상 사용 가능한 최신 메타데이터 서버 버전을 사용하는 것이 좋습니다. Compute Engine은 언제든지 메타데이터 서버에 새로운 항목을 추가하고 응답에 새로운 필드를 추가할 수 있습니다. 주기적으로 변경사항을 확인하세요.

메타데이터 서버 엔드포인트의 버전을 확인하는 방법에 대한 자세한 내용은 서버 엔드포인트의 버전 확인을 참조하세요.

v1beta1 서버와 v0.1 메타데이터 서버 엔드포인트는 지원 중단되었으며 서비스가 종료될 예정입니다. v1을 사용하도록 모든 요청을 업데이트해야 합니다. 자세한 내용은 v1 메타데이터 서버 엔드포인트로 전환을 참조하세요.

시작하기 전에

이 작업에 필요한 권한

이 작업에는 다음과 같은 권한이 있어야 합니다.

  • 인스턴스 메타데이터를 설정하는 경우 인스턴스에 대한 compute.instances.setMetadata 권한
  • 프로젝트 차원의 메타데이터를 설정하는 경우 프로젝트에 대한 compute.projects.setCommonInstanceMetadata 권한
  • 메타데이터를 가져오기만 하는 경우 프로젝트에 대한 compute.projects.get 권한
  • 메타데이터를 가져오기만 하는 경우 인스턴스에 대한 compute.instances.get 권한

프로젝트 및 인스턴스 메타데이터

프로젝트와 인스턴스 모두에 메타데이터를 할당할 수 있습니다. 프로젝트 메타데이터는 프로젝트 내의 모든 가상 머신(VM) 인스턴스에 전파되지만 인스턴스 메타데이터는 해당 인스턴스에만 영향을 미칩니다.

기본 메타데이터 키

Compute Engine은 인스턴스 또는 프로젝트에 대한 정보를 제공하는 일련의 기본 메타데이터 항목을 정의합니다. 기본 메타데이터는 항상 서버에 의해 정의되고 설정됩니다. 이러한 메타데이터 쌍을 수동으로 수정할 수는 없습니다.

다음은 프로젝트에서 기본적으로 사용할 수 있는 메타데이터입니다. 일부 메타데이터 항목은 다른 메타데이터 키가 들어있는 디렉터리입니다. 이러한 차이는 메타데이터 이름에서 맨 뒤에 있는 슬래시로 표시됩니다. 예를 들어 attributes/는 다른 키를 포함하는 디렉터리이고 numeric-project-id는 값에 매핑되는 메타데이터 키입니다.

http://metadata.google.internal/computeMetadata/v1/project/ 관련
메타데이터 항목 설명
attributes/ 이 프로젝트에 설정된 커스텀 메타데이터 값의 디렉터리입니다.
attributes/disable-legacy-endpoints 프로젝트의 모든 인스턴스에 대한 기존 메타데이터 서버 엔드포인트를 사용 중지합니다. 프로젝트에서 기존 엔드포인트를 사용하지 않는 한 항상 disable-legacy-endpoints=TRUE로 설정합니다. v1 엔드포인트를 사용하려면 애플리케이션을 업데이트합니다.
attributes/enable-oslogin enable-oslogin=TRUE를 설정할 경우 프로젝트에서 OS 로그인 SSH 키 관리 기능을 사용 설정합니다.
attributes/vmdnssetting 프로젝트의 인스턴스에 대해 내부 DNS 이름의 형식을 지정하는 방법을 구성합니다. 내부 DNS 이름에 대한 자세한 내용은 DNS 이름 구성을 참조하세요.
attributes/ssh-keys 프로젝트 및 인스턴스가 SSH 키 관리에 OS 로그인을 사용하도록 구성되지 않은 경우 이 속성을 사용하여 이 프로젝트의 인스턴스에 연결할 수 있는 공개 SSH 키를 구성할 수 있습니다. SSH 키가 여러 개인 경우 각 키는 줄바꿈 문자(\n)로 구분됩니다. 이 값은 문자열입니다. OS 로그인에 의해 관리되는 SSH 키는 이 메타데이터 값에 표시되지 않습니다.

예: "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

numeric-project-id 인스턴스의 숫자 프로젝트 ID(프로젝트 번호)로, Google Cloud Console에 표시되는 프로젝트 이름과 동일하지 않습니다. 이 값은 project-id 메타데이터 항목 값과는 다릅니다.
project-id 프로젝트 ID입니다.

다음은 인스턴스에 기본적으로 사용할 수 있는 메타데이터입니다.

http://metadata.google.internal/computeMetadata/v1/instance/ 관련
메타데이터 항목 설명
attributes/ 시작 또는 종료 중에 인스턴스에 전달된 커스텀 메타데이터 값의 디렉터리입니다. 아래의 커스텀 메타데이터 지정을 참조하세요.
attributes/enable-oslogin enable-oslogin=TRUE를 설정할 경우 이 인스턴스에서 OS 로그인 SSH 키 관리 기능을 사용 설정합니다.
attributes/vmdnssetting 이 인스턴스에 대해 내부 DNS 이름의 형식을 지정하는 방법을 구성합니다. 내부 DNS 이름에 대한 자세한 내용은 DNS 이름 구성을 참조하세요.
attributes/ssh-keys 인스턴스가 SSH 키 관리에 OS 로그인을 사용하도록 구성되지 않은 경우 이 속성을 사용하여 이 인스턴스에 연결할 수 있는 공개 SSH 키를 구성할 수 있습니다. SSH 키가 여러 개인 경우 각 키는 줄바꿈 문자(\n)로 구분됩니다. 이 값은 문자열입니다. OS 로그인에 의해 관리되는 SSH 키는 이 메타데이터 값에 표시되지 않습니다.

예: "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

cpu-platform 인스턴스의 CPU 플랫폼입니다.
description --description 플래그를 사용하여 할당되거나 API에서 설정된 자유 텍스트 형식의 인스턴스 설명입니다.
disks/ 이 인스턴스에 연결된 디스크의 디렉터리입니다.
guest-attributes/ 간헐적인 상태 알림, 소량 데이터, 빈도가 낮은 데이터 등을 게시하는 데 사용할 수 있는 커스텀 인스턴스 메타데이터 값입니다. 이 값은 시작 스크립트가 완료된 시기를 나타내거나 다른 애플리케이션에 다른 간헐적 상태 알림을 제공하는 데 유용합니다. VM 인스턴스의 모든 사용자 또는 프로세스는 'guest-attributes' 메타데이터의 네임스페이스 및 키를 읽고 쓸 수 있습니다.
hostname 인스턴스의 호스트 이름입니다.
id 인스턴스의 ID입니다. Compute Engine에서 생성된 고유한 숫자 ID이며, 인스턴스 이름을 사용하지 않으려는 경우 인스턴스를 식별하는 데 유용합니다.
machine-type 이 인스턴스의 머신 유형에 대한 메타데이터 값으로, projects/[NUMERIC_PROJECT_ID]/machineTypes/[MACHINE_TYPE] 형식으로 사용됩니다.
name 인스턴스 이름입니다.
network-interfaces/ 인스턴스의 네트워크 인터페이스 디렉터리입니다.
network-interfaces/<index>/forwarded-ips/ <index>에 있는 네트워크 인터페이스에 대해 현재 이 가상 머신 인스턴스를 가리키고 있는 외부 IP의 디렉터리입니다. 구체적으로 설명하면 패킷을 이 인스턴스로 보내는 전달 규칙에 따라 제공되는 외부 IP의 목록을 나타냅니다.
scheduling/ 인스턴스의 예약 옵션이 포함된 디렉터리입니다.
scheduling/on-host-maintenance 인스턴스의 투명한 유지보수 이벤트 동작 설정입니다. 이 값은 --on_host_maintenance 플래그를 사용하여 설정하거나 API를 사용하여 설정합니다.
scheduling/automatic-restart 인스턴스의 자동 재시작 설정입니다. 이 값은 ‑‑automatic_restart 플래그를 사용하여 설정하거나 API를 사용하여 설정합니다.
scheduling/preemptible 인스턴스의 선점형 설정입니다. 이 값이 TRUE이면 인스턴스가 선점형입니다. 이 값은 인스턴스를 만들 때 설정하며 변경할 수 없습니다.
maintenance-event 투명한 유지보수 이벤트가 이 인스턴스에 영향을 주고 있음을 나타내는 경로입니다. 자세한 내용은 투명한 유지보수 알림을 참조하세요.
service-accounts/ 인스턴스와 연결된 서비스 계정의 디렉터리입니다.
service-accounts/<service-account-name>/identity 인스턴스에 고유한 JSON 웹 토큰입니다. 이 인스턴스 메타데이터 값에 대한 요청에는 'audience' 매개변수를 포함해야 합니다. 예를 들어 '?audience=http://www.example.com'과 같이 입력합니다. 인스턴스 식별 토큰을 요청하고 확인하는 방법은 인스턴스 ID 확인을 참조하세요.
tags 인스턴스와 연결된 모든 태그입니다.
zone 이 인스턴스가 실행되는 영역의 메타데이터 값입니다. 이 값은 projects/[NUMERIC_PROJECT_ID]/zones/zone 형식으로 사용됩니다.

메타데이터 가져오기

가상 머신 인스턴스 내에서 다음 루트 URL에 대한 요청을 실행하여 메타데이터 서버의 콘텐츠를 쿼리할 수 있습니다. http://metadata.google.internal/computeMetadata/v1/ URL을 사용하여 메타데이터 서버에 대한 요청을 실행합니다.

모든 메타데이터 값은 이러한 루트 URL 아래의 하위 경로로 정의됩니다.

연결된 인스턴스 내에서만 기본 메타데이터 값을 쿼리할 수 있습니다. 인스턴스의 기본 메타데이터를 다른 인스턴스에서 또는 로컬 컴퓨터에서 직접 쿼리할 수는 없습니다. 해당 인스턴스에서 메타데이터 서버에 대해 curl이나 wget과 같은 표준 도구를 사용할 수 있습니다.

메타데이터를 쿼리할 때는 모든 요청에 다음 헤더를 제공해야 합니다.

Metadata-Flavor: Google

이 헤더는 요청이 안전하지 않은 소스에서 의도하지 않게 전송된 것이 아니라 메타데이터 값을 검색하기 위한 목적으로 전송되었음을 나타내며, 이 헤더가 있으면 메타데이터 서버가 요청된 데이터를 반환할 수 있습니다. 이 헤더를 제공하지 않으면 메타데이터 서버에서 요청이 거부됩니다.

X-Forwarded-For 헤더

X-Forwarded-For 헤더가 포함된 요청은 메타데이터 서버에서 자동으로 거부됩니다. 이 헤더는 일반적으로 요청이 프록시되었으며 승인된 사용자가 실행한 요청이 아닐 수 있음을 나타냅니다. 보안상의 이유로 이러한 요청은 모두 거부됩니다.

제한사항

curl 명령어를 사용하여 서버에서 메타데이터를 검색할 때는 요청 경로에서 인코딩된 문자가 지원되지 않습니다. 인코딩된 문자는 쿼리 경로에서만 지원됩니다.

예를 들어 다음 요청은 작동하지 않을 수 있습니다.

curl "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/123456789-compute%40developer.gserviceaccount.com/?query_path=https%3A%2F%2Flocalhost%3A8200%2Fexample%2Fquery&another_param=true" -H "Metadata-Flavor: Google"

이 요청이 작동하도록 하려면 요청 경로에서 지원되지 않는 인코딩된 문자(%40)를 그에 해당하는 허용되는 값(@)으로 바꿔야 합니다.

curl "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts1234567898-compute@developer.gserviceaccount.com/?query_path=https%3A%2F%2Flocalhost%3A8200%2Fexample%2Fquery&another_param=true" -H "Metadata-Flavor: Google"

다음 표에는 요청 경로에서 지원되지 않는 인코딩된 문자가 요약되어 있습니다.

인코딩된 문자 허용되는 값
%21

!
%24

$
%27

'
%28

(
%29

)
%2A

*
%2C

,
%40

@

메타데이터 정보는 안전합니까?

메타데이터 서버에서 정보를 가져오기 위한 요청을 실행할 때 해당 요청과 이후의 메타데이터 응답은 가상 머신 인스턴스를 실행하는 물리적 호스트를 절대 벗어나지 않습니다.

디렉터리 목록 쿼리

메타데이터 서버는 디렉터리를 사용하여 특정한 메타데이터 키를 구성합니다. 후행 슬래시로 끝나는 모든 메타데이터 항목은 디렉터리입니다. 예를 들어 disks/ 항목은 해당 인스턴스에 연결된 디스크의 디렉터리입니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/disks/" -H "Metadata-Flavor: Google"

0/
1/
2/

마찬가지로 디스크 0/ 디렉터리에 대한 추가 정보가 필요하면 해당 디렉터리의 특정 URL을 쿼리하면 됩니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/disks/0/" -H "Metadata-Flavor: Google"

device-name
index
mode
type

엔드포인트 쿼리

메타데이터 키가 디렉터리가 아니라면 하나 이상의 값을 반환하는 엔드포인트에 해당합니다. 예를 들어 특정 디스크의 모드를 쿼리하려면 다음 엔드포인트를 쿼리합니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/disks/0/mode" -H "Metadata-Flavor: Google"

READ_WRITE

기본적으로 각 엔드포인트마다 사전 정의된 응답 형식이 있습니다. 엔드포인트에 따라 기본적으로 JSON 형식의 데이터가 반환될 수도 있고 문자열 형식의 데이터가 반환될 수도 있습니다. alt=json 또는 alt=text 쿼리 매개변수를 사용하여 지정된 기본 데이터 형식을 재정의할 수 있습니다. 이 두 매개변수는 각각 JSON 문자열 형식과 일반 텍스트 형식의 데이터를 반환합니다.

예를 들어 tags 키는 자동으로 JSON 형식의 데이터를 반환합니다. alt=text 쿼리 매개변수를 지정하면 이 형식 대신 텍스트 형식의 데이터가 반환될 수 있습니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/tags" -H "Metadata-Flavor: Google"

["bread","butter","cheese","cream","lettuce"]
user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/tags?alt=text" -H "Metadata-Flavor: Google"

bread
butter
cheese
cream
lettuce

재귀적 메타데이터 쿼리

특정 디렉터리 아래의 모든 콘텐츠를 반환하려면 요청에 recursive=true 쿼리 매개변수를 사용하세요.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/disks/?recursive=true" -H "Metadata-Flavor: Google"

[{"deviceName":"boot","index":0,"mode":"READ_WRITE","type":"PERSISTENT"},
{"deviceName":"persistent-disk-1","index":1,"mode":"READ_WRITE","type":"PERSISTENT"},
{"deviceName":"persistent-disk-2","index":2,"mode":"READ_ONLY","type":"PERSISTENT"}]

기본적으로 재귀적 콘텐츠는 JSON 형식으로 반환됩니다. 이러한 콘텐츠가 텍스트 형식으로 반환되도록 하려면 alt=text 쿼리 매개변수를 추가하세요.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/disks/?recursive=true&alt=text" -H "Metadata-Flavor: Google"

0/device-name boot
0/index 0
0/mode READ_WRITE
0/type PERSISTENT
1/device-name persistent-disk-1
1/index 1
1/mode READ_WRITE
1/type PERSISTENT
2/device-name persistent-disk-1
2/index 2
2/mode READ_ONLY
2/type PERSISTENT

부울 값 설정

부울 값 TRUE 또는 FALSE을 허용하는 필드의 경우 다음 값도 사용할 수 있습니다.

상태 대체 값
TRUE Y, 예, 1
FALSE N, 아니요, 0

부울 값은 대소문자를 구분하지 않습니다. 예를 들면 False, false, FALSE를 사용하여 기능을 사용 중지할 수 있습니다.

커스텀 메타데이터 설정

Google Cloud Console, gcloud 명령줄 도구 또는 Compute Engine API에서 인스턴스 또는 프로젝트의 커스텀 메타데이터를 설정할 수 있습니다. 커스텀 메타데이터는 프로젝트 또는 인스턴스에 임의의 값을 전달할 때 유용하며, 시작종료 스크립트를 설정하는 데도 유용합니다.

커스텀 메타데이터 크기 제한

Compute Engine은 커스텀 메타데이터 값에 다음과 같은 길이 제한을 적용합니다.

  • 개별 메타데이터 항목: 256KB
  • 인스턴스별 모든 메타데이터 항목의 합계: 512KB

특히 SSH 키는 ssh-keys 키 아래에 커스텀 메타데이터로 저장됩니다. 이 키의 메타데이터 콘텐츠가 256KB 제한을 초과하면 더 이상 SSH 키를 추가할 수 없습니다. 이 제한에 도달하면 사용하지 않는 키를 삭제하여 새로운 키를 위한 메타데이터 공간을 확보하는 것이 좋습니다.

시작 또는 종료 스크립트 콘텐츠를 직접 제공하는 경우 시작 및 종료 스크립트 콘텐츠도 커스텀 메타데이터로 저장되어 이러한 크기 제한 계산 시 합산될 수 있습니다. 이를 방지하려면 시작 또는 종료 스크립트를 Cloud Storage 등의 외부 위치에서 호스팅되는 파일로 저장하고, 인스턴스를 만들 때 시작 스크립트 URL을 제공하세요. 이러한 파일은 메타데이터 서버에 저장되지 않고 VM 인스턴스에 다운로드됩니다.

인스턴스 메타데이터 설정

Cloud Console, gcloud 도구, API에서 인스턴스의 커스텀 메타데이터를 설정합니다. 인스턴스 메타데이터는 특정 인스턴스에만 적용됩니다.

인스턴스 생성 중 메타데이터 설정

Console

  1. GCP Console에서 VM 인스턴스 페이지로 이동합니다.

    VM 인스턴스 페이지로 이동

  2. 인스턴스 만들기를 클릭합니다.
  3. 새 인스턴스 만들기 페이지에서 인스턴스의 속성을 입력합니다.
  4. 메타데이터 섹션에서 커스텀 메타데이터의 키-값 쌍을 필요한 만큼 입력합니다.
  5. 만들기를 클릭하여 인스턴스를 만듭니다.

gcloud

gcloud 명령줄 도구에서 --metadata 플래그를 사용하여 커스텀 메타데이터를 설정합니다.

gcloud compute instances create example-instance \
    --metadata foo=bar

API

API에서 요청에 메타데이터 속성의 일부로 커스텀 메타데이터를 제공합니다.

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances

{
  "...
        }
      ]
    }
  ],
  "metadata": {
    "items": [
      {
       "key": "foo",
       "value": "bar"
      }
    ]
  },
  ..
}

실행 중인 인스턴스에서 메타데이터 업데이트

Console

  1. Google Cloud Console에서 VM 인스턴스 페이지로 이동합니다.

    VM 인스턴스 페이지로 이동

  2. 메타데이터를 업데이트할 인스턴스를 클릭합니다.
  3. 페이지 상단에서 수정 버튼을 클릭합니다.
  4. 커스텀 메타데이터에서 항목 추가를 클릭하거나 기존 메타데이터 항목을 수정합니다.
  5. 변경사항을 저장합니다.

gcloud

gcloud 도구로 인스턴스 메타데이터를 업데이트하는 것은 추가 작업입니다. 추가하거나 변경할 메타데이터 키만 지정하세요. 제공한 키가 이미 존재하면 키 값이 새 값으로 업데이트됩니다.

gcloud 명령줄 도구를 사용하여 instances add-metadata 명령어를 실행합니다.

gcloud compute instances add-metadata instance-name \
      --metadata bread=mayo,cheese=cheddar,lettuce=romaine

lettuce=romaine 항목을 lettuce=green으로 변경하려면 다음 명령어를 사용합니다.

gcloud compute instances add-metadata instance-name \
    --metadata lettuce=green

lettuce=romaine 항목을 삭제하려면 기존 키를 지정하고 해당 값을 제외합니다.

gcloud compute instances remove-metadata instance-name \
    --keys lettuce

API

API에서 instances().setMetadata 메서드에 대한 요청을 실행합니다. 새 메타데이터 값과 현재 fingerprint 값의 목록을 제공하세요.

디지털 지문은 Compute Engine에서 생성된 임의의 문자열로서 낙관적 잠금을 수행하는 데 사용됩니다. 일치하는 디지털 지문 값을 제공하여 요청을 실행하세요. 디지털 지문은 요청 시마다 변경되며 일치하지 않는 디지털 지문을 제공하면 요청이 거부됩니다. 이런 방식으로 한 번에 한 가지 업데이트만 실행할 수 있어 충돌이 방지됩니다.

인스턴스의 현재 디지털 지문을 가져오고 인스턴스의 기존 키-값 쌍을 확인하려면 instances().get 요청을 전송합니다.

GET https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances/example-instance

{
 ...
 "name": "example-instance",
 "metadata": {
  "kind": "compute#metadata",
  "fingerprint": "zhma6O1w2l8="
  "items": [
   {
    "key": "foo",
    "value": "bar"
   }
  ]
 },
 ...
}

그런 다음 instances().setMetadata 메서드에 대한 요청을 실행하고 커스텀 메타데이터 키-값 쌍을 설정합니다. 인스턴스의 기존 키-값 쌍 중 일부를 유지하려면 이를 새 키-값 쌍과 함께 요청에 포함해야 합니다.

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances/example-instance/setMetadata

{
 "fingerprint": "zhma6O1w2l8=",
 "items": [
  {
   "key": "foo",
   "value": "bar"
  },
  {
   "key": "baz",
   "value": "bat"
  }
 ]
}

인스턴스에서 모든 메타데이터 키-값 쌍을 삭제하려면 instances().setMetadata 요청을 지정하고 items 속성을 제외합니다. 이 요청이 성공하려면 현재 메타데이터 지문 속성을 포함해야 합니다.

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances/example-instance/setMetadata

{ "fingerprint": "5rC_DXxBUZw=" }

프로젝트 차원의 커스텀 메타데이터 설정

프로젝트의 모든 인스턴스에 메타데이터를 적용하려면 프로젝트 차원의 메타데이터를 설정합니다. 예를 들어 baz=bat라는 프로젝트 차원의 메타데이터 쌍을 정의하면 이 메타데이터 쌍이 자동으로 프로젝트의 모든 인스턴스에 적용됩니다.

Console

  1. Google Cloud Console에서 메타데이터 페이지로 이동합니다.

    메타데이터 페이지로 이동

  2. 수정을 클릭합니다.
  3. 메타데이터 항목을 추가하거나 수정합니다.
  4. 변경사항을 저장합니다.

gcloud

gcloud 명령줄 도구를 사용하여 project-info add-metadata 명령어를 실행합니다. 예를 들면 다음과 같습니다.

gcloud compute project-info add-metadata \
    --metadata foo=bar,baz=bat

describe 명령어를 사용하여 메타데이터를 확인합니다.

gcloud compute project-info describe

예를 들어 다음과 비슷한 응답이 표시됩니다.

...
commonInstanceMetadata:
  fingerprint: RfOFY_-eS64=
  items:

  • key: baz value: bat
  • key: foo value: bar
  • key: ssh-keys ...
메타데이터 키-값 쌍 하나는 등호로 연결되어 지정됩니다(예: key=value). 여러 개의 키-값 쌍은 공백으로 구분됩니다.

필요에 따라 --metadata-from-file 플래그를 사용하여 메타데이터를 읽을 파일을 하나 이상 지정할 수 있습니다. project-info remove-metadata 명령어를 사용하면 메타데이터 값을 삭제할 수 있습니다.

API

API에서 projects().setCommonInstanceMetadata 메서드에 대한 요청을 실행하고 모든 새 메타데이터 값과 fingerprint 값을 제공합니다.

디지털 지문은 Compute Engine에서 생성된 임의의 문자열로서 낙관적 잠금을 수행하는 데 사용됩니다. 일치하는 디지털 지문 값을 제공하여 요청을 실행하세요. 디지털 지문은 요청 시마다 변경되며 일치하지 않는 디지털 지문을 제공하면 요청이 거부됩니다. 이런 방식으로 한 번에 한 가지 업데이트만 실행할 수 있어 충돌이 방지됩니다.

인스턴스의 현재 디지털 지문을 가져오려면 project().get 요청을 실행하고 디지털 지문 값을 복사합니다.

GET https://compute.googleapis.com/compute/v1/projects/myproject

{
 "name": "myproject",
 "commonInstanceMetadata": {
  "kind": "compute#metadata",
  "fingerprint": "FikclA7UBC0=",
  ...
}

그런 다음 projects().setCommonInstanceMetadata 메서드에 대한 요청을 실행하고 커스텀 메타데이터 키-값 쌍을 설정합니다.

POST https://compute.googleapis.com/compute/v1/projects/myproject/setCommonInstanceMetadata

{
 "fingerprint": "FikclA7UBC0=",
 "items": [
  {
   "key": "foo",
   "value": "bar"
  }
 ]
}

커스텀 메타데이터 쿼리

Cloud Console, gcloud 명령줄 도구, API를 통해 커스텀 인스턴스 또는 프로젝트 메타데이터를 쿼리합니다.

Console

프로젝트 차원의 커스텀 메타데이터를 확인하려면 메타데이터 페이지로 이동합니다.

인스턴스의 커스텀 메타데이터를 확인하려면 다음 안내를 따르세요.

  1. VM 인스턴스 페이지로 이동합니다.
  2. 메타데이터를 확인하려는 인스턴스를 클릭합니다.
  3. 커스텀 메타데이터에서 인스턴스의 커스텀 메타데이터를 확인합니다.

gcloud

프로젝트 메타데이터 쿼리:

gcloud compute project-info describe \
    --flatten="commonInstanceMetadata[]"

인스턴스 메타데이터 쿼리:

gcloud compute instances describe example-instance \
    --flatten="metadata[]"

--flatten 플래그를 사용하여 관련 메타데이터 키에 대한 출력 범위를 지정할 수 있습니다. 예를 들어 다음 인스턴스에는 커스텀 메타데이터 키-값 쌍 foo:bar가 있습니다.

$ gcloud compute instances describe example-instance

...
metadata:
  fingerprint: Cad2L9eKNR0=
  items:
  - key: foo
    value: bar
  kind: compute#metadata
...

foo 키의 값을 쿼리하려면 다음을 실행합니다.

gcloud compute instances describe example-instance \
    --flatten="metadata[foo]"

---
  bar

API

프로젝트의 메타데이터를 쿼리하려면 projects().get 메서드에 대한 빈 요청을 실행합니다.

GET https://compute.googleapis.com/compute/v1/projects/myproject

인스턴스의 메타데이터를 쿼리하려면 instance().get 메서드에 대한 빈 요청을 실행합니다.

GET https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances/example-instance

게스트 속성 설정 및 쿼리

게스트 속성은 애플리케이션이 인스턴스에서 실행되는 동안 쓸 수 있는 특정 유형의 커스텀 메타데이터입니다. 인스턴스의 모든 애플리케이션 또는 사용자는 이러한 게스트 속성 메타데이터 값을 읽고 여기에 데이터를 쓸 수 있습니다.

게스트 속성을 사용하는 경우

게스트 속성은 자주 변경되지 않는 소량의 데이터가 필요한 경우에만 사용합니다. 게스트 속성을 사용하기에 가장 적합한 경우는 다음과 같습니다.

  • 쿼리 수가 VM 인스턴스별로 분당 최대 10개로 제한되어 있습니다.
  • 쿼리 수가 버스트 비율, 즉 초당 3개를 초과하지 않습니다. 이 최대 비율을 초과하면 Compute Engine이 현재 쓰고 있는 게스트 속성을 임의로 삭제할 수 있습니다. 이 데이터 삭제는 다른 중요한 시스템 데이터가 서버에 쓸 수 있도록 하는 데 필요합니다.

게스트 속성은 간헐적인 소량의 데이터를 게시해야 하는 상황에 매우 적합합니다. 예를 들어 게스트 속성은 다음과 같은 경우에 유용합니다.

  • 시작 스크립트에서 게스트 속성에 커스텀 상태 값을 설정하여 초기화 성공 시 이를 알릴 수 있습니다.
  • 구성 관리 에이전트에서 게스트 OS의 이름과 버전을 게스트 속성에 게시할 수 있습니다.
  • 인벤토리 관리 에이전트에서 VM 인스턴스에 설치된 패키지의 목록을 게스트 속성에 게시할 수 있습니다.
  • 워크로드 조정 소프트웨어에서 게스트 속성에 커스텀 상태 값을 설정하여 게스트 내에서의 작업 완료 시 이를 소프트웨어 제어 영역에 알릴 수 있습니다.

게스트 속성은 이벤트 스트리밍, Pub/Sub 또는 기타 형태의 데이터 스토리지 및 구성 저장소를 대체하지 않습니다.

인스턴스 내에서 읽고 쓸 때는 메타데이터 서버가 인스턴스 수준의 자동 인증 및 승인을 제공합니다. 각 인스턴스는 자체 메타데이터 서버에서만 읽거나 쓸 수 있습니다. 다른 인스턴스는 다른 인스턴스의 메타데이터 서버에 액세스할 수 없습니다. compute.instances.getGuestAttributes 권한을 제공하는 Cloud Identity and Access Management 역할이 있는 사용자 및 서비스 계정만이 인스턴스 외부에서 인스턴스의 게스트 속성을 읽을 수 있습니다.

인스턴스에서 게스트 속성 사용 설정

기본적으로 게스트 속성은 사용 중지되어 있습니다. 게스트 속성을 사용 설정하려면 개별 인스턴스 또는 프로젝트 차원의 메타데이터에서 필요한 메타데이터 값을 설정합니다.

Console

인스턴스를 만들 때 인스턴스 메타데이터에 enable-guest-attributes 설정:

  1. Google Cloud Console에서 VM 인스턴스 페이지로 이동합니다.

    VM 인스턴스 페이지로 이동

  2. 인스턴스 만들기를 클릭합니다.
  3. 새 인스턴스 만들기 페이지에서 원하는 인스턴스 속성을 입력합니다.
  4. 메타데이터 섹션에서 키가 enable-guest-attributes이고 값이 TRUE인 메타데이터 항목을 추가합니다.
  5. 만들기를 클릭하여 인스턴스를 만듭니다.

프로젝트의 모든 인스턴스에 적용되도록 프로젝트 차원의 메타데이터에 enable-guest-attributes 설정:

  1. Google Cloud Console에서 메타데이터 페이지로 이동합니다.

    메타데이터 페이지로 이동

  2. 수정을 클릭합니다.
  3. 키는 enable-guest-attributes이고 값은 TRUE인 메타데이터 항목을 추가합니다. 또는 값을 FALSE로 설정해서 이 기능을 사용 중지합니다.
  4. 저장을 클릭하여 변경사항을 적용합니다.

기존 인스턴스의 메타데이터에 enable-guest-attributes 설정:

  1. Google Cloud Console에서 VM 인스턴스 페이지로 이동합니다.

    VM 인스턴스 페이지로 이동

  2. 메타데이터 값을 설정할 인스턴스의 이름을 클릭합니다.
  3. 인스턴스 세부정보 페이지 상단에서 수정을 클릭해 인스턴스 설정을 수정합니다.
  4. 커스텀 메타데이터에서 키가 enable-guest-attributes이고 값이 TRUE인 메타데이터 항목을 추가합니다. 또는 값을 FALSE로 설정하여 기능에서 인스턴스를 제외합니다.
  5. 인스턴스 세부정보 페이지 하단에 있는 저장을 클릭해 변경사항을 인스턴스에 적용합니다.

gcloud

인스턴스를 만들 때 인스턴스 메타데이터에 enable-guest-attributes 설정:

gcloud 명령줄 도구에서 gcloud compute instances create 명령어를 사용하고 enable-guest-attributes=TRUE를 설정하여 게스트 속성을 사용 설정합니다. 여기에서 instance-name을 인스턴스 이름으로 바꿉니다.

gcloud compute instances create instance-name \
    --metadata enable-guest-attributes=TRUE

프로젝트의 모든 인스턴스에 적용되도록 프로젝트 차원의 메타데이터에 enable-guest-attributes 설정:

gcloud 명령줄 도구에서 project-info add-metadata 명령어를 사용하고 enable-guest-attributes=TRUE를 설정하여 게스트 속성을 사용 설정합니다.

gcloud compute project-info add-metadata \
    --metadata enable-guest-attributes=TRUE

또는 enable-guest-attributesFALSE로 설정해 게스트 속성을 사용 중지합니다.

기존 인스턴스의 메타데이터에 enable-guest-attributes 설정:

gcloud 명령줄 도구에서 instances add-metadata 명령어를 사용하고 enable-guest-attributes=TRUE를 설정하여 게스트 속성을 사용 설정합니다. 여기에서 instance-name을 인스턴스 이름으로 바꿉니다.

gcloud compute instances add-metadata instance-name \
    --metadata enable-guest-attributes=TRUE

또는 enable-guest-attributesFALSE로 설정해 해당 인스턴스에서 게스트 속성을 사용하지 않도록 합니다.

게스트 속성 설정

sudo 또는 관리자 수준 권한이 없는 스크립트 및 애플리케이션을 비롯하여 가상 머신 인스턴스에서 실행되는 모든 프로세스는 게스트 속성 값을 쓸 수 있습니다. 인스턴스 외부의 사용자 또는 서비스 계정은 게스트 속성 메타데이터 값을 쓸 수 없습니다.

예를 들어 인스턴스 내에서 curl 요청을 사용하여 guest-attributes 메타데이터 경로에 값을 쓸 수 있습니다.

curl -X PUT --data "value" http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/namespace/key -H "Metadata-Flavor: Google"

각 입력 항목은 다음과 같이 바꿉니다.

  • namespace: key의 논리적 그룹입니다. 게스트 속성에는 네임스페이스가 있어야 합니다.
  • value: 쓰려는 값입니다.
  • key: 값이 저장된 guest-attributes 내의 메타데이터 경로입니다.

namespacekey 필드에는 문자, 숫자, 밑줄(_), 하이픈(-)만 사용합니다.

게스트 속성 가져오기

compute.instances.getGuestAttributes 권한을 제공하는 Cloud IAM 역할이 있는 사용자 또는 서비스 계정은 게스트 속성을 읽을 수 있습니다. 또는 인스턴스 내의 모든 사용자 또는 애플리케이션은 해당 인스턴스의 메타데이터 값을 읽을 수 있습니다.

sudo 또는 관리자 수준 권한이 없는 스크립트 및 애플리케이션을 비롯하여 가상 머신에서 실행되는 모든 프로세스는 게스트 속성 값을 쓸 수 있습니다. 예를 들어 인스턴스 내에서 curl 요청을 사용하여 guest-attributes 메타데이터 경로의 값을 읽을 수 있습니다.

curl http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/namespace/key -H "Metadata-Flavor: Google"

각 입력 항목은 다음과 같이 바꿉니다.

  • namespace: 쿼리하려는 guest-attributes 키의 네임스페이스입니다.
  • key: 메타데이터 값을 읽으려는 guest-attributes 내의 경로입니다.

또는 한 번의 요청으로 모든 게스트 속성 값을 확인할 수 있습니다. namespace를 쿼리하려는 guest-attributes 키의 네임스페이스로 바꿉니다.

curl http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/namespace/ -H "Metadata-Flavor: Google"

gcloud

gcloud 명령줄 도구를 사용하여 인스턴스의 게스트 속성 메타데이터 값을 읽습니다. 예를 들어 인스턴스의 모든 값을 검색할 수 있습니다.

gcloud compute instances get-guest-attributes instance-name \
    --zone zone

특정 네임스페이스에서 모든 값을 검색하려면 --query-path 플래그와 정의된 네임스페이스를 포함합니다.

gcloud compute instances get-guest-attributes instance-name \
    --query-path=namespace \
    --zone zone

특정 네임 스페이스의 모든 값을 검색하려면 --query-path 플래그, 네임스페이스, 그리고 정의된 값의 키를 포함합니다.

gcloud compute instances get-guest-attributes instance-name \
    --query-path=namespace/key \
    --zone zone

각 입력 항목은 다음과 같이 바꿉니다.

  • instance-name: 게스트 속성 메타데이터 값을 읽으려는 인스턴스의 이름입니다.
  • namespace: 쿼리하려는 guest-attributes 키의 네임스페이스입니다.
  • key: 값이 저장된 guest-attributes 메타데이터 내의 경로입니다.
  • zone: 인스턴스가 있는 영역입니다.

API

compute.instances.getguestattributes API 메서드를 사용합니다.

GET https://compute.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name/getGuestAttributes?queryPath=namespace/key

각 입력 항목은 다음과 같이 바꿉니다.

  • project-id: 프로젝트 ID입니다.
  • zone: 인스턴스가 있는 영역입니다.
  • instance-name: 게스트 속성 메타데이터 값을 읽으려는 인스턴스의 이름입니다.
  • namespace: 쿼리하려는 guest-attributes 키의 네임스페이스입니다.
  • key: 값이 저장된 guest-attributes 메타데이터 내의 경로입니다.

namespace의 모든 키를 검색하려면 key를 생략합니다.

GET https://compute.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name/getGuestAttributes?queryPath=namespace

인스턴스 내 각 네임스페이스의 모든 키를 검색하려면 namespacequeryPath를 완전히 생략합니다.

GET https://compute.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name/getGuestAttributes

OAuth 토큰이 있다면 curl을 사용할 수도 있습니다.

curl -H "Authorization: Bearer oauth-token" https://compute.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name/getGuestAttributes?queryPath=namespace/key

각 입력 항목은 다음과 같이 바꿉니다.

  • oauth-token: OAuth 토큰입니다.
  • project-id: 프로젝트 ID입니다.
  • zone: 인스턴스가 있는 영역입니다.
  • instance-name: 게스트 속성 메타데이터 값을 읽으려는 인스턴스의 이름입니다.
  • namespace: 쿼리하려는 guest-attributes 키의 네임스페이스입니다.
  • key: 값이 저장된 guest-attributes 메타데이터 내의 경로입니다.

게스트 속성 삭제

게스트 속성을 삭제할 수도 있습니다. 예를 들어 curl을 사용하여 특정 키를 삭제할 수 있습니다.

curl -X DELETE http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/namespace/key -H "Metadata-Flavor: Google"

각 입력 항목은 다음과 같이 바꿉니다.

  • namespace: 삭제하려는 guest-attributes 키의 네임스페이스입니다.
  • key: 값이 저장되는 guest-attributes 내의 경로입니다.

조직 또는 폴더에서 게스트 속성 사용 중지

조직 또는 폴더의 모든 인스턴스에서 게스트 속성을 사용하지 않으려면 이 기능을 재정의하고 완전히 사용 중지하면 됩니다.

조직 또는 폴더에서 constraints/compute.disableGuestAttributesAccess 제약조건을 설정하고 project-id를 프로젝트 이름으로 바꿉니다.

gcloud resource-manager org-policies enable-enforce \
    constraints/compute.disableGuestAttributesAccess \
    --project project-id

조직에서 제약조건을 설정하고 관리하는 방법을 자세히 알아보려면 제약조건 사용을 읽어보세요.

업데이트 대기

인스턴스 실행 중에 메타데이터 값이 변경될 수 있으므로 변경사항 대기 기능을 사용하여 메타데이터 서버에 메타데이터 변경사항을 알릴 수 있습니다. 이 기능을 사용하면 지정된 메타데이터가 변경된 경우에만 결과를 반환하는 지연 HTTP GET 요청을 실행할 수 있습니다. 커스텀 메타데이터 또는 서버 정의 메타데이터에 이 기능을 사용할 수 있으므로, 인스턴스 또는 프로젝트에 대한 변경사항이 발생하는 경우나 누군가 커스텀 메타데이터를 업데이트하는 경우에 프로그래매틱 방식으로 변경사항에 대응할 수 있습니다. 예를 들어 tags 키에 대한 요청을 실행하면서 태그 메타데이터의 내용이 변경된 경우에만 요청 결과가 반환되도록 할 수 있습니다. 요청이 반환되면 해당 메타데이터 키의 새 값을 제공합니다.

변경사항 대기 요청을 실행하려면 메타데이터 키를 쿼리하고 ?wait_for_change=true 쿼리 매개변수를 추가합니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=true" -H "Metadata-Flavor: Google"

지정한 메타데이터 키가 변경되면 새 값과 함께 쿼리 결과가 반환됩니다. 이 예에서 setInstanceTags 메소드에 대한 요청이 생성되면 요청이 새 값과 함께 반환됩니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=true" -H "Metadata-Flavor: Google"

cheese
lettuce

디렉터리 콘텐츠에 대해 재귀적으로 변경사항 대기 요청을 수행할 수도 있습니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/attributes/?recursive=true&wait_for_change=true" -H "Metadata-Flavor: Google"

변경사항이 있으면 메타데이터 서버가 새로운 콘텐츠를 반환합니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/attributes/?recursive=true&wait_for_change=true" -H "Metadata-Flavor: Google"

{"cheese":"lettuce","cookies":"cream"}

변경사항 대기 기능을 사용하면 요청과 함께 일치 여부 검사를 수행하고 제한 시간을 설정할 수도 있습니다.

ETags 사용

간단한 변경사항 대기 쿼리를 제출하면 메타데이터 서버는 메타데이터의 콘텐츠에 변경사항이 있을 경우에 응답을 반환합니다. 하지만 메타데이터 업데이트와 제출되는 변경사항 대기 요청 사이에서 경합 상태가 발생할 수 있으므로 최신 메타데이터 값을 가져오고 있는지 확인하기 위한 신뢰할 수 있는 방법이 있으면 유용합니다.

이를 위해 last_etag 쿼리 매개변수를 사용하여 사용자가 제공하는 ETag 값과 메타데이터 서버에 저장된 ETag 값을 비교할 수 있습니다. ETag 값이 일치하면 변경사항 대기 요청이 승인됩니다. ETag 값이 일치하지 않는다면 이는 마지막으로 ETag 값을 검색한 이후 메타데이터의 콘텐츠가 변경되었음을 나타내며, 메타데이터 서버는 즉시 이 최신 값을 반환합니다.

메타데이터 키의 현재 ETag 값을 가져오려면 해당 키에 대한 요청을 실행하고 헤더를 출력합니다. curl에서는 -v 플래그를 사용하여 이를 수행할 수 있습니다.

user@myinst:~$ curl -v "http://metadata.google.internal/computeMetadata/v1/instance/tags" -H "Metadata-Flavor: Google"
* About to connect() to metadata port 80 (#0)
*   Trying 169.254.169.254... connected
* Connected to metadata (169.254.169.254) port 80 (#0)
> GET /computeMetadata/v1/instance/tags HTTP/1.1
> User-Agent: curl/7.19.7 (x86_64-pc-linux-gnu) libcurl/7.19.7 OpenSSL/0.9.8k zlib/1.2.3.3 libidn/1.15
> Host: metadata
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: application/text
< ETag: 411261ca6c9e654e
< Date: Wed, 13 Feb 2013 22:43:45 GMT
< Server: Metadata Server for VM
< Content-Length: 26
< X-XSS-Protection: 1; mode=block
< X-Frame-Options: SAMEORIGIN
<
cheese
lettuce

그런 다음 변경사항 대기 요청에 해당 ETag 값을 사용할 수 있습니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=true&last_etag=411261ca6c9e654e" -H "Metadata-Flavor: Google"

메타데이터 서버는 지정된 ETag 값의 일치 여부를 검사한 후 이 값이 변경되었으면 메타데이터 키의 새로운 콘텐츠와 함께 요청 결과가 반환됩니다.

다음 Python 샘플은 프로그래매틱 방식으로 메타데이터 서버에서 변경사항을 감시하는 방법을 보여줍니다.

last_etag = '0'

while True:
    r = requests.get(
        url,
        params={'last_etag': last_etag, 'wait_for_change': True},
        headers=METADATA_HEADERS)

    # During maintenance the service can return a 503, so these should
    # be retried.
    if r.status_code == 503:
        time.sleep(1)
        continue
    r.raise_for_status()

    last_etag = r.headers['etag']

제한 시간 설정

변경사항 대기 요청이 일정 시간(초) 후에 시간 초과되도록 하려는 경우 timeout_sec=<timeout-in-seconds> 쿼리 매개변수를 설정할 수 있습니다. timeout_sec 매개변수는 요청의 대기 시간을 지정된 시간(초)으로 제한하고, 요청이 이 제한에 도달하면 메타데이터 키의 현재 콘텐츠를 반환합니다. 다음은 360초 후에 시간 초과되도록 설정된 변경사항 대기 요청의 예시입니다.

user@myinst:~$ curl "http://metadata.google.internal/computeMetadata/v1/instance/tags?wait_for_change=true&timeout_sec=360" -H "Metadata-Flavor: Google"

timeout_sec 매개변수를 설정하면 메타데이터 값이 실제로 변경되었는지 여부에 관계없이 지정된 시간(초) 후에 항상 요청 결과가 반환됩니다. 제한 시간에는 정수 값만 설정할 수 있습니다.

상태 코드

변경사항 대기 요청을 수행하면 메타데이터 서버가 성공 또는 실패를 나타내는 표준 HTTP 상태 코드를 반환합니다. 오류가 발생하면 네트워크 상태로 인해 메타데이터 서버에서 요청이 실패하고 오류 코드가 반환될 수 있습니다. 이러한 경우 내결함성을 유지하고 이러한 오류를 인식하고 처리할 수 있도록 애플리케이션을 설계해야 합니다.

메타데이터 서버에서 반환할 수 있는 상태는 다음과 같습니다.

상태 설명
HTTP 200 성공! 값이 변경되었거나 지정된 timeout_sec에 도달하여 요청 결과가 성공적으로 반환되었습니다.
Error 400 요청이 잘못되었습니다. 쿼리를 수정하고 요청을 다시 시도하세요.
Error 404 지정한 메타데이터 값이 더 이상 존재하지 않습니다. 변경사항을 기다리는 동안 메타데이터가 삭제된 경우에도 메타데이터 서버에서 이 오류를 반환합니다.
Error 503 임시 서버 오류 또는 임시 유지관리 이벤트가 있었습니다. 요청을 다시 시도하세요.

라이브 마이그레이션 알림 받기

메타데이터 서버는 scheduling/ 디렉터리와 maintenance-event 속성을 통해 인스턴스의 예약 옵션 및 설정에 대한 정보를 제공합니다. 이러한 속성을 사용하여 가상 머신 인스턴스의 예약 옵션을 알아보고, 이 메타데이터를 사용하여 maintenance-event 속성을 통한 유지보수 이벤트가 발생하려고 할 때 알림을 받을 수 있습니다. 기본적으로 모든 가상 머신 인스턴스는 라이브 마이그레이션되도록 설정되어 있으므로 메타데이터 서버는 VM 인스턴스가 라이브 마이그레이션되기 전에 유지보수 이벤트 알림을 받습니다. 유지보수 시 VM 인스턴스를 종료하도록 선택했다면 Compute Engine이 VM 인스턴스를 자동으로 종료하고 필요에 따라 다시 시작합니다(automaticRestart 속성이 설정된 경우). 유지보수 이벤트와 유지보수 이벤트 시 인스턴스 동작에 대한 자세한 내용은 예약 옵션 및 설정을 참조하세요.

maintenance-event 속성을 주기적으로 쿼리하면 유지보수 이벤트가 언제 발생할지 알 수 있습니다. 이 속성의 값은 유지보수 이벤트가 시작되기 60초 전에 변경되며, 따라서 애플리케이션 코드에서 유지보수 이벤트 전에 수행할 데이터 백업 또는 로그 업데이트 등의 작업을 트리거할 수 있습니다. Compute Engine은 유지보수 이벤트 알림을 확인하는 방법을 보여주는 샘플 Python 스크립트도 제공합니다.

Compute Engine은 다음과 같은 경우에만 60초 경고를 제공합니다.

  • 유지보수 이벤트 중에 라이브 마이그레이션되도록 인스턴스의 가용성 옵션을 설정한 경우

  • 마지막 유지보수 이벤트 이후로 maintenance-event 속성을 한 번 이상 쿼리한 경우. maintenance-event 속성을 쿼리한 적이 전혀 없거나 마지막 마이그레이션 이후로 쿼리한 적이 없으면 Compute Engine은 인스턴스에 유지보수 이벤트의 사전 경고가 필요하지 않다고 간주합니다. 따라서 60초 경고를 건너뛰고 대신 유지보수 이벤트가 즉시 시작됩니다. 60초 경고를 건너뛰지 않으려면 마이그레이션 이벤트 사이에 클라이언트 코드에서 maintenance-event 속성을 한 번 이상 쿼리해야 합니다.

maintenance-event 속성을 쿼리하는 방법은 다음과 같습니다.

user@myinst:~$ curl http://metadata.google.internal/computeMetadata/v1/instance/maintenance-event -H "Metadata-Flavor: Google"

NONE

maintenance-event 속성의 초기 값과 기본값은 NONE입니다.

GPU 인스턴스의 경우 유지보수 이벤트 중에 속성이 NONE에서 TERMINATE_ON_HOST_MAINTENANCE로 변경됩니다. 이 속성은 종료 이벤트가 시작되기 60분 전에 업데이트됩니다.

예약 옵션이 migrate인 비GPU 인스턴스의 경우 maintenance-event 속성이 다음과 같이 변경됩니다.

  1. 마이그레이션 이벤트가 시작되면 값이 NONE에서 MIGRATE_ON_HOST_MAINTENANCE로 변경됩니다.
  2. 이벤트의 지속 기간 내내 그리고 VM 인스턴스가 라이브 마이그레이션되는 동안 이 값은 MIGRATE_ON_HOST_MAINTENANCE로 유지됩니다.
  3. 유지보수 이벤트가 종료된 후에는 값이 NONE으로 되돌아갑니다.

maintenance-event 속성을 업데이트 대기 기능과 함께 사용하면 유지보수 이벤트의 시작 및 종료 전에 스크립트 및 애플리케이션에 이를 알릴 수 있습니다. 이렇게 하면 이벤트 전후에 실행할 모든 작업을 자동화할 수 있습니다. 다음 Python 샘플은 이 두 기능을 함께 구현하는 방법의 예시를 보여줍니다.

유지보수 이벤트 쿼리를 위한 샘플 Python 스크립트


import time

import requests

METADATA_URL = 'http://metadata.google.internal/computeMetadata/v1/'
METADATA_HEADERS = {'Metadata-Flavor': 'Google'}

def wait_for_maintenance(callback):
    url = METADATA_URL + 'instance/maintenance-event'
    last_maintenance_event = None
    last_etag = '0'

    while True:
        r = requests.get(
            url,
            params={'last_etag': last_etag, 'wait_for_change': True},
            headers=METADATA_HEADERS)

        # During maintenance the service can return a 503, so these should
        # be retried.
        if r.status_code == 503:
            time.sleep(1)
            continue
        r.raise_for_status()

        last_etag = r.headers['etag']

        if r.text == 'NONE':
            maintenance_event = None
        else:
            maintenance_event = r.text

        if maintenance_event != last_maintenance_event:
            last_maintenance_event = maintenance_event
            callback(maintenance_event)

def maintenance_callback(event):
    if event:
        print('Undergoing host maintenance: {}'.format(event))
    else:
        print('Finished host maintenance')

def main():
    wait_for_maintenance(maintenance_callback)

if __name__ == '__main__':
    main()

서버 엔드포인트의 버전 확인

메타데이터 서버 엔드포인트의 버전을 확인하려면 서버에 대해 요청을 실행하는 데 사용하는 URI를 검토하세요.

메타데이터 엔드포인트 버전 URI
v0.1 http://metadata.google.internal/0.1/meta-data/…
v1beta1 http://metadata.google.internal/computeMetadata/v1beta1/…
v1 http://metadata.google.internal/computeMetadata/v1/…

기존 엔드포인트 사용 중지

v0.1 및 v1beta1 메타데이터 서버 엔드포인트의 서비스 종료에 대비해서 프로젝트 또는 인스턴스 수준에서 이러한 엔드포인트를 사용 중지할 수 있습니다.

v0.1 및 v1beta1 메타데이터 서버 엔드포인트를 사용 중지하려면 다음 안내에 따라 커스텀 메타데이터를 설정하고 disable-legacy-endpoints=TRUE를 설정하세요.

예를 들어 gcloud 명령줄 도구를 사용하여 프로젝트 수준에서 메타데이터 서버 엔드포인트를 사용 중지하려면 다음 명령어를 실행합니다.

gcloud compute project-info add-metadata \
    --metadata disable-legacy-endpoints=TRUE 

v1 메타데이터 서버 엔드포인트로 전환

v0.1 또는 v1beta1에서 v1 엔드포인트로 전환하는 방법은 v1 메타데이터 서버 엔드포인트로 마이그레이션을 참조하세요.

다음 단계