app.yaml 파일에서 App Engine 앱 설정을 구성할 수 있습니다. 이 파일은 URL 경로가 요청 핸들러와 정적 파일에 대응하는 방식을 지정합니다. 또한 app.yaml 파일에는 애플리케이션 ID 및 최신 버전의 식별자와 같은 앱 코드에 관한 정보도 포함되어 있습니다.
app.yaml 파일은 앱에서 개별 서비스의 배포를 위한 설명어 역할을 합니다. 앱 내 추가 서비스를 위해 app.yaml 파일을 만들고 배포하려면 먼저 default 서비스에 대한 app.yaml 파일을 만들어야 합니다.
서비스의 app.yaml 파일은 해당 서비스의 루트 디렉토리에 있어야 합니다. 앱에서 여러 서비스를 구성하는 방법은 구성 파일을 참조하세요.
예
다음은 Python 애플리케이션의 app.yaml 파일 예시입니다.
runtime: python27 api_version: 1 threadsafe: true handlers: - url: / script: home.app - url: /index\.html script: home.app - url: /stylesheets static_dir: stylesheets - url: /(.*\.(gif|png|jpg))$ static_files: static/\1 upload: static/.*\.(gif|png|jpg)$ - url: /admin/.* script: admin.app login: admin - url: /.* script: not_found.app
script: 지시어가 .py로 끝나는 파일 경로를 포함하는 경우 스크립트가 CGI를 사용한다는 의미이며, 점으로 구분된 패키지 이름이 있는 Python 모듈 경로를 포함하는 경우 스크립트가 WSGI를 사용한다는 의미입니다.
구문
app.yaml 구문은 YAML 형식입니다.
YAML 형식에서는 주석이 지원됩니다. 우물 정자(#)로 시작하는 줄은 무시됩니다.
# This is a comment.
URL과 파일 경로 패턴은 대조 요소와 대조 클래스를 제외한 POSIX 확장 정규 표현식 구문을 사용합니다. 그룹화된 일치 항목(예: \1)에 대한 역참조가 지원되며 \w \W \s \S \d \D와 같은 PERL 확장도 지원됩니다.
런타임 및 앱 요소
| 요소 | 설명 |
|---|---|
application |
명령어 사용에 관한 자세한 내용은 앱 배포를 참조하세요. 애플리케이션 ID는 Google Cloud Platform 콘솔에서 애플리케이션을 만들 때 지정한 GCP 콘솔 프로젝트 ID입니다. |
api_version |
필수. 앱에서 사용하는 특정 런타임 환경의 API 버전입니다.
Google에서 새로운 버전의 런타임 환경 API 지원이 발표되더라도, 이전에 배포된 앱에는 해당 앱을 작성하는 데 사용된 API 버전이 계속 사용됩니다. 앱을 새로운 API 버전으로 업그레이드하려면 이 값을 변경한 후 앱을 App Engine에 다시 배포해야 합니다.
현재까지 App Engine의 |
auto_id_policy |
선택사항. 항목 식별자를 자동으로 설정하는 경우, 자동 ID 정책을 설정하여 사용되는 방법을 변경할 수 있습니다. 유효한 옵션은 다음과 같습니다.
|
builtins |
선택사항.
Python SDK에는 일반적인 애플리케이션 기능을 위한 여러 핸들러가 내장되어 있습니다. 사용할 수 있는 내장 핸들러는 다음과 같습니다.
builtins: - deferred: on - appstats: on
builtins: - name: on 위 항목은 다음과 동일합니다. includes: - $PYTHON_LIB/google/appengine/ext/builtins/name/
다음과 같이 handlers: - url: /.* script: main.app builtins: - appstats: on 핸들러의 결과 목록은 다음과 같습니다. [/_ah/stats, /.*]
includes: - included.yaml
그리고 handlers: - url: /.* script: main.app builtins: - appstats: on 핸들러의 결과 목록은 다음과 같습니다. [/.*, /_ah/stats]
|
default_expiration |
선택사항. 애플리케이션의 모든 정적 파일 핸들러에 대한 전역 기본 캐시 기간을 설정합니다. 또한 특정 정적 파일 핸들러의 캐시 기간을 구성할 수도 있습니다. 값은 공백으로 구분된 숫자와 단위 문자열입니다. 단위는 d(일), h(시간), m(분), s(초)일 수 있습니다. 예를 들어 runtime: python27 api_version: 1 threadsafe: true default_expiration: "4d 5h" handlers: # ... 자세한 내용은 정적 캐시 만료를 참조하세요. |
env_variables
|
선택사항.
앱에 사용할 수 있도록
os.environ 사전에서 확인할 수 있습니다.
env_variables: DJANGO_SETTINGS_MODULE: 'myapp.settings' |
error_handlers |
선택사항. 오류 유형에 따라 반환되는 커스텀 오류 페이지를 구성하는 데 사용됩니다. 이 요소에는 다음 요소가 포함될 수 있습니다.
error_handlers:
- file: default_error.html
- error_code: over_quota
file: over_quota.html
|
handlers |
필수. URL 패턴과 그 처리 방법에 대한 설명이 포함된 목록입니다. App Engine은 애플리케이션 코드를 실행하거나 이미지, CSS 또는 자바스크립트와 같이 코드와 함께 업로드된 정적 파일을 제공하여 URL을 처리할 수 있습니다. |
includes
|
선택사항.
includes: - lib/user_admin.yaml App Engine은 포함된 경로를 다음 순서로 확인합니다.
|
inbound_services |
선택사항.
애플리케이션이 이메일을 수신할 수 있으려면 해당 서비스를 사용 설정하도록 애플리케이션을 구성해야 합니다.
다음과 같은 인바운드 서비스를 사용할 수 있습니다. 예:inbound_services: - mail - warmup |
instance_class |
선택사항. 이 서비스의 인스턴스 클래스입니다. 서비스 확장에 따라 다음 값을 사용할 수 있습니다.
참고: |
libraries |
선택사항.
Python 2.7 런타임에는 타사 라이브러리가 포함되어 있습니다. 이 중 일부는 기본적으로 사용할 수 있으며 그 외에는 구성된 경우에만 사용할 수 있습니다.
libraries:
- name: PIL
version: "1.1.7"
- name: webob
version: "latest"
아직 사용자가 없는 애플리케이션을 개발 중인 경우 새로운 버전을 추적할 필요가 없습니다. 그러나 애플리케이션이 활발히 사용되는 경우 애플리케이션이 이전 버전과 호환되지 않는 새로운 라이브러리 버전을 사용할 수 있으므로 주의하시기 바랍니다. 포함된 타사 라이브러리 목록은 타사 라이브러리를 참조하세요. 로컬 디렉토리에 설치하여 순수 Python 타사 라이브러리를 추가로 사용할 수 있습니다. 가변형 환경을 사용하는 경우 가변형 환경에서 Python 라이브러리 사용하기를 참조하세요. |
module |
참고: 이제는 모듈을 서비스라고 합니다.
module: service-name
서비스를 만들 경우 필수 항목입니다.
|
runtime |
필수.
앱에서 사용되는 런타임 환경 이름입니다.
Python을 지정하려면 runtime: python |
service |
서비스는 이전에 모듈이라고 불렸습니다.
서비스를 만들 경우 필수 항목입니다.
service: service_name
참고: module: service_name |
skip_files |
선택사항.
skip_files: - ^(.*/)?#.*#$ - ^(.*/)?.*~$ - ^(.*/)?.*\.py[co]$ - ^(.*/)?.*/RCS/.*$ - ^(.*/)?\..*$
이름의 형식이
위의 정규 표현식 목록을 확장하려면 위의 목록을 복사하여 skip_files: - ^(.*/)?#.*#$ - ^(.*/)?.*~$ - ^(.*/)?.*\.py[co]$ - ^(.*/)?.*/RCS/.*$ - ^(.*/)?\..*$ - ^(.*/)?.*\.bak$
전체 디렉토리를 건너뛰려면 목록에 디렉토리 이름을 추가합니다. 예를 들어, skip_files: - logs/ |
threadsafe |
필수.
동시 요청을 사용하도록 애플리케이션을 구성합니다. Python의 스레딩 라이브러리를 사용하는 경우 threadsafe: [true | false]
참고: |
version |
명령어 사용에 관한 자세한 내용은 앱 배포를 참조하세요. App Engine에 배포하는 애플리케이션 코드의 버전을 위한 식별자입니다.
버전 ID는 소문자, 숫자, 하이픈을 포함할 수 있습니다. 프리픽스
참고: 항상 숫자로 지정되는 숫자 인스턴스와 구분하기 위해, 버전 이름은 문자로 시작해야 합니다. 이를 통해
애플리케이션의 각 버전에는 |
핸들러 요소
handlers 요소는 app.yaml에서 필수 요소입니다. 이 요소는 URL 패턴과 그 처리 방법에 대한 설명이 포함된 목록을 제공합니다.
App Engine은 애플리케이션 코드를 실행하거나 이미지, CSS 또는 자바스크립트와 같이 코드와 함께 업로드된 정적 파일을 제공하여 URL을 처리할 수 있습니다.
패턴은 app.yaml 파일에 표시된 순서에 따라 위에서 아래로 평가됩니다. 패턴이 URL과 일치하는 첫 번째 매핑이 요청 처리를 위해 사용됩니다.
다음 표에는 스크립트, 정적 파일, 정적 디렉토리, 기타 설정의 동작을 제어하는 handlers 요소의 하위 요소가 나열되어 있습니다.
| 요소 | 설명 |
|---|---|
application_readable |
선택사항. 부울. 기본적으로 정적 파일 핸들러에 선언된 파일은 정적 데이터로 업로드되며 최종 사용자에게만 제공됩니다. 애플리케이션은 이러한 파일을 읽을 수 없습니다. 이 필드를 true로 설정할 경우, 애플리케이션이 파일을 읽을 수 있도록 해당 파일이 코드 데이터로도 업로드됩니다. 두 가지 업로드 모두 사용자 코드 및 정적 데이터 저장소 리소스 할당량에 따라 청구됩니다. |
auth_fail_action |
선택사항.
애플리케이션에 다른 동작이 필요한 경우 애플리케이션 자체가 사용자 로그인 처리를 구현할 수 있습니다. 자세한 내용은 Users API를 참조하세요.
다음 예에서는 handlers: - url: /profile/.* script: user_profile.app login: required - url: /admin/.* script: admin.app login: admin - url: /.* script: welcome.app
핸들러 구성에 handlers: - url: /secure_api/.* script: api_handler.app login: required auth_fail_action: unauthorized |
expiration
|
선택사항.
이 핸들러에서 제공한 정적 파일을 웹 프록시 및 브라우저가 캐시해야 하는 시간입니다. 값은 공백으로 구분된 숫자와 단위 문자열입니다. 단위는 d(일), h(시간), m(분), s(초)일 수 있습니다. 예를 들어 "4d 5h"는 파일이 처음 요청되고 나서 4일 5시간 후로 캐시 만료를 설정합니다. 생략하면 애플리케이션의 default_expiration이 사용됩니다. 자세한 내용은 정적 캐시 만료를 참조하세요.
|
http_headers |
선택사항. 정적 파일 또는 디렉토리 핸들러의 응답에 HTTP 헤더를 설정할 수 있습니다.
handlers:
- url: /images
static_dir: static/images
http_headers:
X-Foo-Header: foo
X-Bar-Header: bar value
CORS 지원이 기능의 중요한 용도 중 하나는 다른 App Engine 앱에서 호스팅하는 파일에 대한 액세스와 같은 CORS(교차 출처 리소스 공유)를 지원하는 것입니다.
예를 들어 정적 파일 핸들러가 필요한 응답 헤더 값을 반환하도록 만드는 방법은 다음과 같습니다.
handlers:
- url: /images
static_dir: static/images
http_headers:
Access-Control-Allow-Origin: http://mygame.appspot.com
참고: 모든 사람이 애셋에 액세스하도록 허용하려면 |
login |
선택사항. URL 핸들러가 사용자의 로그인을 요구할지 여부를 결정합니다. 이 요소에 가능한 세 가지 값은 다음과 같습니다.
참고: App Engine이 적절한 |
mime_type |
선택사항. 이 값을 지정하면 이 핸들러로 제공되는 모든 파일은 지정된 MIME 유형을 사용하여 제공됩니다. 지정하지 않으면 파일의 MIME 유형이 파일의 파일 이름 확장자로부터 파생됩니다. 가능한 MIME 미디어 유형에 대한 자세한 내용은 IANA MIME 미디어 유형 웹사이트를 참조하세요. |
redirect_http_response_code |
선택사항.
handlers: - url: /youraccount/.* script: accounts.app login: required secure: always redirect_http_response_code: 301 사용자 요청이 리디렉션되면 HTTP 상태 코드가 redirect_http_response_code 매개변수 값으로 설정됩니다. 매개변수가 없으면 302가 반환됩니다. |
script |
선택사항. 애플리케이션 루트 디렉토리에서 스크립트로의 경로를 지정합니다. handlers: # The root URL (/) is handled by the WSGI application named # "app" in home.py. No other URLs match this pattern. - url: / script: home.app # The URL /index.html is also handled by the home.py script. - url: /index\.html script: home.app # A regular expression can map parts of the URL to the # path of the script. - url: /browse/(books|videos|tools) script: \1.catalog.app # All other URLs use the WSGI application named in "app" # in not_found.py. - url: /.* script: not_found.app
참고: Python |
secure |
선택사항. 모든 URL 핸들러는 스크립트 핸들러와 정적 파일 핸들러를 비롯하여 secure 설정을 사용할 수 있습니다. secure 요소에 사용 가능한 값은 다음과 같습니다.
handlers: - url: /youraccount/.* script: accounts.app login: required secure: always
개발 웹 서버는 HTTPS 연결을 지원하지 않습니다.
appspot.com 도메인을 사용해서 앱의 특정 버전을 대상으로 지정하려면 일반적으로 URL의 하위 도메인 구성요소를 구분하는 마침표를 ' https://[VERSION_ID]-dot-[YOUR_PROJECT_ID].appspot.com HTTPS에 커스텀 도메인을 사용하려면 먼저 해당 도메인에 SSL 인증서를 활성화하고 구성해야 합니다. Google 계정 로그인 및 로그아웃은 애플리케이션의 URL이 구성된 방식과 무관하게 항상 보안 연결을 사용하여 수행됩니다. |
static_dir
|
선택사항. 애플리케이션 루트 디렉토리의 정적 파일을 포함하는 디렉토리 경로입니다. 일치하는
디렉토리의
이 디렉토리의 모든 파일은 앱과 함께 정적 파일로 업로드됩니다. App Engine은 앱 파일과 별도로 정적 파일을 저장하고 제공합니다. 기본적으로 정적 파일은 앱의 파일 시스템에 제공되지 않습니다. 이를 변경하려면 handlers: # All URLs beginning with /stylesheets are treated as paths to # static files in the stylesheets/ directory. - url: /stylesheets static_dir: stylesheets |
static_files
|
선택사항. 정적 파일 패턴 핸들러는 URL 패턴을 애플리케이션과 함께 업로드된 정적 파일 경로와 연결합니다. URL 패턴 정규 표현식은 파일 경로를 만들 때 사용할 정규 표현식 그룹화를 정의할 수 있습니다. handlers: # All URLs ending in .gif .png or .jpg are treated as paths to # static files in the static/ directory. The URL pattern is a # regular expression, with a grouping that is inserted into the # path to the file. - url: /(.*\.(gif|png|jpg))$ static_files: static/\1 upload: static/.*\.(gif|png|jpg)$
App Engine은 애플리케이션 파일과 별도로 정적 파일을 저장하고 제공합니다. 기본적으로 정적 파일은 애플리케이션의 파일 시스템에 제공되지 않습니다. 이를 변경하려면 정적 파일은 애플리케이션 코드 파일과 동일할 수 없습니다. 정적 파일 경로가 동적 핸들러에 사용된 스크립트의 경로와 일치할 경우, 해당 스크립트는 해당 동적 핸들러에 제공되지 않습니다. |
upload |
선택사항. 이 핸들러에서 참조되는 모든 파일의 파일 경로와 일치하는 정규 표현식입니다. 이 정규 표현식이 필요한 이유는 핸들러가 제공된 |
url
|
URL 패턴은 다음 요소와 함께 사용될 때 일부 동작이 달라집니다.
|
요소 확장
App Engine 앱 확장 방법에 대한 자세한 내용은 동적 인스턴스 확장을 참조하세요.
다음 표에는 애플리케이션의 확장을 지정하는 방법을 정의하기 위한 옵션이 나열되어 있습니다.
| 요소 | 설명 |
|---|---|
automatic_scaling |
선택사항. 달리 지정하지 않는 한 기본적으로 자동 확장이 기본 인스턴스 클래스
이 요소에는 다음 요소가 포함될 수 있습니다.
service: my-service runtime: python27 api_version: 1 instance_class: F2 automatic_scaling: target_cpu_utilization: 0.65 min_instances: 5 max_instances: 100 min_pending_latency: 30ms # default value max_pending_latency: automatic max_concurrent_requests: 50 |
basic_scaling |
선택사항.
이 요소에는 다음 요소가 포함될 수 있습니다.
service: my-service runtime: python27 api_version: 1 instance_class: B8 basic_scaling: max_instances: 11 idle_timeout: 10m |
manual_scaling |
선택사항.
이 요소에는 다음 요소가 포함될 수 있습니다.
service: my-service runtime: python27 api_version: 1 instance_class: B8 manual_scaling: instances: 5 |
정적 캐시 만료
별도로 지정하지 않는 한 웹 프록시와 브라우저는 웹사이트에서 로드하는 파일을 한정된 기간 동안 유지합니다.
최상위 default_expiration 요소를 포함하면 애플리케이션의 모든 정적 파일 핸들러에 대한 전역 기본 캐시 기간을 정의할 수 있습니다. 또한 특정 정적 파일 핸들러의 캐시 기간을 구성할 수도 있습니다.
만료 시간은 Cache-Control과 Expires HTTP 응답 헤더에 전송되므로, 인터넷 서비스 제공업체와 같은 중간 캐싱 프록시 서버는 물론 사용자 브라우저에서도 파일이 캐시될 수 있습니다. 만료 시간이 지정된 파일이 전송된 후에는 일반적으로 사용자가 자신의 브라우저 캐시를 지우더라도 중간 캐시에서 파일을 지울 수 있는 방법은 없습니다. 앱의 새 버전을 다시 배포해도 캐시는 재설정되지 않습니다. 따라서 정적 파일을 수정할 계획이 있다면, 만료 시간이 짧아야 합니다(1시간 미만). 대부분의 경우 만료 시간 기본값인 10분이 적합합니다.
