Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 2.26 KB

README.md

File metadata and controls

58 lines (43 loc) · 2.26 KB
Raw

Overview

Initial GitOps template for Virto Cloud.

Features

  • GitOps repository structure for Virto Commerce Platform and Virto Cloud infrastructure.
  • GitHub workflows for automatic deployment of Virto Commerce Platform and Virto Cloud infrastructure.

Folder structure

  • .github/workflows - GitHub workflows folder with trigger on commit to the main branch.
    • deploy-backend.yml - GitHub workflow with Cloud platform deployment actions.
    • deploy-infra.yml - GitHub workflow with Cloud infra deployment actions.
  • backend - Virto Commerce Platform deployment.
    • packages.json - defines version of Virto Commerce Platform and modules.
    • Dockerfile - Dockerfile for Virto Commerce Platform deployment.
  • infra - declarative description of Virto Cloud infrastructure deployment.
    • environment.yml

How to use

Pre-requirements

  1. Access to Virto Cloud Portal.
  2. Create and deploy new environment in Virto Cloud Portal.
  3. Download environment manifest from Virto Cloud Portal.
  4. Create API Key in Virto Cloud Portal (PLATFORM_TOKEN).
  5. DOCKER_LOGIN
  6. DOCKER_PASSWORD
  7. Enable GitOps in Virto Cloud Portal for the environment.

GitHub repository setup

  1. Create a new repository in your GitHub account.
  2. Copy content of from this branch to your repository.

Cloud infrastucture deployment

  1. Download environment manifest from Virto Cloud and put it to the infra folder.

If you use environment.yml from this repository, you need to replace the following placeholders:

  1. Replace TODO_YOUR_ENVIRONMENT_NAME with your environment name in the environment.yml file.
  2. Replace TODO_YOUR_FRONTEND_HOSTNAME with your frontend hostname in the environment.yml file.
  3. Replace TODO_YOUR_STORE_ID with your store id in the environment.yml file.

Virto Commerce Platform deployment

  1. Update packages.json file with the required version of Virto Commerce Platform and modules.
  2. Set DOCKER_LOGIN in deploy-backend.yml

GitHub Actions

  1. Go to the Settings tab of your repository.
  2. Go to the Secrets section.
  3. Add VIRTOSTART_ACR_DOCKER_PASSWORD and VIRTOSTART_PLATFORM_TOKEN secrets.

Do Commit to the main branch

  1. Commit changes to the main branch.
  2. Review GitHub Actions logs.
  3. Review Virto Cloud Portal logs.