설명서Commerce구현 플레이북

글로벌 참조 아키텍처 예

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • 경험
  • 개발자

이 항목에서는 GRA(전역 참조 아키텍처) 코드 베이스를 구성하는 일반적인 방법에 대해 설명합니다. 개별 패키지 옵션이 선호되지만 경우에 따라 아래에 설명된 다른 옵션 중 하나가 필요합니다.

정의

  • GRA(전역 참조 아키텍처): 화이트 레이블 아키텍처 또는 일반 코드 베이스라고도 합니다. 다중 인스턴스 설정을 위한 모듈 배포 아키텍처입니다.
  • 다중 인스턴스 설정: 동일한 클라이언트가 별도의 지역 또는 브랜드에 대해 별도의 Adobe Commerce 설치를 사용합니다. 각 설치는 고유 모듈을 공유하며
  • 단일 인스턴스 설치: Adobe Commerce 설치가 하나만 있습니다. 소스 코드의 여러 복사본이 서로 다른 테스트 환경에 대해 존재할 수 있지만 프로덕션 코드의 버전은 하나만 있습니다.

옵션 1: 패키지 구분

이 메서드를 설정하려면 작성기 프로젝트 구조 모범 사례를 참조하십시오.

전역 참조 아키텍처에 대한 개별 패키지 옵션을 보여 주는 다이어그램

GRA Composer 패키지를 관리하는 가장 유연한 방법은 메타패키지입니다. 메타패키지에는 다른 패키지 종속성을 정의하는 composer.json 파일만 포함되어 있습니다. 개인 패키지 목록 저장소를 사용하여 메타패키지를 만듭니다.

기본 프로젝트 composer.json

{
    "name": "example-client/region-1",
    "description": "Example Client Region 1",
    "type": "project",
    "require": {
        "magento/product-enterprise-edition": "2.3.5",
        "example-client/meta-region-1": "~1.0"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "repositories": [
        {"type": "composer", "url": "https://repo.packagist.com/example-client/"},
        {"packagist.org": false}
    ]
}

example-client/meta-region-1 composer.json

{
    "name": "example-client/meta-region-1",
    "description": "Region 1 meta package",
    "type": "metapackage",
    "require": {
        "example-client/meta-gra": "~1.0",
        "example-client/theme-frontend-region1",
        "example-client/language-es-es",
        "ingenico/ogone-client"
    }
}

example-client/meta-gra composer.json

{
    "name": "example-client/meta-gra",
    "description": "GRA meta package",
    "type": "metapackage",
    "require": {
        "geoip2/geoip2": "~2.0",
        "magento-services/module-stackify-logger": "~1.1",
        "example-client/sap-connector",
        "example-client/service-chat",
        "example-client/store-locator"
    }
}

각 모듈, 언어 팩, 테마 및 라이브러리에는 자체 Git 저장소가 있습니다. 각 Git 저장소는 개인 패키지 목록 저장소에 자동으로 동기화되며, Git 저장소의 루트에 composer.json 파일이 있는 한 여기에서 패키지를 생성합니다.

옵션 2: 벌크 패키지

다음은 단일 Composer 패키지 내의 여러 모듈에 대한 예입니다.

벌크 패키지는 동일한 유형의 패키지만 포함할 수 있습니다. 예를 들어 Adobe Commerce 모듈, 테마, 언어 팩 및 라이브러리에 대한 패키지가 여러 개 있는 경우 각 유형에 대해 별도의 벌크 패키지를 만들어야 합니다.

공급업체 디렉토리 내의 파일 구조는 다음 예제와 같아야 합니다. 그러나 프로젝트를 확인하여 Git 저장소에 포함해야 하는 항목을 확인하십시오.)

.
└── example-client/
    └── gra/
        └── src/
            ├── SapConnector/
            │   ├── etc/
            │   └── registration.php
            ├── ServiceChat/
            │   ├── etc/
            │   └── registration.php
            ├── StoreLocator/
            │   ├── etc/
            │   └── registration.php
            └── composer.json

composer.json 파일은 다음과 같아야 합니다.

{
    "name": "example-client/gra",
    "description": "GRA Modules",
    "require": {
        "magento/magento-composer-installer": "*"
    },
    "type": "magento2-module",
    "autoload": {
        "files": [
            "src/SapConnector/registration.php",
            "src/ServiceChat/registration.php",
            "src/StoreLocator/registration.php"
        ],
        "psr-4": {
            "ExampleClient\\SapConnector\\": "src/SapConnector",
            "ExampleClient\\ServiceChat\\": "src/ServiceChat",
            "ExampleClient\\StoreLocator\\": "src/StoreLocator"
        }
    }
}

옵션 3: Git 분할

이 아키텍처는 4개의 Git 저장소를 사용하여 코드를 저장합니다.

  • core: Adobe Commerce 핵심 설치를 포함합니다. Adobe Commerce 버전을 업그레이드하는 데 사용됩니다.
  • GRA: GRA 코드를 포함합니다. 모든 GRA 모듈, 언어 팩, 화이트 라벨 테마 및 라이브러리.
  • brand/region: 각 브랜드 또는 지역에는 브랜드 또는 지역별 코드만 있는 자체 저장소가 있습니다.
  • release: 위의 모든 항목이 이 Git 저장소에 병합됩니다. 여기에서는 병합 커밋만 허용됩니다.

전역 참조 아키텍처에 대한 분할 Git 옵션을 보여 주는 다이어그램

이 옵션을 설정하려면 다음을 수행하십시오.

  1. Git에서 네 가지 저장소 유형을 만듭니다. core 및 GRA 리포지토리를 한 번만 만듭니다. 각 브랜드에 대해 하나의 brand/region 및 하나의 release 리포지토리를 만듭니다.

    제안된 저장소 이름:

    • m2-core
    • m2-gra
    • m2-region-x/m2-brand-x(예: m2-emea/m2-adobe)
    • m2-release-region-x/m2-release-brand-x(예: m2-release-emea/m2-release-adobe)

  2. release/ 디렉터리를 만들고 다음을 실행하여 모든 저장소에 대한 공유 Git 기록을 만듭니다.

    code language-bash 
    git init
git remote add origin git@github.com:example-client/m2-release-brand-x.git
git remote add core git@github.com:example-client/m2-core.git
git remote add gra git@github.com:example-client/m2-gra.git
git remote add region-x git@github.com:example-client/m2-region-x.git
touch .gitkeep
git add .gitkeep
git commit -m 'initialize repository'
git push -u origin master
git push core master
git push gra master
git push region-x master

  3. core을(를) 제외한 각 저장소를 컴퓨터의 다른 디렉터리에 복제합니다.

    code language-bash 
    git clone git@github.com:example-client/m2-release-brand-x.git
git clone git@github.com:example-client/m2-region-x.git
git clone git@github.com:example-client/m2-gra.git

  4. 작성기로 Adobe Commerce 설치. .gitignore 파일을 제거하고 core 리모콘을 추가하고 코드를 추가 및 커밋한 다음 푸시합니다.

    code language-bash 
    composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition m2-core
cd m2-core
git init
rm .gitignore
git remote add origin git@github.com:example-client/m2-core.git
git fetch
git checkout .gitkeep
git add --all
git commit -m 'install Adobe Commerce'
git push

  5. GRA 리포지토리에서 다음 디렉터리를 만듭니다.

    • app/code/
    • app/design/
    • app/i18n/
    • lib/

  6. 코드를 추가합니다. .gitignore 파일을 제거하고, 코드를 추가 및 커밋하고, 원격으로 추가하고, 푸시합니다.

  7. brand/region 리포지토리에서. GRA 리포지토리와 동일하게 수행하고 파일이 고유해야 한다는 점을 유의하십시오. 이 리포지토리와 GRA 리포지토리 모두에 동일한 파일을 포함할 수 없습니다.

  8. release 리포지토리에서 병합을 적용합니다.

    code language-bash 
    git clone git@github.com:example-client/m2-release-brand-x.git
cd m2-release-brand-x
git remote add core git@github.com:example-client/m2-core.git
git remote add gra git@github.com:example-client/m2-gra.git
git remote add region-x git@github.com:example-client/m2-region-x.git
git fetch --all
git merge core/master gra/master brand-a/master
git push

  9. .gitkeep 파일을 제거합니다.

  10. 프로덕션, 테스트, QA 및 개발 서버에 release 리포지토리를 배포합니다. core, GRA 및 brand 코드를 업그레이드하면 다음 명령을 쉽게 실행할 수 있습니다.

    code language-bash 
    git fetch --all
git merge core/master gra/master brand-a/master
git push

옵션 4: Monorepo(권장)

이 전략은 Magento Open Source Git 저장소의 작동 방식을 거의 모방합니다.

모든 코드는 단일 저장소에서 개발 및 테스트됩니다. 자동화는 Composer를 사용하여 UAT 및 프로덕션 환경에 설치할 수 있는 이 단일 저장소에서 패키지를 분할합니다.

전역 참조 아키텍처에 대한 모노레포 옵션을 보여 주는 다이어그램

모노레포 옵션을 사용하면 단일 저장소에서 쉽게 작업할 수 있을 뿐만 아니라 패키지를 사용하여 인스턴스를 유연하게 구성할 수 있습니다.

버전 관리 및 패키지 증류는 GitHub 작업 또는 GitLab 작업을 사용하여 자동화를 통해 수행됩니다.

전역 참조 아키텍처에 대한 모노레포 옵션을 보여 주는 다이어그램

이 자동화에 대한 자세한 내용은 다음 리소스를 참조하십시오.

TIP
모노리포를 설정하는 것은 진전되지만 가장 낮은 간접비로 가장 많은 유연성을 제공합니다.

전략을 혼합하지 마십시오.

GRA 패키지용 Composer와 브랜드 또는 지역 패키지용 app/ 디렉터리를 사용하여 결합된 접근 방식을 사용하는 것은 바람직하지 않습니다.

두 메서드의 장점 ​뿐만 아니라 단점 ​도 모두 가져옵니다. 둘 중 하나(Git 또는 Composer)를 선택하여 최적의 상태로 작업해야 합니다.

피해야 할 솔루션

  • GRA 또는 브랜드를 나타내는 모듈 이름 지정 규칙

    GRA나 브랜드를 나타내는 명명 모듈은 유연성의 결여로 이어진다. 대신 작성기 메타패키지를 사용하여 모듈이 속한 그룹을 확인합니다. 예를 들어 고객 VF의 경우 vf/meta-gra 패키지에 모든 GRA 패키지에 대한 참조가 포함되어 있으며 composer require vf/meta-gra 명령을 사용하여 설치할 수 있습니다. vf/meta-kipling 패키지에는 모든 Kipling 특정 패키지와 vf/meta-gra 패키지에 대한 참조가 포함되어 있습니다. 모듈 이름은 vf/module-sales 및 vf/module-sap을(를) 예로 들 수 있습니다. 이 명명 규칙을 사용하면 영향은 작지만 브랜드와 GRA 상태 간에 패키지를 이동할 수 있습니다.

  • 인스턴스당 Adobe Commerce 코어 업그레이드

    다양한 브랜드 또는 지역이 가능한 한 가깝게 실행되도록 패치 업그레이드를 포함한 Adobe Commerce 코어 업그레이드를 예약합니다. 공유 모듈에 대해 여러 Adobe Commerce 버전을 지원하면 호환성 제한으로 인해 모듈이 중단되고 유지 관리 작업이 두 배 이상 증가합니다. 정기적인 개발을 계속하기 전에 모든 인스턴스가 동일한 Adobe Commerce 버전에서 실행되고 있는지 확인하여 이러한 증가된 노력을 방지하십시오.

recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60