Extensible Service Proxy 시작 옵션

Extensible Service Proxy(ESP)는 Cloud Endpoints에 API 관리 기능을 제공하는 NGINX 기반 프록시입니다. ESP Docker 컨테이너를 시작할 때 옵션을 지정하여 ESP를 구성합니다. ESP 컨테이너가 시작되면 start_esp라는 스크립트를 실행합니다. 이 스크립트는 지정된 옵션을 사용하여 NGINX 구성 파일을 작성하고 ESP를 시작합니다.

docker run 명령어에서 ESP 시작 옵션을 지정합니다. 예를 들면 다음과 같습니다.

sudo docker run \
    --detach \
    DOCKER_ARGUMENTS \
    gcr.io/endpoints-release/endpoints-runtime:1 \
    --service=SERVICE_NAME \
    --rollout_strategy=managed \
    --backend=YOUR_API_CONTAINER_NAME:8080

ESP를 Kubernetes에 배포하는 경우에는 배포 매니페스트 파일의 args 필드에 시작 옵션을 지정합니다. 예를 들면 다음과 같습니다.

containers:
- name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:1
  args: [
    "--http_port=8081",
    "--backend=127.0.0.1:8080",
    "--service=SERVICE_NAME",
    "--rollout_strategy=managed"
  ]

다음 표에서는 ESP의 시작 옵션을 설명합니다.

¹ 이러한 포트는 선택사항이며 서로 구분되어야 합니다. 포트 옵션을 하나도 지정하지 않으면 ESP는 포트 8080에서 HTTP/1.x 연결을 허용합니다. HTTPS 연결의 경우 ESP는 TLS 보안 비밀이 /etc/nginx/ssl/nginx.crt 및 /etc/nginx/ssl/nginx.key에 있을 것으로 예상합니다.

샘플 명령줄 호출

다음 예시에서는 몇 가지 명령줄 인수를 사용하는 방법을 보여줍니다.

HTTP/1.x 포트 80 및 HTTPS 포트 443에서 들어오는 요청을 처리하고 127.0.0.1:8000에서 API 백엔드에 요청을 전송하도록 ESP를 시작하려면 다음 명령어를 사용합니다.

sudo docker run \
    --detach \
    DOCKER_ARGUMENTS \
    gcr.io/endpoints-release/endpoints-runtime:1
     --service=echo-api.endpoints.example-project-12345.cloud.goog \
        --rollout_strategy=managed \
        --http_port=80 \
        --ssl_port=443 \
        --backend=127.0.0.1:8000

서비스 계정 사용자 인증 정보 파일을 사용하여 서비스 구성을 가져오고 서비스 제어에 연결하는 커스텀 NGINX 구성으로 ESP를 시작하는 방법은 다음과 같습니다.

sudo docker run \
    --detach \
    --volume=$HOME/Downloads:/esp \
    DOCKER_ARGUMENTS \
    gcr.io/endpoints-release/endpoints-runtime:1 \
    --service=echo-api.endpoints.example-project-12345.cloud.goog \
    --rollout_strategy=managed \
    --service_account_key=/esp/serviceaccount.json \
    --nginx_config=/esp/nginx.conf
    

서비스 계정의 비공개 키와 커스텀 NGINX 구성 파일이 포함된 JSON 파일을 ESP의 Docker 컨테이너 안의 볼륨으로 마운트하려면 Docker 플래그 --volume 또는 --mount를 사용해야 합니다. 위 예시에서는 로컬 컴퓨터의 $HOME/Downloads 디렉터리를 컨테이너의 esp 디렉터리로 매핑합니다. 서비스 계정의 비공개 키 파일을 저장하면 일반적으로 Downloads 디렉터리로 다운로드됩니다. 원할 경우 비공개 키 파일을 다른 디렉터리에 복사할 수 있습니다. 자세한 내용은 Docker의 데이터 관리를 참조하세요.

ESP에 CORS 지원 추가

사용 가능한 CORS 지원 옵션에 대한 설명은 CORS 지원을 참조하세요. 이 섹션에서는 ESP 시작 플래그를 사용하여 CORS 지원을 설명합니다.

ESP에서 CORS 지원을 사용하려면 --cors_preset 옵션을 포함하고 basic 또는 cors_with_regex로 설정합니다. --cors_preset=basic 또는 --cors_preset=cors_with_regex를 포함할 때 ESP가 다음과 같이 동작합니다.

• 모든 위치 경로에 동일한 CORS 정책이 있다고 가정합니다.
• 단순 요청 및 실행 전 HTTP OPTIONS 요청 모두에 응답합니다.
• 실행 전 OPTIONS 요청의 결과를 최대 20일(1728000초) 동안 캐시에 저장합니다.

• 응답 헤더를 다음 값으로 설정합니다.

  Access-Control-Allow-Origin: *
  Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
  Access-Control-Allow-Headers: DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization
  Access-Control-Expose-Headers: Content-Length,Content-Range

Access-Control-Allow-Origin의 기본값을 재정의하려면 다음 옵션 중 하나를 지정합니다.

--cors_preset=basic 또는 --cors_preset=cors_with_regex를 설정하여 CORS를 사용 설정한 후에는 다음 옵션을 한 개 이상 지정하여 다른 응답 헤더의 기본값을 재정의할 수 있습니다.

ESP CORS 시작 옵션이 애플리케이션의 요구사항에 맞지 않으면 애플리케이션에 필요한 CORS 지원이 포함된 커스텀 nginx.conf 파일을 만들 수 있습니다. 자세한 내용은 CORS를 지원하는 커스텀 nginx.conf 만들기를 참조하세요.

다음 단계

다음 사항에 대해 알아보세요.

• Google Cloud에 ESP와 API 백엔드 배포
• ESP를 로컬 또는 다른 플랫폼에서 실행
• GitHub의 start_esp 스크립트