7장. APIcast 환경 변수

APIcast 환경 변수를 사용하면 APIcast에 대한 동작을 수정할 수 있습니다. 지원되는 환경 변수는 다음과 같습니다.

ALL_PROXY

기본값: no value

value: 문자열

예:http://forward-proxy:80

프로토콜별 프록시가 지정되지 않은 경우 서비스 연결에 사용할 HTTP 프록시를 정의합니다. 인증이 지원되지 않습니다.

APICAST_ACCESS_LOG_BUFFER

기본값: no value

value: positive 정수

액세스 로그 쓰기를 바이트 청크에 포함할 수 있습니다. 결과적으로 시스템 호출이 줄어들어 게이트웨이의 성능이 향상됩니다.

APICAST_ACCESS_LOG_FILE

기본값: stdout

액세스 로그를 저장할 파일을 정의합니다.

APICAST_BACKEND_CACHE_HANDLER

기본값: strict

값: strict | resilient

deprecated: 대신 캐싱 정책을 사용합니다.

백엔드를 사용할 수 없는 경우 권한 부여 캐시가 작동하는 방식을 정의합니다. Strict은 백엔드를 사용할 수 없는 경우 캐시된 애플리케이션을 제거합니다. 복원력은 백엔드에서 권한 부여 거부만 수행합니다.

APICAST_CACHE_MAX_TIME

기본값: 1m

value: string

응답이 시스템에 캐시되도록 선택하면 이 변수의 값은 캐시할 최대 시간을 나타냅니다. cache-control 헤더가 설정되지 않은 경우 캐시할 시간이 정의된 것입니다.

이 값의 형식은 proxy_cache_valid NGINX 지시문 으로 정의됩니다.

이 매개변수는 콘텐츠 캐싱 정책을 사용하는 API에서만 사용되며 요청을 캐시할 수 있습니다.

APICAST_CACHE_STATUS_CODES

기본값: 200, 302

value: string

업스트림의 응답 코드가 이 환경 변수에 정의된 상태 코드 중 하나와 일치하면 응답 콘텐츠가 NGINX에 캐시됩니다. 캐싱 시간은 헤더 캐시 시간 값 또는 APICAST_CACHE_MAX_TIME 환경 변수에 의해 정의된 최대 시간 중 하나에 따라 달라집니다.

이 매개변수는 콘텐츠 캐싱 정책을 사용하는 API에서만 사용되며 요청을 캐시할 수 있습니다.

APICAST_CONFIGURATION_CACHE

기본값: 0

value: integer

구성이 저장될 간격(초)을 지정합니다. 값은 0( APICAST_CONFIGURATION_LOADER) 또는 60 이상과 호환되지 않습니다. 예를 들어 APICAST_CONFIGURATION_CACHE 가 120으로 설정된 경우 게이트웨이는 2분(120초)마다 API 관리자에서 구성을 다시 로드합니다. 값이 0이면 다시 로드를 비활성화합니다.

APICAST_CONFIGURATION_LOADER

값: boot | lazy

기본값: lazy

구성을 로드하는 방법을 정의합니다. 부팅은 게이트웨이가 시작될 때 API 관리자에 대한 구성을 요청합니다. lazy는 들어오는 각 요청에 대해 필요에 따라 로드됩니다(각 요청 APICAST_CONFIGURATION_CACHE 는 0이어야 함).

APICAST_CUSTOM_CONFIG

deprecated: 대신 정책을 사용합니다.

기존 APIcast 논리를 재정의하는 사용자 지정 논리를 구현하는 Lua 모듈의 이름을 정의합니다.

APICAST_ENVIRONMENT

value: string[:]

예: production:cloud-hosted

APIcast는 콜론(:)으로 구분된 환경 목록(또는 경로)을 로드해야 합니다. 이 목록은 CLI의 -e 또는 --environment 매개변수 대신 사용할 수 있으며 예를 들어 컨테이너 이미지에 기본 환경으로 저장할 수 있습니다. CLI에 전달된 모든 값은 이 변수를 재정의합니다.

APICAST_EXTENDED_METRICS

기본값: false

value: boolean

예: "true"

Prometheus 지표에 대한 추가 정보를 활성화합니다. 다음 메트릭에는 APIcast에 대한 보다 심층적인 세부 정보를 제공하는 service_id 및 service_system_name 라벨이 있습니다.

APICAST_HTTPS_CERTIFICATE

기본값: no value

HTTPS의 PEM 형식의 X.509 인증서가 있는 파일의 경로입니다.

APICAST_HTTPS_CERTIFICATE_KEY

기본값: no value

PEM 형식의 X.509 인증서 보안 키를 사용하여 파일의 경로입니다.

APICAST_HTTPS_PORT

기본값: no value

APIcast가 HTTPS 연결 수신을 시작해야 하는 포트를 제어합니다. HTTP 포트와 충돌하면 HTTPS에만 사용됩니다.

APICAST_HTTPS_PROXY_PROTOCOL

기본값: false 값: 부울 예: true

이 매개변수는 HTTPS 리스너에 대한 프록시 프로토콜을 활성화합니다.

APICAST_HTTPS_VERIFY_DEPTH

기본값: 1

값: positive 정수

클라이언트 인증서 체인의 최대 길이를 정의합니다. 이 매개변수의 값이 1 인 경우 클라이언트 인증서 체인에 추가 인증서를 포함할 수 있습니다. 예를 들어 루트 인증 기관입니다.

APICAST_HTTP_PROXY_PROTOCOL

기본값: false

값: 부울

예: true

이 매개변수는 HTTP 리스너에 대한 프록시 프로토콜을 활성화합니다.

APICAST_LARGE_CLIENT_HEADER_BUFFERS

기본값: 4 8k

value: string

대규모 클라이언트 요청 헤더를 읽는 데 사용되는 최대 버퍼 수 및 크기를 설정합니다.

이 값의 형식은 large_client_header_buffers NGINX 지시문 으로 정의됩니다.

APICAST_LOAD_SERVICES_WHEN_NEEDED

기본값:false

값:

이 옵션은 많은 서비스가 구성된 경우 사용할 수 있습니다. 그러나 성능은 추가 요인, 예를 들어 서비스 수, APIcast와 3scale 관리 포털 간의 대기 시간, 구성의 TTL(Time To Live)에 따라 달라집니다.

기본적으로 APIcast는 관리 포털에서 구성을 다운로드할 때마다 모든 서비스를 로드합니다. 이 옵션을 활성화하면 구성에서 지연 로드를 사용합니다. APIcast는 요청의 호스트 헤더에 지정된 호스트에 대해 구성된 항목만 로드합니다.

APICAST_LOG_FILE

기본값: stderr

OpenResty 오류 로그가 포함된 파일을 정의합니다. 이 파일은 error_log 지시문의 bin/apicast 에서 사용됩니다. 파일 경로는 절대 경로이거나 APIcast 접두사 디렉터리와 관련이 있을 수 있습니다. 기본 접두사 디렉터리는 APIcast입니다. 자세한 내용은 NGINX 설명서 를 참조하십시오.

APICAST_LOG_LEVEL

기본값: warn

값: debug | info | notice | warn | error | crit | alert | emerg

OpenResty 로그의 로그 수준을 지정합니다.

APICAST_LUA_SOCKET_KEEPALIVE_REQUESTS

값: positive 정수

예: "1"

keepalive 연결이 제공할 수 있는 최대 요청 수를 설정합니다. 제한에 도달하면 연결이 닫힙니다.

APICAST_MANAGEMENT_API

값:

관리 API 는 강력하며 APIcast 구성을 제어할 수 있습니다. 디버깅을 위해 디버그 수준을 활성화해야 합니다.

APICAST_MODULE

기본값: apicast

deprecated: 대신 정책을 사용합니다.

API 게이트웨이 논리를 구현하는 기본 Lua 모듈의 이름을 지정합니다. 사용자 지정 모듈은 기본 apicast.lua 모듈의 기능을 재정의할 수 있습니다. 모듈 사용 방법에 대한 예제 를 참조하십시오.

APICAST_OIDC_LOG_LEVEL

값: debug | info | notice | warn | error | crit | alert | emerg

기본값: err

OpenID Connect 통합과 관련된 로그의 로그 수준을 설정할 수 있습니다.

APICAST_PATH_ROUTING

값:

이 매개변수가 true 로 설정되면 게이트웨이는 기본 호스트 기반 라우팅 외에도 경로 기반 라우팅을 사용합니다. API 요청은 요청의 Host 헤더 값이 공용 기본 URL 과 일치하는 서비스 목록에서 일치하는 매핑 규칙이 있는 첫 번째 서비스로 라우팅됩니다.

APICAST_PATH_ROUTING_ONLY

값:

이 매개변수가 true 로 설정되면 게이트웨이는 경로 기반 라우팅을 사용하며 기본 호스트 기반 라우팅을 대체하지 않습니다. API 요청은 요청의 Host 헤더 값이 공용 기본 URL 과 일치하는 서비스 목록에서 일치하는 매핑 규칙이 있는 첫 번째 서비스로 라우팅됩니다.

이 매개변수는 APICAST_PATH_ROUTING 보다 우선합니다. APICAST_PATH_ROUTING_ONLY 가 활성화된 경우 APIcast는 APICAST_PATH_ROUTING 값과 관계없이 경로 기반 라우팅만 수행합니다.

APICAST_POLICY_BATCHER_SHARED_MEMORY_SIZE

기본값: 20m

value: 문자열

batcher 정책에서 사용하는 공유 메모리의 최대 크기를 설정합니다.

허용되는 크기 단위는 k 및 m 입니다.

http {
     lua_shared_dict batched_reports 20m;
     ...
 }

http {
     lua_shared_dict batched_reports 20m;
     ...
 }

APICAST_POLICY_LOAD_PATH

기본값:APICAST_DIR/policies

value: string[:]

예:~/apicast/policies:$PWD/policies

APIcast에서 정책을 찾아야 하는 콜론(:)으로 구분된 경로 목록입니다. 먼저 개발 디렉터리에서 정책을 로드하거나 예제를 로드하는 데 사용할 수 있습니다.

APICAST_PROXY_HTTPS_CERTIFICATE

기본값:

value: 문자열

예: /home/apicast/my_certificate.crt

업스트림과 연결할 때 APIcast가 사용할 클라이언트 SSL 인증서의 경로입니다. 이 인증서는 구성의 모든 서비스에 사용됩니다.

APICAST_PROXY_HTTPS_CERTIFICATE_KEY

기본값:

value: 문자열

예: /home/apicast/my_certificate.key

클라이언트 SSL 인증서의 키 경로입니다.

APICAST_PROXY_HTTPS_PASSWORD_FILE

기본값:

value: 문자열

예: /home/apicast/passwords.txt

APICAST_PROXY_HTTPS_CERTIFICATE_KEY 로 지정된 SSL 인증서 키의 암호를 사용하여 파일 경로입니다.

APICAST_PROXY_HTTPS_SESSION_REUSE

기본값: on

값:

APICAST_REPORTING_THREADS

기본값: 0

value: 정수 >= 0

실험적: 극단적인 부하에 따라 예기치 않은 성능이 있을 수 있으며 보고서가 손실될 수 있습니다.

값이 0보다 큰 경우 백엔드에 대한 대역 외 보고를 활성화합니다. 이는 성능 향상을 위한 새로운 실험 기능입니다. 클라이언트는 백엔드 대기 시간을 볼 수 없으며 모든 것이 비동기적으로 처리됩니다. 이 값은 대기 시간을 추가하여 클라이언트를 제한하기 전에 동시에 실행할 수 있는 비동기 보고서 수를 결정합니다.

APICAST_RESPONSE_CODES

기본값: <empty> (false)

값:

true 로 설정하면 APIcast는 3scale의 API 백엔드에서 반환된 응답의 응답 코드를 기록합니다. 자세한 내용은 API 의 3scale API Management 응답 코드 로그 설정 및 평가를 참조하십시오.

APICAST_SERVICE_CACHE_SIZE

기본값: 1000

값: integer >= 0

APIcast가 내부 캐시에 저장할 수 있는 서비스 수를 지정합니다. Lua의 lru 캐시가 모든 항목을 초기화하므로 높은 값은 성능에 영향을 미칩니다.

APICAST_SERVICE_${ID}_CONFIGURATION_VERSION

${ID} 를 실제 서비스 ID로 바꿉니다. 값은 관리 포털의 구성 기록에 표시되는 구성 버전이어야 합니다. 특정 버전으로 설정하면 자동 업그레이드되지 않으며 항상 해당 버전을 사용합니다.

APICAST_SERVICES_LIST

value: 쉼표로 구분된 서비스 ID 목록

APICAST_SERVICES_LIST 환경 변수는 3scale API Manager에서 구성한 서비스를 필터링하는 데 사용됩니다. 이는 게이트웨이의 특정 서비스에 대한 구성만 적용하여 목록에 지정되지 않은 서비스 ID를 삭제합니다. 제품 > [ your_product_name] > 개요 에서는 관리 포털에서 제품의 서비스 ID를 찾을 수 있습니다. 구성, 방법 및 설정 및 API 호출의 ID 를 참조하십시오.

APICAST_SERVICES_FILTER_BY_URL

value: .*.example.com 과 같은 PCRE(Perl Compatible Regular Expression)입니다.

3scale API Manager에 구성된 서비스를 필터링합니다.

이 필터는 Public Base URL 인 staging 또는 production과 일치합니다. 필터와 일치하지 않는 서비스는 삭제됩니다. 정규식을 컴파일할 수 없는 경우 서비스가 로드되지 않습니다.

APICAST_UPSTREAM_RETRY_CASES

값: error | timeout | invalid_header | http_502 | http_503 | http_504 | http_403 | http_404 | http_404 | http_429 | non_idempotent | off

APICAST_WORKERS

기본값: auto

값: integer | auto

nginx worker_processes 지시문에서 사용할 값입니다. 기본적으로 APIcast는 1 이 사용되는 개발 환경을 제외하고 자동 을 사용합니다.

BACKEND_ENDPOINT_OVERRIDE

구성의 백엔드 끝점을 재정의하는 URI입니다. OpenShift가 배포된 AMP 외부에 배포할 때 유용합니다. 예:https://backend.example.com.

HTTP_KEEPALIVE_TIMEOUT

기본값: 75

value: positive 정수

예:1

이 매개변수는 서버 측에서 keep-alive 클라이언트 연결이 열린 상태로 유지되는 시간 초과를 설정합니다. 0 값은 keep-alive 클라이언트 연결을 비활성화합니다.

기본적으로 게이트웨이는 HTTP_KEEPALIVE_TIMEOUT을 비활성화하도록 유지합니다. 이 구성을 사용하면 기본값이 75초 인 NGINX에서 keepalive 시간 초과를 사용할 수 있습니다.

http_proxy, HTTP_PROXY

기본값: no value

value: 문자열

예:http://forward-proxy:80

HTTP 서비스 연결에 사용할 HTTP 프록시를 정의합니다. 인증이 지원되지 않습니다.

https_proxy, HTTPS_PROXY

기본값: no value

value: 문자열

예:https://forward-proxy:443

HTTPS 서비스 연결에 사용할 HTTP 프록시를 정의합니다. 인증이 지원되지 않습니다.

no_proxy, NO_PROXY

기본값: no value

value: string\[,<string>\]; *

예:foo,bar.com,.extra.dot.com

요청을 프록시해서는 안 되는 쉼표로 구분된 호스트 이름 및 도메인 이름 목록을 정의합니다. 모든 호스트와 일치하는 단일 * 문자로 설정하면 프록시를 효과적으로 비활성화합니다.

OPENSSL_VERIFY

값:

OpenSSL Peer Verification을 제어합니다. OpenSSL이 시스템 인증서 저장소를 사용할 수 없기 때문에 기본적으로 꺼져 있습니다. 사용자 정의 인증서 번들이 필요하고 신뢰할 수 있는 인증서에 추가해야 합니다.

https://github.com/openresty/lua-nginx-module#lua_ssl_trusted_certificate 을 사용하고 export-builtin-trusted-certs 로 생성된 인증서 번들을 가리키는 것이 좋습니다.

OPENTRACING_CONFIG

이 환경 변수는 opentracing tracer의 구성 파일을 결정하는 데 사용됩니다. OPENTRACING_TRACER 를 설정하지 않으면 이 변수가 무시됩니다.

각 추적기에는 * jaeger: conf.d/opentracing/jaeger.example.json의 기본 구성 파일이 있습니다.

이 변수를 사용하여 파일 경로를 설정하여 기본적으로 제공된 구성과 다른 구성을 마운트하도록 선택할 수 있습니다.

예:/tmp/jaeger/jaeger.json

OPENTRACING_HEADER_FORWARD

기본값:uber-trace-id

이 환경 변수는 opentracing 정보를 전달하는 데 사용되는 HTTP 헤더를 제어하며, 이 HTTP 헤더는 업스트림 서버로 전달됩니다.

OPENTRACING_TRACER

예:jaeger

이 환경 변수는 로드할 추적 라이브러리를 제어합니다. 현재 하나의 opentracing 추적 추적기를 사용할 수 있습니다. jaeger.

빈 경우 opentracing 지원이 비활성화됩니다.

해결자

OpenResty에서 사용할 사용자 지정 DNS 확인자를 지정할 수 있습니다. RESOLVER 매개변수가 비어 있으면 DNS 확인기가 자동으로 검색됩니다.

THREESCALE_CONFIG_FILE

게이트웨이 구성이 포함된 JSON 파일의 경로입니다. 게이트웨이가 성공적으로 실행되도록 THREESCALE_PORTAL_ENDPOINT 또는 THREESCALE_CONFIG_FILE 을 제공해야 합니다. 이 두 환경 변수에서 THREESCALE_CONFIG_FILE 이 우선합니다.

게이트웨이 구성에 대한 구성을 사용하여 파일을 빌드하려면 서비스 수에 따라 두 가지 대안이 있습니다.

컨테이너 이미지를 사용하여 게이트웨이를 배포하는 경우:

예제 구성 파일은 예제 폴더에서 찾을 수 있습니다.

THREESCALE_DEPLOYMENT_ENV

기본값: production

값: 스테이징 | production

이 환경 변수의 값은 구성을 다운로드할 환경을 정의합니다. 이는 새 APIcast를 사용할 때 3scale 스테이징 또는 프로덕션입니다.

이 값은 3scale 서비스 관리 API에 대한 인증/보고 요청의 X-3scale-User-Agent 헤더에도 사용됩니다. 이는 3scale에서 통계용으로만 사용됩니다.

THREESCALE_PORTAL_ENDPOINT

암호 및 포털 끝점이 포함된 URI 형식은 다음과 같습니다.

<schema>://<password>@<admin-portal>.

다음과 같습니다.

예:https://access-token@account-admin.3scale.net.

THREESCALE_PORTAL_ENDPOINT 환경 변수가 제공되고 APICAST_CONFIGURATION_LOADER=boot 인 경우 게이트웨이는 초기화 시 3scale에서 구성을 다운로드합니다. 구성에는 [ your_product_name] > Integration.에 따라 API의 통합 페이지에 제공된 모든 설정이 포함됩니다.

이 환경 변수를 사용하여 마스터 관리 포털을 사용하여 단일 게이트웨이를 생성할 수도 있습니다.

게이트웨이를 성공적으로 실행하려면 THREESCALE_PORTAL_ENDPOINT 또는 THREESCALE_CONFIG_FILE 을 제공해야 합니다. THREESCALE_CONFIG_FILE 은 THREESCALE_PORTAL_ENDPOINT 보다 우선합니다.

필요한 경우 구성은 기본적으로 가져옵니다. 논리 사양은 다음과 같습니다.