Dispatcher 도구를 사용하여 확인 및 디버깅(이전) Dispatcher-tools-legacy

소개 apache-and-dispatcher-configuration-and-testing

다음 단원에서는 레거시 모드 파일 구조, 로컬 유효성 검사, 디버깅 및 레거시 모드에서 유연한 모드(으)로 마이그레이션하는 방법에 대해 설명합니다.

이 문서에서는 프로젝트의 Dispatcher 구성에 Opt-in/USE_SOURCES_DIRECTLY 파일이 포함되어 있지 않다고 가정합니다. 따라서 다음과 같은 파일 수 및 크기에 대한 제한이 있습니다.

Cloud Manager 2021.7.0 릴리스부터 새로운 Cloud Manager 프로그램은 앞에서 언급한 파일이 포함된 AEM Archetype 28 이상의 Maven 프로젝트 구조를 생성합니다.

마이그레이션 섹션 레거시 모드에서 유연한 모드로 마이그레이션에 설명된 대로 레거시 모드에서 유연한 모드로 마이그레이션하는 것이 좋습니다. 또한 유연한 모드를 사용하면 SDK 및 런타임에서 개선된 방식으로 구성의 유효성을 검사하고 배포할 수 있습니다.

파일 구조 legacy-mode-file-structure

프로젝트의 Dispatcher 하위 폴더 구조(레거시 모드)는 다음과 같습니다.

./
├── conf.d
│   ├── available_vhosts
│   │   └── default.vhost
│   ├── dispatcher_vhost.conf
│   ├── enabled_vhosts
│   │   ├── README
│   │   └── default.vhost -> ../available_vhosts/default.vhost
│   └── rewrites
│   │   ├── default_rewrite.rules
│   │   └── rewrite.rules
│   └── variables
|       ├── custom.vars
│       └── global.vars
└── conf.dispatcher.d
    ├── available_farms
    │   └── default.farm
    ├── cache
    │   ├── default_invalidate.any
    │   ├── default_rules.any
    │   ├── marketing_query_parameters.any
    │   └── rules.any
    ├── clientheaders
    │   ├── clientheaders.any
    │   └── default_clientheaders.any
    ├── dispatcher.any
    ├── enabled_farms
    │   ├── README
    │   └── default.farm -> ../available_farms/default.farm
    ├── filters
    │   ├── default_filters.any
    │   └── filters.any
    ├── renders
    │   └── default_renders.any
    └── virtualhosts
        ├── default_virtualhosts.any
        └── virtualhosts.any

다음은 수정할 수 있는 주요 파일에 대한 설명입니다.

사용자 지정 가능한 파일

다음 파일은 사용자 지정할 수 있으며 배포 시 클라우드 인스턴스로 전송됩니다.

이러한 파일이 한 개 이상 있을 수 있습니다. 여기에는 호스트 이름과 일치하고 Apache가 서로 다른 규칙으로 각 도메인 트래픽을 처리할 수 있도록 하는 <VirtualHost>개의 항목이 포함되어 있습니다. 파일이 available_vhosts 디렉터리에 만들어지고 enabled_vhosts 디렉터리에서 심볼 링크로 활성화됩니다. .vhost 파일에서 다시 쓰기 및 변수와 같은 다른 파일이 포함됩니다.

이 파일은 .vhost 파일 내에 포함되어 있습니다. mod_rewrite에 대한 재작성 규칙 집합이 있습니다.

이 파일은 .vhost 파일 내에 포함되어 있습니다. 이 위치에 Apache 변수에 대한 정의를 추가할 수 있습니다.

이 파일은 dispatcher_vhost.conf 파일 내에 포함되어 있습니다. 이 파일에서 Dispatcher을 변경하고 로그 수준을 다시 쓸 수 있습니다.

이러한 파일은 하나 이상 있을 수 있으며, 여기에는 호스트 이름과 일치하는 팜이 포함되어 있고 Dispatcher 모듈이 서로 다른 규칙으로 각 팜을 처리할 수 있도록 합니다. 파일이 available_farms 디렉터리에 만들어지고 enabled_farms 디렉터리에서 심볼 링크로 활성화됩니다. .farm 파일에서 필터, 캐시 규칙 및 기타 파일과 같은 다른 파일이 포함됩니다.

이 파일은 .farm 파일 내에 포함되어 있습니다. 캐싱 기본 설정을 지정합니다.

이 파일은 .farm 파일 내에 포함되어 있습니다. 백엔드에 전달할 요청 헤더를 지정합니다.

이 파일은 .farm 파일 내에 포함되어 있습니다. 필터링해야 하는 트래픽을 변경하고 백엔드로 전환하지 않는 규칙 세트가 있습니다.

이 파일은 .farm 파일 내에 포함되어 있습니다. glob 일치로 일치시킬 호스트 이름 또는 URI 경로 목록이 있습니다. 이 일치는 요청을 제공하는 데 사용할 백엔드를 결정합니다.

위의 파일은 아래 나열된 변경 불가능한 구성 파일을 참조합니다. 변경 불가능한 파일에 대한 변경 사항은 클라우드 환경의 Dispatcher에서 처리되지 않습니다.

변경할 수 없는 구성 파일

이러한 파일은 기본 프레임워크의 일부이며 표준 및 모범 사례를 적용합니다. 파일은 클라우드 인스턴스로 전송되지 않으므로 로컬에서 수정하거나 삭제해도 배포에 영향을 주지 않으므로 변경할 수 없는 것으로 간주됩니다.

위의 파일은 아래 나열된 변경 불가능한 파일을 참조한 후 추가 문 또는 무시를 수행하는 것이 좋습니다. Dispatcher 구성이 클라우드 환경에 배포되면 로컬 개발에 사용된 버전에 관계없이 변경할 수 없는 파일의 최신 버전이 사용됩니다.

샘플 가상 호스트를 포함합니다. 가상 호스트의 경우 이 파일의 복사본을 만들고 사용자 지정한 다음 conf.d/enabled_vhosts(으)로 이동하여 사용자 지정한 복사본에 대한 심볼 링크를 만드십시오.

가상 호스트 및 전역 변수가 포함된 방법을 보여 주는 데 사용되는 기본 프레임워크의 일부입니다.

표준 프로젝트에 적합한 재작성에 대한 기본 규칙. 사용자 지정이 필요한 경우 rewrite.rules을(를) 편집하세요. 사용자 지정에서 필요에 맞는 기본 규칙을 먼저 포함할 수 있습니다.

샘플 Dispatcher 팜을 포함합니다. 팜의 경우 이 파일의 복사본을 만들고 사용자 지정한 다음 conf.d/enabled_farms(으)로 이동하여 사용자 지정한 복사본에 대한 심볼 링크를 만드십시오.

시작 시 기본 프레임워크의 일부인 가 생성됩니다. cache/allowedClients 섹션에서 정의하는 모든 팜에 이 파일을 포함하는 것은 필수 ​입니다.

표준 프로젝트에 적합한 기본 캐시 규칙입니다. 사용자 지정이 필요한 경우 conf.dispatcher.d/cache/rules.any을(를) 수정하세요. 사용자 지정에서 필요에 맞는 기본 규칙을 먼저 포함할 수 있습니다.

표준 프로젝트에 적합한 백엔드로 전달할 기본 요청 헤더입니다. 사용자 지정이 필요한 경우 clientheaders.any을(를) 수정하세요. 사용자 지정에서 필요에 맞는 기본 요청 헤더를 먼저 포함할 수 있습니다.

Dispatcher 팜이 포함된 방법을 보여 주는 기본 프레임워크의 일부입니다.

표준 프로젝트에 적합한 기본 필터. 사용자 지정이 필요한 경우 filters.any을(를) 수정하세요. 사용자 지정에서 필요에 맞는 기본 필터를 먼저 포함할 수 있습니다.

기본 프레임워크의 일부인 이 파일은 시작 시 생성됩니다. renders 섹션에서 정의하는 모든 팜에 이 파일을 포함하는 것은 필수 ​입니다.

표준 프로젝트에 적합한 기본 호스트 글로빙. 사용자 지정이 필요한 경우 virtualhosts.any을(를) 수정하세요. 사용자 지정에서는 every 수신 요청과 일치하므로 기본 호스트 globbing을 포함하지 않아야 합니다.

지원되는 Apache 모듈 apache-modules

지원되는 Apache 모듈을 참조하십시오.

로컬 유효성 검사 local-validation-legacy-mode

아래와 같이 validate.sh 스크립트를 사용합니다.

$ validate.sh src/dispatcher
Phase 1: Dispatcher validator
Cloud manager validator 2.0.32
Phase 1 finished
Phase 2: httpd -t validation in docker image
values.csv found in deployment folder: /tmp/dispatcher_validation_1625150390 - using files listed there
Running script /docker_entrypoint.d/10-check-environment.sh
Running script /docker_entrypoint.d/20-create-docroots.sh
Running script /docker_entrypoint.d/30-wait-for-backend.sh
Waiting until localhost is available
localhost resolves to ::1
Running script /docker_entrypoint.d/40-generate-allowed-clients.sh
Running script /docker_entrypoint.d/50-check-expiration.sh
Running script /docker_entrypoint.d/60-check-loglevel.sh
Running script /docker_entrypoint.d/70-check-forwarded-host-secret.sh
# Dispatcher configuration: (/etc/httpd/conf.dispatcher.d/dispatcher.any)
/farms {

...

}
Syntax OK
Phase 2 finished
Phase 3: Immutability check
reading immutable file list from /etc/httpd/immutable.files.txt

...

no immutable file has been changed - check is SUCCESSFUL
Phase 3 finished

스크립트는 다음을 수행합니다.

Cloud Manager 배포 중에 httpd -t 구문 검사도 실행되고 모든 오류가 Cloud Manager Build Images step failure 로그에 포함됩니다.

단계 1 first-phase

지시문이 허용 목록에추가된이 아닌 경우 이 도구는 오류를 기록하고 0이 아닌 종료 코드를 반환합니다. 또한 패턴이 conf.dispatcher.d/enabled_farms/*.farm인 모든 파일을 추가로 검색하고 다음을 확인합니다.

유효성 검사 도구는 허용 목록에추가된이 아닌 Apache 지시문의 금지된 사용만 보고합니다. 이 정보는 실행 중인 환경의 Apache 모듈에서만 사용할 수 있으므로 Apache 구성과 관련된 구문 또는 의미 체계 문제를 보고하지 않습니다.

다음은 도구에서 출력하는 일반적인 유효성 검사 오류를 디버깅하기 위한 문제 해결 기술입니다.

보관 위치에서 conf.dispatcher.d 하위 폴더를 찾을 수 없습니다

Your archive should contain folders conf.d and conf.dispatcher.d. Note, that you should not
use the prefix etc/httpd in your archive.

conf.dispatcher.d/enabled_farms ​에서 팜을 찾을 수 없습니다.

활성화된 팜은 언급된 하위 폴더에 있어야 합니다.

포함된 파일(…) 이름은 다음과 같아야 합니다. …

팜 구성에는 필수 ​에 포함된 두 개의 섹션이 있습니다.
특정 파일: /cache 섹션의 /renders 및 /allowedClients. 해당
섹션은 다음과 같아야 합니다.

/renders {
    $include "../renders/default_renders.any"
}

및:

/allowedClients {
    $include "../cache/default_invalidate.any"
}

알 수 없는 위치에 포함된 파일: …

팜 구성에는 네 개의 섹션이 있습니다. 여기서 자신의 파일을 포함할 수 있습니다. /cache 섹션 및 /virtualhosts의 /clientheaders, filters, /rules. 포함된 파일의 이름은 다음과 같이 지정해야 합니다.

또는 default 버전의 파일을 포함할 수 있습니다. 해당 파일의 이름 앞에는 default_(예: ../filters/default_filters.any)이 추가됩니다.

알려진 위치 외부의 (…)에 문을 포함합니다. …

위 단락에 언급된 6개의 부분 외에는 허용되지 않습니다
예를 들어 $include 문을 사용하려면 다음 오류가 발생합니다.

/invalidate {
    $include "../cache/invalidate.any"
}

허용된 클라이언트/렌더링이 다음에서 포함되지 않음: …

이 오류는 /cache 섹션에서 /renders 및 /allowedClients에 대해 "포함"을 지정하지 않을 때 생성됩니다. 다음을 참조하십시오.
포함된 파일(…)의 이름은 다음 섹션으로 지정해야 합니다..

필터를 통해 glob 패턴을 사용하여 요청을 허용하지 않아야 함

전체 요청 행에 대해 일치하는 /glob 스타일 규칙을 사용하는 요청을 허용하는 것은 안전하지 않습니다. 예를 들어

/0100 {
    /type "allow" /glob "GET *.css *"
}

이 문은 css개 파일에 대한 요청을 허용하지만 쿼리 문자열 ?a=.css이(가) 뒤따르는 any 리소스에 대한 요청도 허용합니다. 따라서 이러한 필터는 사용할 수 없습니다(CVE-2016-0957 참조).

포함된 파일(…)이 알려진 파일과 일치하지 않습니다

Apache 가상 호스트 구성에는 재작성과 변수의 두 가지 유형으로 지정할 수 있습니다.
포함된 파일의 이름은 다음과 같이 지정해야 합니다.

또는 이름이 conf.d/rewrites/default_rewrite.rules인 기본 버전의 다시 작성 규칙을 포함할 수 있습니다.
변수 파일의 기본 버전은 없습니다.

사용되지 않는 구성 레이아웃이 검색되어 호환성 모드가 활성화됩니다.

이 메시지는 구성에 더 이상 사용되지 않는 버전 1 레이아웃이 포함되어 있음을 나타냅니다.
ams_ 접두사가 있는 Apache 구성 및 파일입니다. 이 구성은 여전히 이전 버전에서 지원됩니다.
호환성, 새 레이아웃으로 전환해야 합니다.

첫 번째 단계는 래퍼 validate.sh 스크립트가 아닌 별도로 실행 ​할 수도 있습니다.

Maven 아티팩트 또는 dispatcher/src 하위 디렉터리에 대해 실행되면 유효성 검사 실패를 보고합니다.

$ validator full dispatcher/src
Cloud manager validator 1.0.4
2019/06/19 15:41:37 Apache configuration uses non-allowlisted directives:
  conf.d/enabled_vhosts/aem_publish.vhost:46: LogLevel
2019/06/19 15:41:37 Dispatcher configuration validation failed:
  conf.dispatcher.d/enabled_farms/999_ams_publish_farm.any: filter allows access to CRXDE

Windows에서 Dispatcher 유효성 검사기는 대/소문자를 구분합니다. 따라서 구성이 있는 경로의 대소문자를 고려하지 않으면 구성의 유효성을 검사하지 못할 수 있습니다. 예를 들면 다음과 같습니다.

bin\validator.exe full src
Cloud manager validator 2.0.xx
2021/03/15 18:15:40 Dispatcher configuration validation failed:
  conf.dispatcher.d\available_farms\default.farm:15: parent directory outside server root: c:\k\a\aem-dispatcher-sdk-windows-symlinks-testing3\dispatcher\src

Windows 탐색기에서 경로를 복사하여 붙여 넣은 다음 cd 명령을 사용하여 명령 프롬프트에서 해당 경로에 붙여 넣으면 이 오류가 발생하지 않습니다.

단계 2 second-phase

이 단계에서는 이미지에서 도커를 시작하여 Apache 구문을 확인합니다. Docker를 로컬에 설치해야 하지만 AEM을 실행할 필요는 없습니다.

이 단계는 validator full -d out src/dispatcher을(를) 통해 독립적으로 실행할 수도 있으며, 다음 명령 bin/docker_run.sh out host.docker.internal:4503 8080에 필요한 "out" 디렉터리를 생성합니다.

Cloud Manager 배포 중에 httpd -t 구문 검사가 실행되고 모든 오류가 Cloud Manager 빌드 이미지 단계 오류 로그에 포함됩니다.

단계 3 third-phase

이 단계에서 오류가 발생하면 Adobe에서 변경할 수 없는 파일을 하나 이상 변경했음을 의미합니다. 이 경우 변경할 수 없는 해당 파일을 SDK의 src 디렉터리에 전달된 새 버전으로 바꿔야 합니다. 다음 로그 샘플은 이 문제를 보여 줍니다.

Phase 3: Immutability check
reading immutable file list from /etc/httpd/immutable.files.txt
(...)
checking existing 'conf.dispatcher.d/clientheaders/default_clientheaders.any' for changes
immutable file 'conf.dispatcher.d/clientheaders/default_clientheaders.any' has been changed:
--- /etc/httpd/conf.dispatcher.d/clientheaders/default_clientheaders.any
+++ /etc/httpd-actual/conf.dispatcher.d/clientheaders/default_clientheaders.any
@@ -40,4 +40,3 @@
"Sling-uploadmode"
"x-requested-with"
"If-Modified-Since"
-"Authorization"
** error: immutable file 'conf.dispatcher.d/clientheaders/default_clientheaders.any' has been changed!

이 단계는 다음 명령 bin/docker_immutability_check.sh out에 필요한 "out" 디렉터리를 생성하는 validator full -d out src/dispatcher을(를) 통해 독립적으로 실행할 수도 있습니다.

Apache 및 Dispatcher 구성 디버깅 debugging-apache-and-dispatcher-configuration

./bin/docker_run.sh out docker.for.mac.localhost:4503 8080을(를) 사용하여 로컬에서 Apache Dispatcher을 실행할 수 있습니다.

앞에서 설명한 대로 Docker를 로컬에 설치해야 하며, AEM을 실행할 필요는 없습니다. Windows 사용자는 Windows 10 Professional 또는 Docker를 지원하는 기타 배포를 사용해야 합니다. 이 전제 조건은 로컬 컴퓨터에서 Dispatcher을 실행하고 디버깅하는 데 필요합니다.

다음 전략을 사용하여 Dispatcher 모듈에 대한 로그 출력을 높이고 로컬 및 클라우드 환경 모두에서 RewriteRule 평가 결과를 볼 수 있습니다.

이러한 모듈에 대한 로그 수준은 변수 DISP_LOG_LEVEL 및 REWRITE_LOG_LEVEL에 의해 정의됩니다. conf.d/variables/global.vars 파일에서 설정할 수 있습니다. 관련 부분은 다음과 같습니다.

# Log level for the dispatcher
#
# Possible values are: error, warn, info, debug and trace1
# Default value: warn
#
# Define DISP_LOG_LEVEL warn

# Log level for mod_rewrite
#
# Possible values are: error, warn, info, debug and trace1 - trace8
# Default value: warn
#
# To debug your RewriteRules, it is recommended to raise your log
# level to trace2.
#
# More information can be found at:
# https://httpd.apache.org/docs/current/mod/mod_rewrite.html#logging
#
# Define REWRITE_LOG_LEVEL warn

Dispatcher을 로컬로 실행하면 로그가 터미널 출력에 직접 인쇄됩니다. 대부분의 경우 이러한 로그를 DEBUG로 만들어야 합니다. 이 작업은 도커를 실행할 때 디버그 수준을 매개 변수로 전달하여 수행할 수 있습니다. 예: DISP_LOG_LEVEL=Debug ./bin/docker_run.sh out docker.for.mac.localhost:4503 8080.

클라우드 환경의 로그는 Cloud Manager에서 사용할 수 있는 로깅 서비스를 통해 노출됩니다.

환경당 다른 Dispatcher 구성 different-dispatcher-configurations-per-environment

현재 동일한 Dispatcher 구성이 AEM as a Cloud Service의 모든 환경에 적용됩니다. 런타임에 현재 실행 모드(dev, stag 또는 prod)를 포함하는 환경 변수 ENVIRONMENT_TYPE이(가) 있으며, 정의가 있습니다. ENVIRONMENT_DEV, ENVIRONMENT_STAGE 또는 ENVIRONMENT_PROD을(를) 정의할 수 있습니다. Apache 구성에서 변수는 표현식에서 직접 사용할 수 있습니다. 또는 정의를 사용하여 논리를 빌드할 수 있습니다.

# Simple usage of the environment variable
ServerName ${ENVIRONMENT_TYPE}.company.com

# When more logic is required
<IfDefine ENVIRONMENT_STAGE>
  # These statements are for stage
  Define VIRTUALHOST stage.example.com
</IfDefine>
<IfDefine ENVIRONMENT_PROD>
  # These statements are for production
  Define VIRTUALHOST prod.example.com
</IfDefine>

Dispatcher 구성에서 동일한 환경 변수를 사용할 수 있습니다. 더 많은 논리가 필요한 경우 위의 예제와 같이 변수를 정의한 다음 Dispatcher 구성 섹션에서 사용하십시오.

/virtualhosts {
  { "${VIRTUALHOST}" }
}

로컬에서 구성을 테스트할 때 DISP_RUN_MODE 변수를 docker_run.sh 스크립트에 직접 전달하여 다양한 환경 유형을 시뮬레이션할 수 있습니다.

$ DISP_RUN_MODE=stage docker_run.sh out docker.for.mac.localhost:4503 8080

DISP_RUN_MODE에 대한 값을 전달하지 않을 때의 기본 실행 모드는 "dev"입니다.
사용 가능한 옵션 및 변수의 전체 목록을 보려면 인수 없이 docker_run.sh 스크립트를 실행하십시오.

도커 컨테이너에서 사용 중인 Dispatcher 구성 보기 viewing-dispatcher-configuration-in-use-by-docker-container

환경별 구성에서는 실제 Dispatcher 구성이 어떻게 표시되는지 확인하기 어려울 수 있습니다. docker_run.sh(으)로 도커 컨테이너를 시작한 후 다음과 같이 덤프할 수 있습니다.

$ docker ps
CONTAINER ID       IMAGE
d75fbd23b29        adobe/aem-ethos/dispatcher-publish:...

$ docker exec d75fbd23b29 httpd-test
# Dispatcher configuration: (/etc/httpd/conf.dispatcher.d/dispatcher.any)
/farms {
  /publishfarm {
    /clientheaders {
...

레거시 모드에서 유연한 모드로 마이그레이션 migrating-flexible

Cloud Manager 2021.7.0 릴리스에서는 새로운 Cloud Manager 프로그램이 opt-in/USE_SOURCES_DIRECTLY 파일을 포함하는 AEM Archetype 28 이상의 Maven 프로젝트 구조를 생성합니다. 파일 수와 크기에 대한 이전 제한 사항이 제거되므로 SDK 및 런타임에서 개선된 방법으로 구성의 유효성을 검사하고 배포할 수 있습니다. Dispatcher 구성에 이 파일이 없는 경우 마이그레이션하는 것이 좋습니다. 유연한 모드 페이지에 설명된 메서드를 사용합니다.