런타임 변수 보간

런타임 변수 보간 (Variable Interpolation)

Nomad 워크로드에서 노드 속성(node attributes)과 런타임 환경 변수를 해석하는 방법에 대한 참조 정보를 제공해요. Nomad job 사양에서 변수를 해석하는 문법을 배워보아요.

출처: 문서

본문

소개 (Introduction)

Nomad는 두 종류의 변수 해석을 지원해요. 노드 속성과 런타임 환경 변수예요. 노드 속성은 제약 조건(constraints), 작업 환경 변수, 일부 드라이버 필드에서 해석할 수 있어요. 런타임 환경 변수는 스케줄러가 특정 노드에 배치한 후에만 정의되므로 제약 조건에서 해석할 수 없어요.

Nomad는 두 종류의 변수 해석을 지원해요. 노드 속성과 런타임 환경 변수요. 노드 속성은 제약 조건, 작업 환경 변수, 그리고 일부 작업 드라이버 필드(예: Docker config의 labels 속성)에서 해석할 수 있어요.

참고

런타임 환경 변수는 스케줄러가 job을 배치한 후에만 정의되므로 job 제약 조건에서 사용할 수 없어요.

문법 (Syntax)

Nomad job 사양에서 변수를 해석하는 문법은 ${variable_name}이에요. template 블록은 env 함수를 사용해 환경에서 이 변수들을 가져오며, 대신 {{env "variable_name"}}을 사용해요. 아래에서 예제를 볼 수 있어요.

task "docs" {
  driver = "docker"

  # 드라이버는 노드 속성과 런타임 환경 변수 해석을 지원한다
  config {
    image = "my-app"

    # 런타임 변수를 해석해 바인딩할 주소와 로그를 쓸 위치를 주입한다.
    args = [
      "--bind", "${NOMAD_ADDR_RPC}",
      "--logs", "${NOMAD_ALLOC_DIR}/logs",
    ]

    port_map {
      RPC = 6379
    }
  }

  # 런타임 환경 변수는 작업이 노드에 배치된 후에만 정의되므로
  # 제약 조건은 노드 속성만 지원한다.
  constraint {
    attribute = "${attr.kernel.name}"
    value     = "linux"
  }

  template {
    destination = "template.txt"
    data = <<EOT
{{- /*
      환경 변수는 ${...} 문법이 아니라 env 함수를 통해 템플릿에서 사용할 수 있다.
*/ -}}
Running on {{env "attr.unique.hostname"}}.
EOT
  }

  # 환경 변수는 해석되며 런타임 변수와 노드 속성을 모두 포함할 수 있다.
  # 이 환경 변수들은 작업 안으로 전달된다.
  env {
    DC      = "Running on datacenter ${node.datacenter}"
    VERSION = "Version ${NOMAD_META_VERSION}"
  }

  # Meta 키도 해석 가능하다.
  meta {
    VERSION = "v0.3"
  }
}

노드 속성 (Node Attributes)

아래는 해석 가능한 노드 속성의 전체 목록이에요. 이 속성들은 제약 조건 그리고 작업과 드라이버 안에서 모두 해석돼요.

아래는 일반적인 노드 속성을 문서화한 표예요.

노드 속성의 전체 목록은 nomad node status -verbose [node]를 실행해서 얻을 수 있어요.

job 파일에서 노드 속성과 속성 값을 사용하는 몇 가지 예제는 다음과 같아요.

job "docs" {
  # 이 job을 64비트 클라이언트에서만 실행하도록 제한한다.
  constraint {
    attribute = "${attr.cpu.arch}"
    value     = "amd64"
  }

  # 이 job을 코어가 4개 이상인 클라이언트에서만 실행하도록 제한한다.
  # 참고: 작업에 CPU 리소스 요구 사항을 선언할 수도 있다.
  constraint {
    attribute = "${cpu.numcores}"
    operator  = ">="
    value     = "4"
  }

  # 이 job을 메모리 최적화 AWS EC2 인스턴스에서만 실행한다.
  constraint {
    attribute = "${attr.platform.aws.instance-type}"
    value     = "m4.xlarge"
  }
}

환경 변수 (Environment Variables)

다음은 작업이 실행되고 있는 환경을 설명하는 런타임 환경 변수예요. 이들은 작업이 특정 노드에 배치된 후에만 정의되므로 제약 조건에서 사용할 수 없어요.

환경 변수는 보간을 위해 대괄호(${...})로 감싸거나 템플릿 블록 안에서 env 함수({{env "..."}})로 접근해야 해요.

변수 이름의 점 (Dots in Variables)

Nomad는 이름의 점을 객체 표기로 해석해요. 이로 인해 연속된 점이 여러 개 있는 이름은 유효하지 않은 것으로 간주돼요. 예를 들어 invalid...name이라는 환경 변수는 표준 "${invalid...name}" 문법으로 보간할 수 없어요. 그렇게 하면 파서가 Extra characters after interpolation expression 오류를 반환해요. Nomad는 이름과 관계없이 인덱스 문법을 사용해 어떤 환경 변수든 접근할 수 있는 env 변수를 제공해요.

job "sample" {
  datacenters = ["dc1"]
  group "g1" {
    task "redis" {

      # 참고: 유효하지 않은 이름의 환경 변수를 설정하려면 `env`에 HCL2 맵 할당 문법을
      # 사용해야 한다. 그렇지 않으면 job 사양 파서가
      # `Argument or block definition required` 오류를 던진다
      env = {
        "invalid...name" = "value1"
        "valid.name"     = "value2"
      }

      driver = "docker"
      config {
        image  = "redis:7"
        labels {
          label1 = "${env[\"invalid...name\"]}"
          label2 = "${valid.name}"
        }
      }
    }
  }
}

Job 관련 변수 (Job-related variables)

네트워크 관련 변수 (Network-related Variables)

참고

Nomad는 NOMAD_ADDR_<task>_<label> 같은 환경 변수 이름을 생성할 때 포트 라벨이나 작업 이름에서 영숫자도 밑줄도 아닌 문자를 밑줄로 바꿔요.

Consul 관련 변수 (Consul-related Variables)

참고

이 변수들은 Consul 서비스 메시 네이티브 작업에만 설정돼요.

더 알아보기 (Learn more)

• 런타임 환경 설정(runtime environment settings) 참조를 확인해 보세요.