diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 690a4ed0e64..e9706a5fe2b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -61,8 +61,8 @@ jobs: - run: bundle exec rake check_acp_user - link_validation_check_cloud: - name: Links validation (check_cloud) + link_validation_check_ca: + name: Links validation (check_ca) needs: jekyll_build runs-on: ubuntu-latest @@ -87,7 +87,7 @@ jobs: - name: Unpack artifacts run: tar -xf build-result/result.tar.gz - - run: bundle exec rake check_cloud + - run: bundle exec rake check_ca link_validation_check_scos_dev: name: Links validation (check_scos_dev) @@ -258,7 +258,7 @@ jobs: ruby-version: 2.6 bundler-cache: true - - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_cloud_dev.yml + - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_ca_dev.yml env: # Or as an environment variable ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_scos_dev.yml diff --git a/Rakefile b/Rakefile index 914acab9c18..0541b284022 100644 --- a/Rakefile +++ b/Rakefile @@ -82,7 +82,7 @@ task :check_acp_user do options = commonOptions.dup options[:file_ignore] = [ /docs\/scos\/.+/, - /docs\/cloud\/.+/, + /docs\/ca\/.+/, /docs\/fes\/.+/, /docs\/scu\/.+/, /docs\/pbc\/.+/, @@ -91,7 +91,7 @@ task :check_acp_user do HTMLProofer.check_directory("./_site", options).run end -task :check_cloud do +task :check_ca do options = commonOptions.dup options[:file_ignore] = [ /docs\/scos\/.+/, @@ -108,7 +108,7 @@ end task :check_scos_dev do options = commonOptions.dup options[:file_ignore] = [ - /docs\/cloud\/.+/, + /docs\/ca\/.+/, /docs\/fes\/.+/, /docs\/scu\/.+/, /docs\/acp\/.+/, @@ -131,7 +131,7 @@ end task :check_scos_user do options = commonOptions.dup options[:file_ignore] = [ - /docs\/cloud\/.+/, + /docs\/ca\/.+/, /docs\/acp\/.+/, /docs\/scos\/dev\/.+/, /docs\/fes\/.+/, @@ -155,7 +155,7 @@ task :check_scu do options = commonOptions.dup options[:file_ignore] = [ /docs\/scos\/.+/, - /docs\/cloud\/.+/, + /docs\/ca\/.+/, /docs\/acp\/.+/, /docs\/fes\/.+/, /docs\/pbc\/.+/, @@ -169,7 +169,7 @@ task :check_pbc do options[:file_ignore] = [ /docs\/scos\/.+/, /docs\/sdk\/.+/, - /docs\/cloud\/.+/, + /docs\/ca\/.+/, /docs\/fes\/.+/, /docs\/acp\/.+/, /docs\/scu\/.+/, @@ -186,7 +186,7 @@ task :check_sdk do options = commonOptions.dup options[:file_ignore] = [ /docs\/scos\/.+/, - /docs\/cloud\/.+/, + /docs\/ca\/.+/, /docs\/acp\/.+/, /docs\/fes\/.+/, /docs\/pbc\/.+/, diff --git a/_config.yml b/_config.yml index 890337276ca..610ffbfa706 100644 --- a/_config.yml +++ b/_config.yml @@ -111,14 +111,14 @@ defaults: role: "dev" - scope: - path: "docs/cloud" + path: "docs/ca" values: - product: "cloud" + product: "ca" - scope: - path: "docs/cloud/dev" + path: "docs/ca/dev" values: - sidebar: "cloud_dev_sidebar" + sidebar: "ca_dev_sidebar" role: "dev" - scope: @@ -222,7 +222,7 @@ versioned_categories: # these are defaults used for the front matter for these file types sidebars: - - cloud_dev_sidebar + - ca_dev_sidebar - scos_dev_sidebar - scos_user_sidebar - sdk_dev_sidebar @@ -255,8 +255,8 @@ algolia: title: 'SCOS Developer' - name: 'sdk_dev' title: 'SDK Developer' - - name: 'cloud_dev' - title: 'Cloud Developer' + - name: 'ca_dev' + title: 'Cloud administration' - name: 'acp_user' title: 'ACP User' - name: 'scu_dev' diff --git a/_data/sidebars/ca_dev_sidebar.yml b/_data/sidebars/ca_dev_sidebar.yml new file mode 100644 index 00000000000..2e1e0aa6ed1 --- /dev/null +++ b/_data/sidebars/ca_dev_sidebar.yml @@ -0,0 +1,159 @@ +title: Cloud administration guide +entries: + - product: Cloud administration + nested: + - title: Getting started with cloud administration + url: /docs/ca/dev/getting-started-with-cloud-administration.html + - title: Environments overview + url: /docs/ca/dev/environments-overview.html + - title: Environments provisioning + url: /docs/ca/dev/environment-provisioning.html + - title: Access + url: /docs/ca/dev/access/access.html + nested: + - title: Access AWS Management Console + url: /docs/ca/dev/access/access-the-aws-management-console.html + - title: Locate service credentials + url: /docs/ca/dev/access/locate-service-credentials.html + - title: Connect to services via SSH + url: /docs/ca/dev/access/connect-to-services-via-ssh.html + - title: Connecting the Docker SDK + url: /docs/ca/dev/connecting-the-docker-sdk.html + - title: Connect a code repository + url: /docs/ca/dev/connect-a-code-repository.html + - title: Set up a custom domain name + url: /docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name.html + nested: + - title: Set up a custom domain name with Route 53 + url: /docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-route-53.html + - title: Set up a custom domain name with a third-party DNS zone provider + url: /docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.html + - title: Setting up a custom SSL certificate + url: /docs/ca/dev/setting-up-a-custom-ssl-certificate.html + - title: Deploy in a staging environment + url: /docs/ca/dev/deploy-in-a-staging-environment.html + - title: Configure debugging + url: /docs/ca/dev/configure-debugging.html + - title: Working with logs + url: /docs/ca/dev/working-with-logs.html + - title: Preparation for going live + url: /docs/ca/dev/preparation-for-going-live.html + - title: Deploy in a production environment + url: /docs/ca/dev/deploy-in-a-production-environment.html + - title: Starting asynchronous commands + url: /docs/ca/dev/starting-asynchronous-commands.html + - title: Best practices + url: /docs/ca/dev/best-practices/best-practices.html + nested: + - title: "Best practises: Jenkins stability" + url: /docs/ca/dev/best-practices/best-practises-jenkins-stability.html + - title: Manage maintenance mode + nested: + - title: Enable and disable maintenance mode + url: /docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html + - title: Configure access to applications in maintenance mode + url: /docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html + - title: Monitoring + url: /docs/ca/dev/monitoring/monitoring.html + nested: + - title: Performance and availability monitoring via New Relic + url: /docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.html + - title: Customize AWS CloudWatch dashboards + url: /docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.html + - title: Security + url: /docs/ca/dev/security/security.html + nested: + - title: Check ECR image scan results + url: /docs/ca/dev/security/check-ecr-image-scan-results.html + - title: Generate access keys + url: /docs/ca/dev/security/generate-access-keys.html + - title: Web Application Firewall (WAF) + url: /docs/ca/dev/security/web-application-firewall-waf.html + - title: Configure deployment pipelines + url: /docs/ca/dev/configure-deployment-pipelines/configure-deployment-pipelines.html + nested: + - title: Deployment pipelines + url: /docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html + - title: Deployment in states + url: /docs/ca/dev/configure-deployment-pipelines/deployment-in-states.html + - title: Customize deployment pipelines + url: /docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html + - title: Configure Azure Pipelines + url: /docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.html + - title: Configure GitHub Actions + url: /docs/ca/dev/configure-deployment-pipelines/configure-github-actions.html + - title: Configure GitLab pipelines + url: /docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.html + - title: Configure Bitbucket Pipelines + url: /docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.html + - title: Configure data import from an S3 bucket + url: /docs/ca/dev/configure-data-import-from-an-s3-bucket.html + - title: Create and restore databse backups + url: /docs/ca/dev/create-and-restore-database-backups.html + - title: Add variables in the Parameter Store + url: /docs/ca/dev/add-variables-in-the-parameter-store.html + - title: Verify email addresses + url: /docs/ca/dev/verify-email-addresses.html + - title: Set up notifications for 5xx errors + url: /docs/ca/dev/set-up-notifications-for-5xx-errors.html + - title: Performance testing in staging environments + url: /docs/ca/dev/performance-testing-in-staging-enivronments.html + - title: Managing parameters in the Parameter Store + url: /docs/ca/dev/managing-parameters-in-the-parameter-store.html + - title: Monitoring issues and informing about alerts + url: /docs/ca/dev/monitoring-issues-and-informing-about-alerts.html + - title: Multi-store setups + url: /docs/ca/dev/multi-store-setups/multi-store-setups.html + nested: + - title: Multistore setup options + url: /docs/ca/dev/multi-store-setups/multistore-setup-options.html + - title: Add and remove databases of stores + url: /docs/ca/dev/multi-store-setups/add-and-remove-databases-of-stores.html + - title: Checklist for a new store implementation + url: /docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.html + - title: Troubleshooting + url: /docs/ca/dev/troubleshooting/troubleshooting.html + nested: + - title: Troubleshooting deployment issues + url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.html + nested: + - title: Assets, logs, or pipelines are not visible in AWS Management Console + url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html + - title: Deployment fails due to a failed docker authentication + url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.html + - title: Jenkins does not restart + url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.html + - title: Troubleshooting general issues + url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.html + nested: + - title: Changing a source branch fails + url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.html + - title: Email address is not verified + url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.html + - title: 'Fatal error: Allowed memory size of x bytes exhausted' + url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.html + - title: Missing migration files on production environments + url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.html + - title: Troubleshooting tutorials + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.html + nested: + - title: Troubleshooting a failed deployment + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.html + - title: Troubleshooting a killed process + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.html + - title: Troubleshooting an unavailable Zed + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.html + - title: Troubleshooting failed Jenkins jobs + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.html + - title: Troubleshooting failing Yves authentication + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.html + - title: Troubleshooting error 403 + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html + - title: Troubleshooting unavailable Yves or Glue + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.html + - title: Troubleshooting Yves or Zed not restarting after deployment + url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.html + - title: Release notes + url: /docs/ca/dev/release-notes.html + - title: Spryker Cloud Commerce OS management + url: /docs/ca/dev/spryker-cloud-commerce-os-management.html diff --git a/_data/sidebars/cloud_dev_sidebar.yml b/_data/sidebars/cloud_dev_sidebar.yml deleted file mode 100644 index 89bf2d351d4..00000000000 --- a/_data/sidebars/cloud_dev_sidebar.yml +++ /dev/null @@ -1,161 +0,0 @@ -title: SCCOS Engineer guides -entries: - - product: CLOUD - nested: - - title: Getting started with the Spryker Cloud Commerce OS - url: /docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html - - title: Environments overview - url: /docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html - - title: Environments provisioning - url: /docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.html - - title: Access - url: /docs/cloud/dev/spryker-cloud-commerce-os/access/access.html - nested: - - title: Accessing AWS Management Console - url: /docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.html - - title: Locating service credentials - url: /docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.html - - title: Connecting to services via SSH - url: /docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.html - - title: Connecting the Docker SDK - url: /docs/cloud/dev/spryker-cloud-commerce-os/connecting-the-docker-sdk.html - - title: Connecting a code repository - url: /docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.html - - title: Setting up a custom domain name - url: /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name.html - nested: - - title: Setting up a custom domain name with Route 53 - url: /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-route-53.html - - title: Setting up a custom domain name with a third-party DNS zone provider - url: /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.html - - title: Setting up a custom SSL certificate - url: /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html - - title: Deploying in a staging environment - url: /docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html - - title: Configuring debugging - url: /docs/cloud/dev/spryker-cloud-commerce-os/configuring-debugging.html - - title: Working with logs - url: /docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.html - - title: Preparation for going live - url: /docs/cloud/dev/spryker-cloud-commerce-os/preparation-for-going-live.html - - title: Deploying in a production environment - url: /docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html - - title: Starting asynchronous commands - url: /docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.html - - title: Best practices - url: /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.html - nested: - - title: "Best practises: Jenkins stability" - url: /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html - - title: Manage maintenance mode - nested: - - title: Enable and disable maintenance mode - url: /docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.html - - title: Configure access to applications in maintenance mode - url: /docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html - - title: Monitoring - url: /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/monitoring.html - nested: - - title: Performance and availability monitoring via New Relic - url: /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.html - - title: Customize AWS CloudWatch dashboards - url: /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/customize-aws-cloudwatch-dashboards.html - - title: Security - url: /docs/cloud/dev/spryker-cloud-commerce-os/security/security.html - nested: - - title: Checking ECR image scan results - url: /docs/cloud/dev/spryker-cloud-commerce-os/security/checking-ecr-image-scan-results.html - - title: Generating access keys - url: /docs/cloud/dev/spryker-cloud-commerce-os/security/generating-access-keys.html - - title: Web Application Firewall (WAF) - url: /docs/cloud/dev/spryker-cloud-commerce-os/security/web-application-firewall-waf.html - - title: Configure deployment pipelines - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configure-deployment-pipelines.html - nested: - - title: Deployment pipelines - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html - - title: Deployment in states - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.html - - title: Customizing deployment pipelines - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html - - title: Configuring Azure Pipelines - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.html - - title: Configuring GitHub Actions - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.html - - title: Configuring GitLab pipelines - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.html - - title: Configuring Bitbucket Pipelines - url: /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.html - - title: Configuring data import from an S3 bucket - url: /docs/cloud/dev/spryker-cloud-commerce-os/configuring-data-import-from-an-s3-bucket.html - - title: Create and restore databse backups - url: /docs/cloud/dev/spryker-cloud-commerce-os/create-and-restore-database-backups.html - - title: Add variables in the Parameter Store - url: /docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html - - title: Verifying email addresses - url: /docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.html - - title: Setting up notifications for 5xx errors - url: /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-notifications-for-5xx-errors.html - - title: Peformance testing - url: /docs/cloud/dev/spryker-cloud-commerce-os/performance-testing.html - - title: Performance testing in staging environments - url: /docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html - - title: Managing parameters in the Parameter Store - url: /docs/cloud/dev/spryker-cloud-commerce-os/managing-parameters-in-the-parameter-store.html - - title: Monitoring issues and informing about alerts - url: /docs/cloud/dev/spryker-cloud-commerce-os/monitoring-issues-and-informing-about-alerts.html - - title: Multi-store setups - url: /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.html - nested: - - title: Multistore setup options - url: /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html - - title: Add and remove databases of stores - url: /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.html - - title: Checklist for a new store implementation - url: /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.html - - title: Troubleshooting - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting.html - nested: - - title: Troubleshooting deployment issues - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.html - nested: - - title: Assets, logs, or pipelines are not visible in AWS Management Console - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html - - title: Deployment fails due to a failed docker authentication - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.html - - title: Jenkins does not restart - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.html - - title: Troubleshooting general issues - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.html - nested: - - title: Changing a source branch fails - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.html - - title: Email address is not verified - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.html - - title: 'Fatal error: Allowed memory size of x bytes exhausted' - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.html - - title: Missing migration files on production environments - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.html - - title: Troubleshooting tutorials - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.html - nested: - - title: Troubleshooting a failed deployment - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.html - - title: Troubleshooting a killed process - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.html - - title: Troubleshooting an unavailable Zed - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.html - - title: Troubleshooting failed Jenkins jobs - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.html - - title: Troubleshooting failing Yves authentication - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.html - - title: Troubleshooting error 403 - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html - - title: Troubleshooting unavailable Yves or Glue - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.html - - title: Troubleshooting Yves or Zed not restarting after deployment - url: /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.html - - title: Release notes - url: /docs/cloud/dev/spryker-cloud-commerce-os/release-notes.html - - title: Spryker Cloud Commerce OS management - url: /docs/cloud/dev/spryker-cloud-commerce-os/spryker-cloud-commerce-os-management.html diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 192774ebdbc..61929a95924 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -4837,7 +4837,7 @@ entries: url: /docs/scos/dev/guidelines/testing-guidelines/testing-guidelines.html nested: - title: Code coverage - url: /docs/scos/dev/guidelines/testing-guidelines/code-coverage.html + url: /docs/scos/dev/guidelines/testing-guidelines/code-coverage.html - title: Test framework url: /docs/scos/dev/guidelines/testing-guidelines/test-framework.html - title: Setting up tests @@ -4863,7 +4863,7 @@ entries: - title: Testify url: /docs/scos/dev/guidelines/testing-guidelines/testify.html - title: Testing concepts - url: /docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html + url: /docs/scos/dev/guidelines/testing-guidelines/testing-best-practices/testing-concepts.html - title: Data builders url: /docs/scos/dev/guidelines/testing-guidelines/data-builders.html - title: Testing best practices @@ -4874,7 +4874,7 @@ entries: - title: Best practices for effective testing url: /docs/scos/dev/guidelines/testing-guidelines/testing-best-practices/best-practices-for-effective-testing.html - title: Test types best practices - url: /docs/scos/dev/guidelines/testing-guidelines/testing-best-practices/test-types-best-practices.html + url: /docs/scos/dev/guidelines/testing-guidelines/testing-best-practices/test-types-best-practices.html - title: Project development guidelines url: /docs/scos/dev/guidelines/project-development-guidelines.html - title: Data processing guidelines diff --git a/_drafts/deprecated-after-pbc-migration/marketplace-infrastructure-requirements.md b/_drafts/deprecated-after-pbc-migration/marketplace-infrastructure-requirements.md index 9e76005e050..8023113bbae 100644 --- a/_drafts/deprecated-after-pbc-migration/marketplace-infrastructure-requirements.md +++ b/_drafts/deprecated-after-pbc-migration/marketplace-infrastructure-requirements.md @@ -11,7 +11,7 @@ related: --- This document describes the system infrastructure requirements that help mitigate security risks for Spryker Marketplace projects. -When you host your Spryker application in [SCCOS](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html), these requirements are configured for you out of the box. If your system infrastructure (cloud PaaS or on-premise) is managed, you must ensure these security requirements are met. +When you host your Spryker application in [SCCOS](/docs/ca/dev/getting-started-with-cloud-administration.html), these requirements are configured for you out of the box. If your system infrastructure (cloud PaaS or on-premise) is managed, you must ensure these security requirements are met. ## Applications resources visibility diff --git a/_fes-paused/dev/launching-storefronts.md b/_fes-paused/dev/launching-storefronts.md index e99541c29f0..a37940d5fba 100644 --- a/_fes-paused/dev/launching-storefronts.md +++ b/_fes-paused/dev/launching-storefronts.md @@ -69,7 +69,7 @@ For more information about Netlify build configuration, see [Get started with bu ## Connecting SCCOS -In the *Commerce provider* section, you need to connect the Storefront to a [Spryker Cloud Commerce OS (SCCOS)](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html) environment and select [locales](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) and [currencies](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html). Follow the steps below: +In the *Commerce provider* section, you need to connect the Storefront to a [Spryker Cloud Commerce OS (SCCOS)](/docs/ca/dev/getting-started-with-cloud-administration.html) environment and select [locales](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/datapayload-conversion/multi-language-setup.html) and [currencies](/docs/pbc/all/price-management/{{site.version}}/base-shop/extend-and-customize/multiple-currencies-per-store-configuration.html). Follow the steps below: 1. Select a **SPRYKER ENVIRONMENT** to connect this Storefront to. diff --git a/_includes/topnav.html b/_includes/topnav.html index 9faa371a07c..ab488eee79f 100644 --- a/_includes/topnav.html +++ b/_includes/topnav.html @@ -31,8 +31,8 @@ {% if page.product == 'sdk' and page.role == 'dev' %} Spryker SDK - {% elsif page.product == 'cloud' and page.role == 'dev' %} - Spryker Cloud Commerce OS + {% elsif page.product == 'ca' and page.role == 'dev' %} + Cloud administration {% elsif page.product == 'scos' and page.role == 'dev' %} SCOS developer guide {% elsif page.product == 'scos' and page.role == 'user' %} @@ -82,8 +82,8 @@
  • - - Spryker Cloud Commerce OS + + Cloud administration
  • diff --git a/_layouts/home.html b/_layouts/home.html index 1e7bdc1ff4d..662cb22c6c3 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -69,13 +69,13 @@

    Business User guides

    -

    Cloud Engineer guides

    +

    Cloud Admin guides

    -

    Cloud Engineer guides will help you to develop with the Spryker Cloud Commerce OS (SCCOS). After the initial setup of your SCCOS project, use the documentation as step-by-step instructions on how to go live.

    +

    Cloud Admin guides will help you to mange your cloud environments.

    diff --git a/algolia_config/_acp_user.yml b/algolia_config/_acp_user.yml index 527fb396a90..714c40a6146 100644 --- a/algolia_config/_acp_user.yml +++ b/algolia_config/_acp_user.yml @@ -9,6 +9,6 @@ algolia: - docs/scos/dev/**/*.md - docs/scu/dev/**/*.md - docs/fes/dev/**/*.md - - docs/cloud/dev/**/*.md + - docs/ca/dev/**/*.md - docs/pbc/all/**/*.md - docs/sdk/dev/**/*.md diff --git a/algolia_config/_cloud_dev.yml b/algolia_config/_ca_dev.yml similarity index 100% rename from algolia_config/_cloud_dev.yml rename to algolia_config/_ca_dev.yml diff --git a/algolia_config/_pbc_all.yml b/algolia_config/_pbc_all.yml index 738630f8cab..928953495d7 100644 --- a/algolia_config/_pbc_all.yml +++ b/algolia_config/_pbc_all.yml @@ -8,7 +8,7 @@ algolia: - docs/scos/user/**/*.md - docs/scos/dev/**/*.md - docs/scu/dev/**/*.md - - docs/cloud/dev/spryker-cloud-commerce-os/**/*.md + - docs/ca/dev/spryker-cloud-commerce-os/**/*.md - docs/fes/dev/**/*.md - docs/acp/user/**/*.md - docs/sdk/dev/**/*.md diff --git a/algolia_config/_scos_dev.yml b/algolia_config/_scos_dev.yml index 871b29c0593..75f6b83406e 100644 --- a/algolia_config/_scos_dev.yml +++ b/algolia_config/_scos_dev.yml @@ -5,7 +5,7 @@ algolia: - 404.md - 403.md - search.md - - docs/cloud/dev/**/*.md + - docs/ca/dev/**/*.md - docs/scos/user/**/*.md - docs/scu/dev/**/*.md - docs/fes/dev/**/*.md diff --git a/algolia_config/_scos_user.yml b/algolia_config/_scos_user.yml index 8bac7e37edc..16ed7d4c12f 100644 --- a/algolia_config/_scos_user.yml +++ b/algolia_config/_scos_user.yml @@ -5,7 +5,7 @@ algolia: - 404.md - 403.md - search.md - - docs/cloud/dev/**/*.md + - docs/ca/dev/**/*.md - docs/scos/dev/**/*.md - docs/scu/dev/**/*.md - docs/fes/dev/**/*.md diff --git a/algolia_config/_scu_dev.yml b/algolia_config/_scu_dev.yml index 90540910384..dad552afc3f 100644 --- a/algolia_config/_scu_dev.yml +++ b/algolia_config/_scu_dev.yml @@ -8,7 +8,7 @@ algolia: - docs/scos/user/**/*.md - docs/scos/dev/**/*.md - docs/pbc/all/**/*.md - - docs/cloud/dev/spryker-cloud-commerce-os/**/*.md + - docs/ca/dev/spryker-cloud-commerce-os/**/*.md - docs/fes/dev/**/*.md - docs/acp/user/**/*.md - docs/sdk/dev/**/*.md diff --git a/algolia_config/_sdk_dev.yml b/algolia_config/_sdk_dev.yml index 9910b59a217..7a3cd224042 100644 --- a/algolia_config/_sdk_dev.yml +++ b/algolia_config/_sdk_dev.yml @@ -8,7 +8,7 @@ algolia: - docs/scos/user/**/*.md - docs/scos/dev/**/*.md - docs/scu/dev/**/*.md - - docs/cloud/dev/spryker-cloud-commerce-os/**/*.md + - docs/ca/dev/spryker-cloud-commerce-os/**/*.md - docs/acp/user/**/*.md - docs/fes/dev/**/*.md - docs/pbc/all/**/*.md diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.md b/docs/ca/dev/access/access-the-aws-management-console.md similarity index 88% rename from docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.md rename to docs/ca/dev/access/access-the-aws-management-console.md index 309f014c8d5..15f96d78daf 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.md +++ b/docs/ca/dev/access/access-the-aws-management-console.md @@ -1,5 +1,5 @@ --- -title: Accessing AWS Management Console +title: Access the AWS Management Console description: Access AWS Management Console via the IAM accounts created during the initial setup. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/accessing-aws-management-console @@ -7,6 +7,7 @@ originalArticleId: 86ea35c7-3324-4e7b-9579-447eedfe9def redirect_from: - /docs/accessing-aws-management-console - /docs/en/accessing-aws-management-console + - /docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.html --- This document describes how to access AWS Management Console as an [Identity and Access Management (IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html) user. @@ -32,4 +33,4 @@ The sign-in page opens with the **Account ID (12 digits) or account alias** fiel This takes you to the AWS Management Console. ## Next step -[Connecting the Docker SDK](/docs/cloud/dev/spryker-cloud-commerce-os/connecting-the-docker-sdk.html) +[Connecting the Docker SDK](/docs/ca/dev/connecting-the-docker-sdk.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/access/access.md b/docs/ca/dev/access/access.md similarity index 54% rename from docs/cloud/dev/spryker-cloud-commerce-os/access/access.md rename to docs/ca/dev/access/access.md index c2b458e6b52..e382d6947a8 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/access/access.md +++ b/docs/ca/dev/access/access.md @@ -3,10 +3,12 @@ title: Access last_updated: Jan 16, 2023 description: Describes how to access AWS Management Console, locate credentials for Spryker Cloud Commerce OS services, and connect to services template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/access/access.html --- This section describes how to access AWS Management Console as an Identity and Access Management (IAM) user, locate the credentials for Spryker Cloud Commerce OS services, and connect to services: -* [Accessing AWS Management Console](/docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.html) -* [Locating service credentials](/docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.html) -* [Connecting to services via SSH](/docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.html) +* [Accessing AWS Management Console](/docs/ca/dev/access/access-the-aws-management-console.html) +* [Locating service credentials](/docs/ca/dev/access/locate-service-credentials.html) +* [Connecting to services via SSH](/docs/ca/dev/access/connect-to-services-via-ssh.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.md b/docs/ca/dev/access/connect-to-services-via-ssh.md similarity index 95% rename from docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.md rename to docs/ca/dev/access/connect-to-services-via-ssh.md index 7ac86658cf7..00a159c864f 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.md +++ b/docs/ca/dev/access/connect-to-services-via-ssh.md @@ -1,5 +1,5 @@ --- -title: Connecting to services via SSH +title: Connect to services via SSH description: Access Spryker Cloud services via SSH. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/connecting-to-services-via-ssh @@ -7,6 +7,7 @@ originalArticleId: 914d013d-5ef3-4c0f-b940-ce8add5531c8 redirect_from: - /docs/connecting-to-services-via-ssh - /docs/en/connecting-to-services-via-ssh + - /docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.html --- We add your SSH public key to the [bastion host](https://docs.aws.amazon.com/quickstart/latest/linux-bastion/overview.html) during the onboarding, so you can access your environments' internal networks via SSH right after. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.md b/docs/ca/dev/access/locate-service-credentials.md similarity index 85% rename from docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.md rename to docs/ca/dev/access/locate-service-credentials.md index 08a5a1f2cc5..6ddf67826a9 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.md +++ b/docs/ca/dev/access/locate-service-credentials.md @@ -1,5 +1,5 @@ --- -title: Locating service credentials +title: Locate service credentials description: To connect to Spryker Cloud services, locate the credentials in the AWS Management Console. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/locating-service-credentials @@ -7,6 +7,7 @@ originalArticleId: 8db85787-ad90-4c6f-94e9-ab82bf94703c redirect_from: - /docs/locating-service-credentials - /docs/en/locating-service-credentials + - /docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.html --- This document describes how to locate the credentials for Spryker Cloud Commerce OS services. @@ -15,13 +16,13 @@ You can find the credentials for services in the environment variables for the Z {% info_block infoBox "Environment" %} -We use *spryker-staging* environment as an example. Follow the procedure in the desired environment. +We use *spryker-staging* environment as an example. Follow the procedure in the desired environment. {% endinfo_block %} 1. In the AWS Management Console, go to **Services** > **Elastic Container Service** > **[Clusters](https://us-east-1.console.aws.amazon.com/eks/home#/clusters)**. -2. Select *spryker-staging*. +2. Select *spryker-staging*. 3. Select *spryker-zed*. 4. Select the value of *Task definition*. @@ -32,10 +33,9 @@ We use *spryker-staging* environment as an example. Follow the procedure in the ![arrow on the screen](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Access/Locating+service+credentials/arrow+on+the+scren.png) -The credentials are located in the *Environment Variables* section. +The credentials are located in the *Environment Variables* section. ![environment variables](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Access/Locating+service+credentials/environment+variables.png) ## Next step -* [Connecting to services via SSH](/docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.html) - +* [Connecting to services via SSH](/docs/ca/dev/access/connect-to-services-via-ssh.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.md b/docs/ca/dev/add-variables-in-the-parameter-store.md similarity index 99% rename from docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.md rename to docs/ca/dev/add-variables-in-the-parameter-store.md index c23a673d27b..b3cb2890317 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.md +++ b/docs/ca/dev/add-variables-in-the-parameter-store.md @@ -8,6 +8,7 @@ redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/managing-parameters-in-the-parameter-store.html - /docs/cloud/dev/spryker-cloud-commerce-os/define-parameter-and-secret-values-in-sccos-environments.html - /docs/cloud/dev/spryker-cloud-commerce-os/add-variables.html + - /docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html --- diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md b/docs/ca/dev/best-practices/best-practices.md similarity index 73% rename from docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md rename to docs/ca/dev/best-practices/best-practices.md index b0c91f3ad83..29f3307837d 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.md +++ b/docs/ca/dev/best-practices/best-practices.md @@ -2,6 +2,8 @@ title: Best practices description: Best practices for developers working on Spryker Cloud Commerce OS template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practices.html last_updated: Jun, 10, 2023 --- diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md b/docs/ca/dev/best-practices/best-practises-jenkins-stability.md similarity index 93% rename from docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md rename to docs/ca/dev/best-practices/best-practises-jenkins-stability.md index 6ada0de6915..5330f1d574b 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.md +++ b/docs/ca/dev/best-practices/best-practises-jenkins-stability.md @@ -1,8 +1,10 @@ --- - title: "Best practises: Jenkins stability" - description: Improve the stability of the scheduler component. - template: best-practices-guide-template - last_updated: Jun 10, 2023 +title: "Best practises: Jenkins stability" +description: Improve the stability of the scheduler component. +template: best-practices-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html +last_updated: Jun 10, 2023 --- Jenkins fulfills the role of a scheduler in the Spryker applications. It is used to run repetitive console commands and jobs. In Spryker Cloud Commerce OS, the Jenkins instance runs the commands configured directly in its container. This means that, when you run a command like the following one, it's executed within the Jenkins container, utilizing its resources: @@ -27,4 +29,4 @@ We recommend sticking to the default executor count or the concurrent job limit ## Queue worker configuration -If you have configured multiple queue workers per queue, keep in mind that the comments made above regarding memory management also apply in this scenario. Each configured queue worker can consume up to PHP's max_memory, causing a significant increase in total memory demand as they are spawned. Another crucial factor to take into consideration is CPU utilization. If you have configured more workers than the number of available cores, it becomes increasingly likely that processes will need to wait for CPU resources. This can ultimately lead to suboptimal performance and potentially even stability issues. We recommend avoiding resource contention of this nature by adjusting the number of workers in a manner that aligns with your environment package. Our service description specifies the number of CPU cores available to you in each package. \ No newline at end of file +If you have configured multiple queue workers per queue, keep in mind that the comments made above regarding memory management also apply in this scenario. Each configured queue worker can consume up to PHP's max_memory, causing a significant increase in total memory demand as they are spawned. Another crucial factor to take into consideration is CPU utilization. If you have configured more workers than the number of available cores, it becomes increasingly likely that processes will need to wait for CPU resources. This can ultimately lead to suboptimal performance and potentially even stability issues. We recommend avoiding resource contention of this nature by adjusting the number of workers in a manner that aligns with your environment package. Our service description specifies the number of CPU cores available to you in each package. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configuring-data-import-from-an-s3-bucket.md b/docs/ca/dev/configure-data-import-from-an-s3-bucket.md similarity index 99% rename from docs/cloud/dev/spryker-cloud-commerce-os/configuring-data-import-from-an-s3-bucket.md rename to docs/ca/dev/configure-data-import-from-an-s3-bucket.md index 62ecb35dc65..c5264245463 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configuring-data-import-from-an-s3-bucket.md +++ b/docs/ca/dev/configure-data-import-from-an-s3-bucket.md @@ -1,7 +1,9 @@ --- -title: Configuring data import from an S3 bucket via Flysystem +title: Configure data import from an S3 bucket via Flysystem description: Learn how to import data via an S3 bucket. template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-data-import-from-an-s3-bucket.html --- Unlike a local environment, a cloud one cannot hold the data you want to import for any determined amount of time. That’s why you need to store the data in persistent storage, like an S3 bucket, and configure your Spryker environment to access and use the import data there. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configuring-debugging.md b/docs/ca/dev/configure-debugging.md similarity index 70% rename from docs/cloud/dev/spryker-cloud-commerce-os/configuring-debugging.md rename to docs/ca/dev/configure-debugging.md index 5280ee931bf..e7a513ff659 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configuring-debugging.md +++ b/docs/ca/dev/configure-debugging.md @@ -1,5 +1,5 @@ --- -title: Configuring debugging +title: Configure debugging description: Enable extended logs for an application to debug it. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/debugging @@ -8,12 +8,13 @@ redirect_from: - /docs/debugging - /docs/en/debugging - /docs/cloud/dev/spryker-cloud-commerce-os/debugging + - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-debugging.html --- {% info_block warningBox "Security" %} Once debugging is completed, turn off debugging mode. Leaving it permanently enabled can lead to the disclosure of sensitive information. - + {% endinfo_block %} Currently, Xdebug is not supported, but you can enable extended logs in the deploy file to debug an application. Extended logs provide extra information about application state and behavior. @@ -35,10 +36,10 @@ $config[LogConstants::LOG_LEVEL] = getenv('SPRYKER_DEBUG_ENABLED') ? Logger::INF ``` 3. Commit the changes and deploy the application in the desired environment: - * [Deploy in the production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) - * [Deploy in the staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) + * [Deploy in the production environment](/docs/ca/dev/deploy-in-a-production-environment.html) + * [Deploy in the staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) -Extended logs are enabled and you can check them in the AWS Management Console. See [Working with logs](/docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.html) for more details. +Extended logs are enabled and you can check them in the AWS Management Console. See [Working with logs](/docs/ca/dev/working-with-logs.html) for more details. ## Next step -[Working with logs](/docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.html) +[Working with logs](/docs/ca/dev/working-with-logs.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.md b/docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.md rename to docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.md index e5792eb0e84..ccffd645127 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.md +++ b/docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.md @@ -1,5 +1,5 @@ --- -title: Configuring Azure Pipelines +title: Configure Azure Pipelines description: Learn how to configure Azure Pipelines and connect them to your project. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/configuring-azure-pipelines @@ -7,11 +7,12 @@ originalArticleId: df3448d4-34a8-43a8-bc58-f37ea8b6cd8d redirect_from: - /docs/configuring-azure-pipelines - /docs/en/configuring-azure-pipelines + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.html --- This document describes how to configure Azure pipelines and connect them to your Spryker Commerce OS project. -Azure Pipelines automatically builds and tests code projects to make them available to others. It works with just about any language or project type. Azure Pipelines combines continuous integration (CI) and continuous delivery (CD) to constantly and consistently test and build your code and ship it to any target. +Azure Pipelines automatically builds and tests code projects to make them available to others. It works with just about any language or project type. Azure Pipelines combines continuous integration (CI) and continuous delivery (CD) to constantly and consistently test and build your code and ship it to any target. The main building blocks of azure pipelines are stages, jobs, and steps. To learn more, see [Azure Pipelines documentation](https://docs.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops). @@ -26,7 +27,7 @@ Adjust the following example or use it as a reference to configure the desired g ```yaml pool: vmImage: ubuntu-18.04 - + steps: - script: git clone https://github.com/spryker/docker-sdk.git docker @@ -65,13 +66,13 @@ steps: docker/sdk testing codecept run -c codeception.functional.yml displayName: 'Functional tests' ``` - + ## Connecting Azure Pipelines to your project To connect Azure Pipelines with your AWS repository: 1. Request your AWS repository URL and credentials from [support](https://spryker.force.com/support/s/). -2. Add the following to the end of `azure-pipelines.yml`: +2. Add the following to the end of `azure-pipelines.yml`: ```yaml ... - script: | @@ -92,21 +93,6 @@ Values to replace: `{target-repo.username}` and `{target-repo.password}`: credentials you’ve received from support. - - -You’ve configured Azure pipelines. - - - - - - - - - - - - - +You’ve configured Azure pipelines. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.md b/docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.md rename to docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.md index 728221b0044..45e3dc6679f 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.md +++ b/docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.md @@ -1,5 +1,5 @@ --- -title: Configuring Bitbucket Pipelines +title: Configure Bitbucket Pipelines description: Learn how to configure continuous integration for Spryker Cloud Commerce OS with GitHub Actions. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/configuring-bitbucket-pipelines @@ -7,14 +7,15 @@ originalArticleId: f100164f-976a-4ce5-b713-7c58335f9965 redirect_from: - /docs/configuring-bitbucket-pipelines - /docs/en/configuring-bitbucket-pipelines + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.html --- This document describes how to configure continuous integration using Bitbucket Pipelines. ## Bitbucket Pipelines -Bitbucket Pipelines is an integrated CI/CD service, built into Bitbucket. It allows you to automatically build, test, and deploy your code, based on a configuration file in your repository. +Bitbucket Pipelines is an integrated CI/CD service, built into Bitbucket. It allows you to automatically build, test, and deploy your code, based on a configuration file in your repository. -For more information on Bitbucket Pipelines, see [Get started with Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/). +For more information on Bitbucket Pipelines, see [Get started with Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/). ## Prerequisites 1. In the repository root, create the CI/CD configuration file: `bitbucket-pipelines.yml`. @@ -66,21 +67,21 @@ pipelines: - vendor/bin/phpmd src/ text vendor/spryker/architecture-sniffer/src/ruleset.xml --minimumpriority 2 - node ./frontend/libs/stylelint - node ./frontend/libs/tslint stylish - services: + services: - mysql - redis - elasticsearch - broker -definitions: +definitions: services: - mysql: + mysql: image: mariadb:10.3 - variables: + variables: MYSQL_USER: $MYSQL_USER MYSQL_PASSWORD: $MYSQL_PASSWORD MYSQL_ROOT_PASSWORD: $MYSQL_ROOT_PASSWORD - MYSQL_DATABASE: $MYSQL_DATABASE + MYSQL_DATABASE: $MYSQL_DATABASE redis: image: redis:5.0-alpine elasticsearch: @@ -112,7 +113,7 @@ Docker SDK tests will be supported after Bitbucket starts supporting [Docker Bui To set up a job that runs a specific group of tests: -1. To `bitbucket-pipelines.yml`, add the following configuration template: +1. To `bitbucket-pipelines.yml`, add the following configuration template: ```yaml ... - step: @@ -138,18 +139,7 @@ To set up a job that runs a specific group of tests: ``` 2. Replace the placeholders with the actual values using the following description. -|PLACEHOLDER | DESCRIPTION | EXAMPLE IN THE PROPERTY VALUE | +|PLACEHOLDER | DESCRIPTION | EXAMPLE IN THE PROPERTY VALUE | |---|---|---| |{image_tag} | Tag of the Docker image on which the validation is based. Check all the images in the [Spryker Docker hub](https://hub.docker.com/r/spryker/php/tags?page=1&ordering=last_updated&name=-debian). | 7.4 | |{tests_configuration_file} | Codeception configuration files that defines the tests to run. Example: codeception.ci.functional.yml | codeception.functional.yml| - - - - - - - - - - - diff --git a/docs/ca/dev/configure-deployment-pipelines/configure-deployment-pipelines.md b/docs/ca/dev/configure-deployment-pipelines/configure-deployment-pipelines.md new file mode 100644 index 00000000000..58fe76afea7 --- /dev/null +++ b/docs/ca/dev/configure-deployment-pipelines/configure-deployment-pipelines.md @@ -0,0 +1,18 @@ +--- +title: Configure deployment pipelines +last_updated: Jan 16, 2023 +description: Explains how to customize and configure deployment pipelines in Spryker Cloud Commerce OS (SCCOS) +template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configure-deployment-pipelines.html +--- + +This section explains how to customize and configure deployment pipelines in Spryker Cloud Commerce OS (SCCOS): + +* [Deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html) +* [Deployment in states](/docs/ca/dev/configure-deployment-pipelines/deployment-in-states.html) +* [Customizing deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html) +* [Configuring Azure Pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.html) +* [Configuring GitHub Actions](/docs/ca/dev/configure-deployment-pipelines/configure-github-actions.html) +* [Configuring GitLab pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.html) +* [Configuring Bitbucket Pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.md b/docs/ca/dev/configure-deployment-pipelines/configure-github-actions.md similarity index 99% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.md rename to docs/ca/dev/configure-deployment-pipelines/configure-github-actions.md index 4f4806fba50..c5b5fb73546 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.md +++ b/docs/ca/dev/configure-deployment-pipelines/configure-github-actions.md @@ -10,6 +10,7 @@ redirect_from: - /docs/en/configuring-github-actions - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-deployment-pipelines/configuring-github-actions.html - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-deployment-pipelines/upcoming-release/configuring-github-actions.html + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.html --- This document describes how to configure continuous integration using GitHub Actions. @@ -1071,7 +1072,7 @@ To set up a job that runs a specific group of tests via the [Docker SDK](/docs/s 4. Repeat steps 1 to 3 until you add all the desired jobs. -For different configuration examples, see Configuring groups of tests via the [Configuring groups of tests via the Docker SDK: Configuration examples](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.html#configuring-groups-of-tests-via-the-docker-sdk). +For different configuration examples, see Configuring groups of tests via the [Configuring groups of tests via the Docker SDK: Configuration examples](/docs/ca/dev/configure-deployment-pipelines/configure-github-actions.html#configuring-groups-of-tests-via-the-docker-sdk). ### Configuring groups of tests via the Docker SDK: Configuration examples diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.md b/docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.md similarity index 97% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.md rename to docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.md index 71b243fb275..e85eadde60d 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.md +++ b/docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.md @@ -8,6 +8,7 @@ redirect_from: - /docs/configuring-gitlab-pipelines - /docs/en/configuring-gitlab-pipelines - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-deployment-pipelines/configuring-gitlab-pipelines.html + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.html --- This document describes how to configure continuous integration using GitLab Pipelines. @@ -18,7 +19,7 @@ GitLab pipelines automate steps in the SDLC like builds, tests, and deployments. For more information on Gitlab Pipelines, see [GitLab CI/CD](https://docs.gitlab.com/ee/ci/README.html). ## Prerequisites -In the repository root, create the CI/CD configuration file: `.gitlab-ci.yml`. +In the repository root, create the CI/CD configuration file: `.gitlab-ci.yml`. ## Configuring groups of tests via the Docker SDK To configure GitLab pipelines: @@ -163,4 +164,3 @@ functional-tests: ## See also For more configuration options of GitLab pipelines, see [The .gitlab-ci.yml file](https://docs.gitlab.com/ee/ci/yaml/gitlab_ci_yaml.html). - diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.md b/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.md similarity index 89% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.md rename to docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.md index 6100910443f..92f8640a2e9 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.md +++ b/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.md @@ -1,5 +1,5 @@ --- -title: Customizing deployment pipelines +title: Customize deployment pipelines description: Learn how to customize deployment pipelines. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/customizing-deployment-pipelines @@ -8,16 +8,17 @@ redirect_from: - /docs/customizing-deployment-pipelines - /docs/en/customizing-deployment-pipelines - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-deployment-pipelines/customizing-deployment-pipelines.html + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html --- This document describes how to customize deployment pipelines. {% info_block warningBox %} -* To prevent timeouts and issues, avoid adding long operations like data import to deployment pipelines. Export long operations to Jenkins jobs that run separately from deployment. To learn how long operations affect pipelines, see [Deploymment in states](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.html). +* To prevent timeouts and issues, avoid adding long operations like data import to deployment pipelines. Export long operations to Jenkins jobs that run separately from deployment. To learn how long operations affect pipelines, see [Deploymment in states](/docs/ca/dev/configure-deployment-pipelines/deployment-in-states.html). -* In this document, we use the `pre-deploy` stage and its environment variable `SPRYKER_HOOK_BEFORE_DEPLOY` as an example. When customizing a different stage of a pipeline, use the respective variable. You can learn about environment variables for each deployment stage in [Deployment stages](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html#deployment-stages). +* In this document, we use the `pre-deploy` stage and its environment variable `SPRYKER_HOOK_BEFORE_DEPLOY` as an example. When customizing a different stage of a pipeline, use the respective variable. You can learn about environment variables for each deployment stage in [Deployment stages](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html#deployment-stages). * Also, we use the default location of deployment scripts: `/config/install/`. Before you edit or add new scripts, make sure to check where they are stored in your project. @@ -29,7 +30,7 @@ This document describes how to customize deployment pipelines. To customize the `pre-deploy` stage of a pipeline: 1. In a deploy file of the desired environment, set the shell command as a value of the `SPRYKER_HOOK_BEFORE_DEPLOY:` variable: - + ```yaml environment: ... image: @@ -83,11 +84,11 @@ if [ "${SPRYKER_PROJECT_NAME}" == "spryker-dev" ]; then {list_of_commands} fi -if [ "${SPRYKER_PIPELINE_TYPE}" == "normal" ]; then +if [ "${SPRYKER_PIPELINE_TYPE}" == "normal" ]; then {list_of_commands} fi -if [ "${SPRYKER_PIPELINE_TYPE}" == "destructive" ]; then +if [ "${SPRYKER_PIPELINE_TYPE}" == "destructive" ]; then {list_of_commands} fi ``` @@ -97,13 +98,12 @@ fi To add one or more commands to the `install` stage of a deployment pipeline: 1. Depending on the desired environment, add the desired commands to one of the following files: - + * Normal: `config/install/production` - + * Destructive: `config/install/destructive` - + 2. Push the changes to the repository. - -During the next deployment, the commands in the script will be executed in the `install` stage. +During the next deployment, the commands in the script will be executed in the `install` stage. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.md b/docs/ca/dev/configure-deployment-pipelines/deployment-in-states.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.md rename to docs/ca/dev/configure-deployment-pipelines/deployment-in-states.md index 785ee0334e7..0e1e7255cd7 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.md +++ b/docs/ca/dev/configure-deployment-pipelines/deployment-in-states.md @@ -8,6 +8,7 @@ redirect_from: - /docs/deployment-pipelines - /docs/en/deployment-pipelines - /docs/cloud/dev/spryker-cloud-commerce-os/deployment-pipelines/deployment-pipelines.html + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.html --- When it comes to complex applications, deploying to production environments is not just going from version one to version two. This document describes the states that an application goes through during a deployment, potential issues, and what you need to do to avoid them. @@ -21,7 +22,7 @@ The described issues are directly related to how changes are introduced in a pro ## Pipelines in SCCOS -To learn how pipelines work in Spryker Cloud Commerce OS, see [Deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html). +To learn how pipelines work in Spryker Cloud Commerce OS, see [Deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html). ## Production pipeline steps @@ -140,4 +141,4 @@ Another powerful technique we recommend is feature flags. They let you enable up ## Next steps -* [Deploying in a staging environemnt](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) +* [Deploying in a staging environemnt](/docs/ca/dev/deploy-in-a-staging-environment.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.md b/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.md similarity index 98% rename from docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.md rename to docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.md index d5d8b7ab455..e62fff1869e 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.md +++ b/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.md @@ -9,6 +9,7 @@ redirect_from: - /docs/en/deployment-pipelines - /docs/cloud/dev/spryker-cloud-commerce-os/deployment-pipelines/deployment-pipelines.html - /docs/cloud/dev/spryker-cloud-commerce-os/configuring-deployment-pipelines/deployment-pipelines.html + - /docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html --- {% info_block infoBox "Data Import during Deployments" %} @@ -158,7 +159,7 @@ Schematically, deployment in Spryker Cloud Commerce OS looks as follows.
    Deployment flow diagram - +
    @@ -168,4 +169,4 @@ Schematically, deployment in Spryker Cloud Commerce OS looks as follows. ## Next steps -* [Deployment in states](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.html) +* [Deployment in states](/docs/ca/dev/configure-deployment-pipelines/deployment-in-states.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.md b/docs/ca/dev/connect-a-code-repository.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.md rename to docs/ca/dev/connect-a-code-repository.md index 00dd83e420e..3b562749cdb 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.md +++ b/docs/ca/dev/connect-a-code-repository.md @@ -1,5 +1,5 @@ --- -title: Connecting a code repository +title: Connect a code repository description: Connect a GitHub or Bitbucket code repository to your Spryker Cloud project. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/connecting-code-repository @@ -8,13 +8,14 @@ redirect_from: - /docs/connecting-code-repository - /docs/en/connecting-code-repository - /docs/cloud/dev/spryker-cloud-commerce-os/connecting-code-repository + - /docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.html --- This document describes how to connect a code repository to Spryker Cloud Commerce OS. {% info_block infoBox "Initial setup" %} -If you specified a code repository in the Onboarding Questionnaire, we connected it to your Staging environment during the initial setup. To connect a code repository to another environment, follow this document. +If you specified a code repository in the Onboarding Questionnaire, we connected it to your Staging environment during the initial setup. To connect a code repository to another environment, follow this document. Note that we are only supporting the Cloud variants of the repositories listed below. To connect the On-Premises repository, check the documentation of your git repository provider about mirroring the repository to one of the following providers. @@ -158,4 +159,4 @@ Allow the synchronization several minutes to complete and you should see the rec ## Next step -[Deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html) +[Deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/connecting-the-docker-sdk.md b/docs/ca/dev/connecting-the-docker-sdk.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/connecting-the-docker-sdk.md rename to docs/ca/dev/connecting-the-docker-sdk.md index 27799a962a2..470a2a23cfa 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/connecting-the-docker-sdk.md +++ b/docs/ca/dev/connecting-the-docker-sdk.md @@ -9,6 +9,7 @@ redirect_from: - /docs/connecting-docker-sdk - /docs/en/connecting-docker-sdk - /docs/cloud/dev/spryker-cloud-commerce-os/connecting-docker-sdk + - /docs/cloud/dev/spryker-cloud-commerce-os/connecting-the-docker-sdk.html --- Spryker Docker SDK is a tool used to set up docker environments for Spryker projects. @@ -30,6 +31,7 @@ Spryker Cloud Commerce OS does not support forks of the Docker SDK. Your project ## Connect Docker SDK + To connect Docker SDK to your project, follow the instructions in [Integrating the Docker SDK into existing projects](/docs/scos/dev/set-up-spryker-locally/set-up-spryker-locally.html). {% info_block errorBox "Deploy file" %} @@ -46,4 +48,4 @@ If you want to start a new project from scratch, follow [Installing Spryker with ## Next step -[Connecting a code repository](/docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.html) +[Connecting a code repository](/docs/ca/dev/connect-a-code-repository.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/create-and-restore-database-backups.md b/docs/ca/dev/create-and-restore-database-backups.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/create-and-restore-database-backups.md rename to docs/ca/dev/create-and-restore-database-backups.md index a9be4f9bbca..80e805b95ae 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/create-and-restore-database-backups.md +++ b/docs/ca/dev/create-and-restore-database-backups.md @@ -9,6 +9,7 @@ redirect_from: - /docs/creating-and-restoring-database-backups - /docs/en/creating-and-restoring-database-backups - /docs/cloud/dev/spryker-cloud-commerce-os/creating-and-restoring-database-backups.html + - /docs/cloud/dev/spryker-cloud-commerce-os/create-and-restore-database-backups.html --- This doc describes how to create and restore database (DB) backups in Spryker Cloud Commerce OS (SCCOS). @@ -228,9 +229,9 @@ You've restored the database and connected it ot your application. ## Restore an application -Application restoration is part of a regular deployment workflow. See [Rolling back an application](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html#roll-back-an-application) to learn about restoring a previous version of an application. +Application restoration is part of a regular deployment workflow. See [Rolling back an application](/docs/ca/dev/deploy-in-a-staging-environment.html#roll-back-an-application) to learn about restoring a previous version of an application. ## Next step -* [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) +* [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.md b/docs/ca/dev/deploy-in-a-production-environment.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.md rename to docs/ca/dev/deploy-in-a-production-environment.md index aa1bbf232f5..3c8366fb0fe 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.md +++ b/docs/ca/dev/deploy-in-a-production-environment.md @@ -1,5 +1,5 @@ --- -title: Deploying in a production environment +title: Deploy in a production environment description: Deploy an application in a production environment in the AWS Management Console. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/deploying-in-a-production-environment @@ -7,9 +7,10 @@ originalArticleId: 71dae250-39b8-4adc-a57d-ba9376587f7c redirect_from: - /docs/deploying-in-a-production-environment - /docs/en/deploying-in-a-production-environment + - /docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html --- -This document describes how to deploy an application to [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) in a [production environment](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html#production-prod). +This document describes how to deploy an application to [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) in a [production environment](/docs/ca/dev/environments-overview.html#production-prod). ## Prerequisites @@ -27,12 +28,12 @@ Example of the ECR images with the application version in tags: * `spryker-prod-frontend:290b955bd06d029c8643c093b58a0cedb86b1c8d` * `spryker-prod-jenkins:290b955bd06d029c8643c093b58a0cedb86b1c8d` - + ## 1. Check the version to deploy -To deploy a specific application version, copy the version of the respective GitHub commit: +To deploy a specific application version, copy the version of the respective GitHub commit: ![version to deploy](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Deploying+in+a+production+environment/version-to-deploy.png) @@ -43,13 +44,13 @@ To deploy a specific application version, copy the version of the respective Git ## 2. Define the version to deploy To define the application version to deploy: -1. In the AWS Management Console, go to **Services** > **Systems Manager** > **Application Management** > **[Parameter Store](https://eu-central-1.console.aws.amazon.com/systems-manager/parameters/)**. +1. In the AWS Management Console, go to **Services** > **Systems Manager** > **Application Management** > **[Parameter Store](https://eu-central-1.console.aws.amazon.com/systems-manager/parameters/)**. 2. Select */spryker-prod/desired_version*. -3. Select **Edit**. +3. Select **Edit**. -4. Enter the application version into the **Value** field. +4. Enter the application version into the **Value** field. 5. Select **Save changes**. @@ -59,12 +60,12 @@ To run a pipeline: 1. In the AWS Management Console, go to **Services** > **[CodePipeline](https://eu-central-1.console.aws.amazon.com/codesuite/codepipeline/pipelines)**. -2. Select *NORMAL_Deploy_Spryker_spryker-prod*. +2. Select *NORMAL_Deploy_Spryker_spryker-prod*. {% info_block infoBox "Normal deploy" %} -*Normal deploy* is a pipeline that includes all the stages of a complete CI/CD flow. The *Install* stage of this pipeline does not perform any dangerous data manipulations like database cleanup or scheduler reset. We recommend this type of deploy for the production environment. +*Normal deploy* is a pipeline that includes all the stages of a complete CI/CD flow. The *Install* stage of this pipeline does not perform any dangerous data manipulations like database cleanup or scheduler reset. We recommend this type of deploy for the production environment. {% endinfo_block %} @@ -72,7 +73,7 @@ To run a pipeline: 1. In the *Prepare_versions_information_for_Approval_stage* stage, select **Details**. - + ![compare application versions](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Deploying+in+a+production+environment/compare-application-versions.png) @@ -82,7 +83,7 @@ To run a pipeline: 3. Check `Deploymnet version` and `Latest deployed version` in the output. - + ![deployment-versions-logs](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Deploying+in+a+production+environment/deployment-versions-logs-prod.png) @@ -119,7 +120,7 @@ To check the deployed application version in the [ECS cluster](https://docs.aws. ![select task](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Deploying+in+a+production+environment/select-task-prod.png) -7. In the *Image* column of the *Containers* section, ensure that the image name of the container contains the correct application version. +7. In the *Image* column of the *Containers* section, ensure that the image name of the container contains the correct application version. ![check image task](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Deploying+in+a+production+environment/check-image-task-prod.png) @@ -128,36 +129,7 @@ To roll back an application: 1. Find out the application version you want to roll back to. See [1. Check the version to deploy](#check-the-version-to-deploy) for more details. -2. In [Parameter Store](https://eu-central-1.console.aws.amazon.com/systems-manager/parameters/), set the application version as the value of the */spryker-staging/desired_version* parameter. See [2. Define the version to deploy](#define-the-version-to-deploy) for more details. +2. In [Parameter Store](https://eu-central-1.console.aws.amazon.com/systems-manager/parameters/), set the application version as the value of the */spryker-staging/desired_version* parameter. See [2. Define the version to deploy](#define-the-version-to-deploy) for more details. 3. Run a deployment pipeline as described in [3. Run a deployment pipeline](#run-a-deployment-pipeline). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.md b/docs/ca/dev/deploy-in-a-staging-environment.md similarity index 95% rename from docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.md rename to docs/ca/dev/deploy-in-a-staging-environment.md index f2b7f15c716..9e43fd73077 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.md +++ b/docs/ca/dev/deploy-in-a-staging-environment.md @@ -1,5 +1,5 @@ --- -title: Deploying in a staging environment +title: Deploy in a staging environment description: Deploy an application in a staging environment. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/deploying-in-a-staging-environment @@ -7,9 +7,10 @@ originalArticleId: 9a152894-26bd-488f-8dfa-a8e645063c51 redirect_from: - /docs/deploying-in-a-staging-environment - /docs/en/deploying-in-a-staging-environment + - /docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html --- -This document describes how to deploy an application to [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) in a [staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html#staging-stage). +This document describes how to deploy an application to [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) in a [staging environment](/docs/ca/dev/environments-overview.html#staging-stage). ## Prerequisites @@ -145,4 +146,4 @@ To roll back an application: ## Next step -[Configuring debugging](/docs/cloud/dev/spryker-cloud-commerce-os/configuring-debugging.html) +[Configuring debugging](/docs/ca/dev/configure-debugging.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.md b/docs/ca/dev/environment-provisioning.md similarity index 91% rename from docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.md rename to docs/ca/dev/environment-provisioning.md index 2e5e4d5a2d6..b9b3e4160f4 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.md +++ b/docs/ca/dev/environment-provisioning.md @@ -3,10 +3,11 @@ title: Environment provisioning description: This document explains core concepts that are important to understand before filing an environment provisioning request. last_updated: Mar 14, 2023 template: concept-topic-template - +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.html --- -Before proceeding with the provisioning of your Spryker PaaS environment, we would like to clarify the information we require from you. To initiate the environment provisioning process, you need to create a case using your support portal access. If you have questions, visit the [Spryker Support Portal](https://support.spryker.com). If you don't have access to the support portal yet, request it through the [request form](https://www.surveymonkey.com/r/XYK5R26) on SurveyMonkey. +Before proceeding with the provisioning of your Spryker PaaS environment, we would like to clarify the information we require from you. To initiate the environment provisioning process, you need to create a case using your support portal access. If you have questions, visit the [Spryker Support Portal](https://support.spryker.com). If you don't have access to the support portal yet, request it through the [request form](https://www.surveymonkey.com/r/XYK5R26) on SurveyMonkey. Once you are logged in to the Spryker Support Portal, you can submit the [environment provisioning request](https://support.spryker.com/s/hosting-change-requests/change-request-new-environment). {% info_block warningBox %} @@ -15,7 +16,7 @@ This process can only be initiated through a customer account. To request an env {% endinfo_block %} -The following sections outline the information you need to provide to initiate provisioning of your environment. +The following sections outline the information you need to provide to initiate provisioning of your environment. {% info_block warningBox "Mandatory information" %} @@ -46,7 +47,7 @@ The *project name* is the name of the customer or the customer's preferred name ### Environment type -The *[environment type](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html)* corresponds to the popular naming convention for environment tiers in software development. You can refer to your contract for information on what environments you are entitled to and choose the respective one—for example: +The *[environment type](/docs/ca/dev/environments-overview.html)* corresponds to the popular naming convention for environment tiers in software development. You can refer to your contract for information on what environments you are entitled to and choose the respective one—for example: Lower environments: STAGE, DEV @@ -58,7 +59,7 @@ If `myshop` is the customer, then `myshop-PROD` is an environment name, where `m ### AWS region -The *AWS region* indicates where customers want their infrastructure resources to be available. For more information about available options for the AWS region, refer to the AWS [official documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For information about the AWS region you are entitled to use, check your contract. +The *AWS region* indicates where customers want their infrastructure resources to be available. For more information about available options for the AWS region, refer to the AWS [official documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For information about the AWS region you are entitled to use, check your contract. The following AWS regions are supported: - Asia Pacific (Tokyo) @@ -86,7 +87,7 @@ This section explains the aspects of the code base and boilerplate you use and i ### Code base -Which code base is being used? As Spryker offers different business models based on customer requirements, application services related to infra setup vary based on the model. It is important to know which model is being used for the respective environment during provisioning. +Which code base is being used? As Spryker offers different business models based on customer requirements, application services related to infra setup vary based on the model. It is important to know which model is being used for the respective environment during provisioning. {% info_block infoBox "Note" %} @@ -100,7 +101,7 @@ The repository is the place where the customer's Spryker application code reside GitHub: If the customer uses GitHub, provide a link to the GitHub repository, including a branch and a valid GitHub token. This allows code pipelines to access the repository. Ensure that you securely share the GitHub token according to [Spryker recommendations](/docs/scos/user/intro-to-spryker/support/how-to-share-secrets-with-the-spryker-support-team.html). -GitLab and Bitbucket: Connecting GitLab and Bitbucket repositories directly to pipelines isn't supported. Therefore, we have to enable the codecommit feature during provisioning. Connections with pipelines can be established only after the environment is provisioned. If possible, grant GitLab or Bitbucket access to the Spryker engineer working on this request. If not, we'll use your deploy file along with the Spryker Demo Shop during provisioning. For detailed information about the connection process, see [Connect a GitLab code repository](/docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.html#connect-a-gitlab-code-repository) section in "Connecting a code repository". +GitLab and Bitbucket: Connecting GitLab and Bitbucket repositories directly to pipelines isn't supported. Therefore, we have to enable the codecommit feature during provisioning. Connections with pipelines can be established only after the environment is provisioned. If possible, grant GitLab or Bitbucket access to the Spryker engineer working on this request. If not, we'll use your deploy file along with the Spryker Demo Shop during provisioning. For detailed information about the connection process, see [Connect a GitLab code repository](/docs/ca/dev/connect-a-code-repository.html#connect-a-gitlab-code-repository) section in "Connecting a code repository". {% info_block infoBox "Note" %} @@ -126,7 +127,7 @@ Please note Spryker is only issuing SSL certificates for endpoints that are mana Customer or partner users must have access to the following entities: * AWS Console access: You can use it to access environment CloudWatch logs, deployment pipelines, parameter store, S3 buckets. Provide the email addresses of users who need access to AWS Console. * VPN: You can use it to access services such as databases, Jenkins, and RabbitMQ. Usually, developers or DevOps personnel need it. Provide the email addresses of users that need VPN access. -* SSH: You can use it to access the Bastion Host, and from there, reach other services via [port forwarding](/docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.html). Usually, developers or DevOps personnel need it in special cases. Provide an SSH public key and email addresses of users who need access to SSH. Keep in mind that VPN access is required to use SSH. +* SSH: You can use it to access the Bastion Host, and from there, reach other services via [port forwarding](/docs/ca/dev/access/connect-to-services-via-ssh.html). Usually, developers or DevOps personnel need it in special cases. Provide an SSH public key and email addresses of users who need access to SSH. Keep in mind that VPN access is required to use SSH. * SFTP: This access is required for the SFTP Bastion Host. Provide an SSH public key and email addresses of users who need access to SFTP. Keep in mind that VPN access is required to use SFTP. Please note that SFTP is not provisioned by default. ## Optional: Additional attributes @@ -137,7 +138,7 @@ This section explains what additional attributes you can specify at the beginnin Spryker implemented SFTP on top of EFS. You can use SFTP for any third-party integrations or for explicit data imports via Jenkins jobs if required on the project level. Note that SFTP is only available on Bastion and Jenkins. This feature is disabled by default. You can also request it later via the support ticket, but it is preferred to validate this option during provisioning. ### Optional: Site to Site VPN -A Site-to-Site VPN (Virtual Private Network) is a type of network connection that enables secure communication between two or more geographically separated networks. This type of VPN allows two or more sites to establish a secure and encrypted connection over the internet or other public networks, creating a virtual private network between the two sites. +A Site-to-Site VPN (Virtual Private Network) is a type of network connection that enables secure communication between two or more geographically separated networks. This type of VPN allows two or more sites to establish a secure and encrypted connection over the internet or other public networks, creating a virtual private network between the two sites. The following configuration parameters are required to set up the Site-to-Site VPN tunnel: - Customer gateway IP address - IP ranges on the customer side that would need access to Spryker VPC diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.md b/docs/ca/dev/environments-overview.md similarity index 60% rename from docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.md rename to docs/ca/dev/environments-overview.md index 47faeb569bb..e49a341d485 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.md +++ b/docs/ca/dev/environments-overview.md @@ -2,37 +2,41 @@ title: Environments overview description: Learn about the development, staging, and production environments of the Spryker Cloud Commerce OS template: concept-topic-template +redirect_from: last_updated: Jun 8, 2023 + - /docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html --- This document explains what to do with the hosting environments you received at the start of your contract and how you can make use of them best. Knowing the purpose of these platforms and working with them as intended can help you build more solid and performant projects. -{% info_block infoBox "Note" %} +{% info_block infoBox "" %} -The contents of contracts may vary, and this document only describes the default setup. If you are using a different setup, ask your project manager or product owner for a more detailed explanation. -Note that your non-production environments do not scale automatically. If you want to increase their scaling, let us know by requesting through this dedicated form in our support portal: [Upscale Request](https://support.spryker.com/s/hosting-change-requests/environment-upscaling). Due to contractual reasons, these changes can only be requested by customers, not partners. +* Contracts may vary, and this document only describes the default setup. If you are using a different setup, ask your project manager or product owner for a more detailed explanation. +* Your non-production environments do not scale automatically. If you want to increase their scaling, let us know by submitting this form: [Upscale Request](https://support.spryker.com/s/hosting-change-requests/environment-upscaling). Due to contractual reasons, these changes can only be requested by customers, not partners. {% endinfo_block %} ## Basic concept -Spryker offers you environments that serve different purposes. These environments are non-production and production environments. We can configure these environments to be as similar as possible to make sure that the code you deploy on one platform behaves the same way on the others. You can help us keep your environments consistent by taking this into consideration when sending us change requests. + +We offer environments that serve different purposes. These environments are non-production and production environments. We can configure these environments to be as similar as possible to make sure that the code you deploy on one platform behaves the same way on the others. You can help us keep your environments consistent by taking this into consideration when sending us change requests. ### Developer environment (DEV) (optional) -A Dev environment is a non production environment that is usually used to test code that just left your development team, or is used in the development process directly through continuous deployment. It is not designed to handle load tests and large datasets. The development environment does not provide autoscaling and cannot be increased. + +A Dev environment is a non-production environment that is usually used to test code that just left your development team, or is used in the development process directly through continuous deployment. It is not designed to handle load tests and large datasets. The development environment does not provide autoscaling and cannot be increased. ### Staging (STAGE) This environment is a non production environment that is usually used to host a snapshot of the Dev environment, or a stable version of your code that is deployed to production eventually. You can use your staging environment to do performance testing to see how your code behaves in a production environment. However, staging is not of the same size as production, and a subset of data and expected traffic must be considered while running the test. When demoing your shop, this environment is used regularly. The staging environment provides limited autoscaling capabilities and can only be scale dup upon request. ### Production (PROD) -Your production environment must host the code that the end-user gets to interact with directly. The code must already be tested on the staging environment for stability and performance. +Your production environment must host the code that the end-user gets to interact with directly. The code must already be tested on the staging environment for stability and performance. {% info_block infoBox "Note" %} -Do not make changes to the production environments directly unless they have been verified on your staging and dev environments first. +Do not make changes to the production environments directly unless they have been verified on your staging and dev environments first. We highly recommend testing every data load and import, as well as any integrations on your staging environment. {% endinfo_block %} ## Next step -[Accessing AWS Management Console](/docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.html) +[Accessing AWS Management Console](/docs/ca/dev/access/access-the-aws-management-console.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.md b/docs/ca/dev/getting-started-with-cloud-administration.md similarity index 50% rename from docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.md rename to docs/ca/dev/getting-started-with-cloud-administration.md index f25d598fcb2..1466fa1c3b1 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.md +++ b/docs/ca/dev/getting-started-with-cloud-administration.md @@ -1,5 +1,5 @@ --- -title: Getting started with the Spryker Cloud Commerce OS +title: Getting started with cloud administration description: After the initial setup, access Spryker Cloud and start developing. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/getting-started-with-spryker-cloud-commerce-os @@ -13,46 +13,38 @@ redirect_from: - /docs/scos/user/technology-partners/202212.0/hosting-providers/continum.html - /docs/scos/user/technology-partners/202212.0/hosting-providers/metaways.html - /docs/scos/dev/technology-partner-guides/202212.0/hosting-providers/integrating-heroku.html + - /docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html --- -This document is a starting point of development with the Spryker Cloud Commerce OS(SCCOS). +This document is a starting point for managing your Spryker Cloud Commerce OS (SCCOS) cloud environments. SCCOS is a fully-managed solution. Before you start developing, we set up environments, tools, and services based on your Onboarding Questionnaire. If you didn't request something in the questionnaire, you can always do it via [support](https://spryker.force.com/support/s/). After the initial setup, the following is configured and available: -* [Environments](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html): staging and production +* [Environments](/docs/ca/dev/environments-overview.html): staging and production. * Services: RDS database, RDS backup, logs, SMTP, etc. -* Access to AWS, internal resources and services -* CD pipelines for staging and production environments -* Domain names and SSL certificates +* Access to AWS, internal resources, and services. +* CD pipelines for staging and production environments. +* Domain names and SSL certificates. -## Access -You can access SCCOS via: +## Accessing the cloud environments -* IAM account - provides access to AWS Management Console. See [Accessing AWS Management Console](/docs/cloud/dev/spryker-cloud-commerce-os/access/accessing-aws-management-console.html) for more details. -* SSH - provides access to internal services via [bastion host](https://docs.aws.amazon.com/quickstart/latest/linux-bastion/overview.html). See [Connecting to services via SSH](/docs/cloud/dev/spryker-cloud-commerce-os/access/connecting-to-services-via-ssh.html) for more details. -* VPN - provides access to internal services via [bastion host](https://docs.aws.amazon.com/quickstart/latest/linux-bastion/overview.html). We provide the access details during the onboarding. -* SFTP - provides access to the SFTP folder mounted inside the Jenkins container. - -{% info_block warningBox %} - - -* For security purposes, VPN and SSH access are available only for the IP addresses in the security group. Provide your public IPs via [support](https://spryker.force.com/support/s/) to get the access. Additionally, for SSH access, provide your public SSH keys. - -* If you didn’t request SFTP access for the initial setup, you can request it via support later. - - -{% endinfo_block %} +You can access your cloud environments via the following means: +* IAM account: provides access to the AWS Management Console. For instructions, see [Access AWS Management Console](/docs/ca/dev/access/access-the-aws-management-console.html). +* SSH: provides access to internal services via [bastion host](https://docs.aws.amazon.com/quickstart/latest/linux-bastion/overview.html). For instructions, see [Connect to services via SSH](/docs/ca/dev/access/connect-to-services-via-ssh.html). +* VPN: provides access to internal services via [bastion host](https://docs.aws.amazon.com/quickstart/latest/linux-bastion/overview.html). You receive these access details during the onboarding. +* SFTP: provides access to the SFTP folder mounted inside the Jenkins container. You receive these access details during the onboarding. ## Service credentials -You can find the credentials for services in the environment variables for the Zed container in [Elastic Container Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html). See [Locating service credentials](/docs/cloud/dev/spryker-cloud-commerce-os/access/locating-service-credentials.html) to learn how to get them. +You can find the credentials for services in the environment variables for the Zed container in [Elastic Container Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html). For instructions, see [Locate service credentials](/docs/ca/dev/access/locate-service-credentials.html). -## CD Pipelines + +## CD pipelines The following CD pipelines are configured in [CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html): @@ -67,7 +59,8 @@ The following CD pipelines are configured in [CodePipeline](https://docs.aws.ama -See [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) and [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) to learn about running pipelines. +To learn about running pipelines, see [Deploy in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) and [Deploy in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html). ## Next step -[Environments overview](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html) + +[Environments overview](/docs/ca/dev/environments-overview.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.md b/docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.md similarity index 77% rename from docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.md rename to docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.md index 70d6962e6e8..a5d996e20d5 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.md +++ b/docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.md @@ -2,9 +2,11 @@ title: Configure access to applications in maintenance mode description: Learn how to configure access to Spryker applications in maintenance mode. template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html --- -When you [enable maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.html) for an application, visitors see a maintenance page and can't access the application. To enable access to an application in maintenance mode, you can allowlist IP addresses as follows. +When you [enable maintenance mode](/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html) for an application, visitors see a maintenance page and can't access the application. To enable access to an application in maintenance mode, you can allowlist IP addresses as follows. ## Define gateway IP addresses @@ -70,7 +72,7 @@ For more information about the deploy file configuration, see [docker: maintenan ## Deploy the changes Deploy the application with the updated configuration by following one of the following docs: - * [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) - * [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) + * [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) + * [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) Now you can access the applications from the `192.158.1.38` and `192.0.2.1` IP addresses. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.md b/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.md similarity index 90% rename from docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.md rename to docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.md index ebad0657707..d9e20736bbc 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.md +++ b/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.md @@ -2,6 +2,8 @@ title: Enable and disable maintenance mode description: Learn how to deploy maintenance pages for Spryker applications. template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.html --- Maintenance mode is used many cases, like deploying a new application version or fixing an unexpected error. To automate the process, we created dedicated pipelines for enabling and disabling maintenance mode. The following sections describe how to run maintenance mode pipelines. @@ -22,7 +24,7 @@ When you enable maintenance mode, the landing pages of your applications, like t 2. On the **Pipelines** pane, click **Maintenance_Enable_{ENVIRONMENT_NAME}**. 3. On the pipeline's page, click **Release change**. - The deployment time depends on the application's complexity. Once the deployment is finished, Storefront and Back Office visitors should see the maintenance page. To get access to the frontend applications in maintenance mode, you can allowlist the needed IP addresses. For instructions, see [Configure access to applications in maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html). + The deployment time depends on the application's complexity. Once the deployment is finished, Storefront and Back Office visitors should see the maintenance page. To get access to the frontend applications in maintenance mode, you can allowlist the needed IP addresses. For instructions, see [Configure access to applications in maintenance mode](/docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html). ![Maintenance mode enable pipeline](https://spryker.s3.eu-central-1.amazonaws.com/docs/cloud/spryker-cloud-commerce-os/enable-and-disable-maintenance-mode.md/maintenance-enable-pipeline.png) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/managing-parameters-in-the-parameter-store.md b/docs/ca/dev/managing-parameters-in-the-parameter-store.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/managing-parameters-in-the-parameter-store.md rename to docs/ca/dev/managing-parameters-in-the-parameter-store.md index 5f2ab1486f3..6bffdf86395 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/managing-parameters-in-the-parameter-store.md +++ b/docs/ca/dev/managing-parameters-in-the-parameter-store.md @@ -7,6 +7,7 @@ originalArticleId: 2047c84c-bd7b-4bce-9203-08945367ad46 redirect_from: - /docs/managing-parameters-in-the-parameter-store - /docs/en/managing-parameters-in-the-parameter-store + - /docs/cloud/dev/spryker-cloud-commerce-os/managing-parameters-in-the-parameter-store.html --- This document describes how you can add new parameters and edit the values of existing parameters. You can use parameters for multiple purposes, like storing mail server details or providing Composer authentication details to the build and deploy process securely. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring-issues-and-informing-about-alerts.md b/docs/ca/dev/monitoring-issues-and-informing-about-alerts.md similarity index 97% rename from docs/cloud/dev/spryker-cloud-commerce-os/monitoring-issues-and-informing-about-alerts.md rename to docs/ca/dev/monitoring-issues-and-informing-about-alerts.md index 2de1705eed3..4401a5baa86 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring-issues-and-informing-about-alerts.md +++ b/docs/ca/dev/monitoring-issues-and-informing-about-alerts.md @@ -2,6 +2,8 @@ title: Monitoring issues and informing about alerts DESCRIPTION: Learn how issues with environments are monitored and how customers are informed about alerts on PaaS template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/monitoring-issues-and-informing-about-alerts.html --- Every Spryker cloud environment is monitored by the monitoring systems and a dedicated 24/7 team that ensures that environments run stable. In case of problems, this team takes action autonomously or inform you if there is a need for further action on their side. This document explains in details how monitoring and alerting works on Spryker PaaS. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/customize-aws-cloudwatch-dashboards.md b/docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/monitoring/customize-aws-cloudwatch-dashboards.md rename to docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.md index b946bd73d49..69c0f2784e8 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/customize-aws-cloudwatch-dashboards.md +++ b/docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.md @@ -8,6 +8,7 @@ redirect_from: - /docs/customizing-aws-cloudwatch-dashboards - /docs/en/customizing-aws-cloudwatch-dashboards - /docs/cloud/dev/spryker-cloud-commerce-os/customizing-aws-cloudwatch-dashboards.html + - /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/customize-aws-cloudwatch-dashboards.html --- This document describes how to customize AWS CloudWatch dashboards. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/monitoring.md b/docs/ca/dev/monitoring/monitoring.md similarity index 57% rename from docs/cloud/dev/spryker-cloud-commerce-os/monitoring/monitoring.md rename to docs/ca/dev/monitoring/monitoring.md index 7981b082e77..846d5c338b6 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/monitoring.md +++ b/docs/ca/dev/monitoring/monitoring.md @@ -3,9 +3,11 @@ title: Monitoring last_updated: Jan 16, 2023 description: Explains monitoring via New Relic and describes how to customize AWS CloudWatch dashboards template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/monitoring.html --- This section explains monitoring via New Relic and describes how to customize AWS CloudWatch dashboards: -* [Performance and availability monitoring via New Relic](/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.html) -* [Customize AWS CloudWatch dashboards](/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/customize-aws-cloudwatch-dashboards.html) +* [Performance and availability monitoring via New Relic](/docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.html) +* [Customize AWS CloudWatch dashboards](/docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.md b/docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.md similarity index 82% rename from docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.md rename to docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.md index 7e4b088394f..5d1316bd1e9 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.md +++ b/docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.md @@ -2,10 +2,12 @@ title: Performance and availability monitoring via New Relic description: template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.html --- New Relic delivers the end-to-end observability for all metrics, events, logs, and traces and delivers the ability to visualize, analyze, and troubleshoot your entire environment including network performance. You can easily view and analyze massive amounts of data, and gain actionable insights in real-time. For more information about New Relic, see [Get started with infrastructure monitoring](https://docs.newrelic.com/docs/infrastructure/infrastructure-monitoring/get-started/get-started-infrastructure-monitoring). -To get access to New Relic, provide a non-person email address via [support](https://spryker.force.com/support/s/). We will create a shared account for your team. +To get access to New Relic, provide a non-person email address via [support](https://spryker.force.com/support/s/). We will create a shared account for your team. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.md b/docs/ca/dev/multi-store-setups/add-and-remove-databases-of-stores.md similarity index 84% rename from docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.md rename to docs/ca/dev/multi-store-setups/add-and-remove-databases-of-stores.md index 1e48c039593..b064216db9c 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.md +++ b/docs/ca/dev/multi-store-setups/add-and-remove-databases-of-stores.md @@ -2,13 +2,15 @@ title: Add and remove databases of stores description: Learn how to add and remove databases of stores template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.html --- This document describes how to add and remove a dedicated database of a store. ## Prerequisites -Make sure that your project supports the [separated multi-store setup](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.html). +Make sure that your project supports the [separated multi-store setup](/docs/ca/dev/multi-store-setups/multi-store-setups.html). ## Add a database for a store @@ -71,8 +73,8 @@ regions: Run a destructive pipeline for the application. Based on the environment, follow the instructions in one of the following docs: -* [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) -* [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) +* [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) +* [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) ## Remove a database of store @@ -124,5 +126,5 @@ regions: Run a destructive pipeline for the application. Based on the environment, follow the instructions in one of the following docs: -* [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) -* [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) +* [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) +* [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.md b/docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.md similarity index 94% rename from docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.md rename to docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.md index 6b4f589fb2b..21a6b8c70cc 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.md +++ b/docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.md @@ -2,12 +2,14 @@ title: Checklist for a new store implementation description: Learn how to implement a new store in a multi-store environment template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.html related: - title: Multistore setup options link: docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html --- -This document outlines the high-level tasks and responsibilities of Spryker and Customer when setting up a new store depending on the chosen setup for the multi-store environment. For a description of setups referred to in this document, see [Multistore setup options](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html). +This document outlines the high-level tasks and responsibilities of Spryker and Customer when setting up a new store depending on the chosen setup for the multi-store environment. For a description of setups referred to in this document, see [Multistore setup options](/docs/ca/dev/multi-store-setups/multistore-setup-options.html). For detailed steps about the new store implementation, see [HowTo: Set up multiple stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html). @@ -22,7 +24,7 @@ For detailed steps about the new store implementation, see [HowTo: Set up multip 2. Implement and apply [code buckets](/docs/scos/dev/architecture/code-buckets.html) for different themes. 3. Adjust the importer and define product, content, data, payment, including OMS, or stock store relations via the importer. See [example for the B2C demo shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/data/import/common/common). 4. Change DNS (merchant owns DNS). -5. Check third-party integrations (ERP, CRM, CMS, PIM, Payment, Logistics, Search). +5. Check third-party integrations (ERP, CRM, CMS, PIM, Payment, Logistics, Search). 6. Migration of the existing data into the shared instance. Spryker can support you in this on request. 7. Full UAT, end2end tests. 8. Check the provided launch list from Spryker, if you start a new project. @@ -50,10 +52,10 @@ For this setup, send a support request to Spryker and do the following: **SI / Customer** 1. Set up a local dev environment and adjust the configuration in `config.php`, including hosts in data YML files, for example, in `/deploy.spryker-b2c-production.yml`. -2. Implement and apply [code buckets](/docs/scos/dev/architecture/code-buckets.html) for different themes. +2. Implement and apply [code buckets](/docs/scos/dev/architecture/code-buckets.html) for different themes. 3. Adjust the importer and define product, content, data, payment, including OMS or stock store relations via the importer. See [example for the B2C demo shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/data/import/common/common). 4. Change DNS (merchant owns DNS). -5. Check third-party integrations (ERP, CRM, CMS, PIM, Payment, Logistics, Search). +5. Check third-party integrations (ERP, CRM, CMS, PIM, Payment, Logistics, Search). 6. Migrate the existing data into the shared instance. Spryker can support you in this on request. 7. Conduct the full UAT, end2end tests. 8. If you start a new project, check the provided launch list from Spryker. @@ -73,7 +75,7 @@ The following steps are subject to change and should be considered as tentative. {% endinfo_block %} -For this type of setup, you have to send a new provisioning request via the [Spryker support portal](https://support.spryker.com/s/). +For this type of setup, you have to send a new provisioning request via the [Spryker support portal](https://support.spryker.com/s/). **Spryker** @@ -82,10 +84,10 @@ Provision of a new fully isolated environment per store. **SI / Customer** 1. Set up a local dev environment and adjust the configuration in `config.php`, including hosts in data YML files, for example, in `/deploy.spryker-b2c-production.yml`. -2. Implement and apply [code buckets](/docs/scos/dev/architecture/code-buckets.html) for different themes. +2. Implement and apply [code buckets](/docs/scos/dev/architecture/code-buckets.html) for different themes. 3. Adjust the importer and define product, content, data, payment, including OMS or stock store relations via the importer. See [example for the B2C demo shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/data/import/common/common). 4. Change DNS (merchant owns DNS). -5. Check third-party integrations (ERP, CRM, CMS, PIM, Payment, Logistics, Search). +5. Check third-party integrations (ERP, CRM, CMS, PIM, Payment, Logistics, Search). 6. Migrate the existing data into the shared instance. Spryker can support you in this on request. 7. Conduct the full UAT, end2end tests. 8. Check the provided launch list from Spryker, if you start a new project. @@ -107,7 +109,7 @@ The touchpoints listed here may vary depending on the project. If view of that, ### Data 1. Generate product data files to add new localized attributes and entries. -2. Create the folder `data/import/common/{NewStore}` and fill it with all the files that reflect the new store. +2. Create the folder `data/import/common/{NewStore}` and fill it with all the files that reflect the new store. 3. Modify install recipes to add the new folder you created or copied in the previous steps. ### Store domains and certificates @@ -117,7 +119,7 @@ Request the Spryker Cloud team to create domains and certificates. Certificates are created for all domains. -{% endinfo_block %} +{% endinfo_block %} ### Translations - Re-generate all CSV files consisting of a new locale. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.md b/docs/ca/dev/multi-store-setups/multi-store-setups.md similarity index 90% rename from docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.md rename to docs/ca/dev/multi-store-setups/multi-store-setups.md index 0c0a5575527..db3782815c8 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.md +++ b/docs/ca/dev/multi-store-setups/multi-store-setups.md @@ -2,9 +2,11 @@ title: Multi-store setups description: Types of multi-store setups in Spryker Cloud Commerce OS template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.html --- -The Multi-Store is a capability in the Spryker Cloud Commerce OS that gives you the flexibility to create multiple stores for different scenarios—giving you the ability to easily reach your customers everywhere. +The Multi-Store is a capability in the Spryker Cloud Commerce OS that gives you the flexibility to create multiple stores for different scenarios—giving you the ability to easily reach your customers everywhere. The Spryker Cloud Commerce OS supports following multi-store setups: @@ -30,7 +32,7 @@ We recommend this setup for simple shops that have two to three stores that foll * All stores are hosted in the same AWS region. -For more details on this setup, see [Setup 1: Shared infrastructure resources (default)](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html#setup-1-shared-infrastructure-resources-default) +For more details on this setup, see [Setup 1: Shared infrastructure resources (default)](/docs/ca/dev/multi-store-setups/multistore-setup-options.html#setup-1-shared-infrastructure-resources-default) ## Separated setup diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.md b/docs/ca/dev/multi-store-setups/multistore-setup-options.md similarity index 97% rename from docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.md rename to docs/ca/dev/multi-store-setups/multistore-setup-options.md index 3a672783be7..555a9defc1e 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.md +++ b/docs/ca/dev/multi-store-setups/multistore-setup-options.md @@ -2,6 +2,8 @@ title: Multi-store setup options description: Learn about all the setup options you have for a multi-store environment. template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html related: - title: Add and remove databases of stores link: docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.html @@ -107,7 +109,7 @@ While the search index and key-value storages are shared resources, you can have {% endinfo_block %} -- Virtual separated database per store. For details on how to add virtual databases to your store, see [Add and remove databases of stores](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/add-and-remove-databases-of-stores.html). +- Virtual separated database per store. For details on how to add virtual databases to your store, see [Add and remove databases of stores](/docs/ca/dev/multi-store-setups/add-and-remove-databases-of-stores.html). {% info_block infoBox "Info" %} @@ -139,7 +141,7 @@ The following table provides details on the infrastructure for this setup: {% info_block infoBox "Info" %} -You can apply the virtually isolated database to setup one and setup three too. See [Shared setup](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.html#shared-setup) for more details. +You can apply the virtually isolated database to setup one and setup three too. See [Shared setup](/docs/ca/dev/multi-store-setups/multi-store-setups.html#shared-setup) for more details. {% endinfo_block %} @@ -245,4 +247,4 @@ If you anticipate a high load, it's essential to consult and obtain guidance fro ## Next steps - [Implement a new store for your multi-store environment](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html) -- [Check your and Spryker's tasks when setting up a new store](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.html) +- [Check your and Spryker's tasks when setting up a new store](/docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md b/docs/ca/dev/performance-testing-in-staging-enivronments.md similarity index 99% rename from docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md rename to docs/ca/dev/performance-testing-in-staging-enivronments.md index 89beb066c2e..ea802a9ac30 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.md +++ b/docs/ca/dev/performance-testing-in-staging-enivronments.md @@ -5,6 +5,7 @@ last_updated: Sep 15, 2022 template: concept-topic-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/performance-testing.html + - /docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html --- Performance testing is an integral part of the development and deployment process. Even if you execute performance testing during development, we highly recommend testing the performance of your code in a staging environment before deploying it in production environments. @@ -351,7 +352,7 @@ Both Java 8+ and Node 10.10+ are requirements to run Gatling from any system. Th The last steps to getting the Spryker load testing tool set up with your project is to finally install Gatling. The load testing tool is set up with a PHP interface which makes calls to Gatling to run the tests that have been built into the tool. -If you are attempting to load test your production or staging environment and are not testing your site locally, you can skip to the [steps for standalone installation](/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html#installing-gatling-as-a-standalone-package). +If you are attempting to load test your production or staging environment and are not testing your site locally, you can skip to the [steps for standalone installation](/docs/ca/dev/performance-testing-in-staging-enivronments.html#installing-gatling-as-a-standalone-package). An installation script is included with the load testing tool and can be run with the following: diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/preparation-for-going-live.md b/docs/ca/dev/preparation-for-going-live.md similarity index 93% rename from docs/cloud/dev/spryker-cloud-commerce-os/preparation-for-going-live.md rename to docs/ca/dev/preparation-for-going-live.md index 1dda4390290..cbfc8a5b2f8 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/preparation-for-going-live.md +++ b/docs/ca/dev/preparation-for-going-live.md @@ -8,11 +8,12 @@ originalArticleId: 738903ac-4167-47ed-93c8-b225c8041582 redirect_from: - /docs/preparation-for-going-live - /docs/en/preparation-for-going-live + - /docs/cloud/dev/spryker-cloud-commerce-os/preparation-for-going-live.html --- {% info_block warningBox "Do not risk your Go-Live!" %} -The preparation steps listed here are mandatory because they are critical to the success of your go-live. We expect every Spryker customer and partner to complete the list as described below. We can't assist you with problems related to your go-live that are caused by these steps not being completed in time. Ensure that your project plan contains tasks related to the go-live checklist and allows enough time for them to be completed. +The preparation steps listed here are mandatory because they are critical to the success of your go-live. We expect every Spryker customer and partner to complete the list as described below. We can't assist you with problems related to your go-live that are caused by these steps not being completed in time. Ensure that your project plan contains tasks related to the go-live checklist and allows enough time for them to be completed. {% endinfo_block %} @@ -34,7 +35,7 @@ You cannot successfully deploy a project on Spryker Cloud Commerce OS unless you - Verify that your project's service naming scheme is an exact match for the examples inside the [sample deploy-spryker-b2c-staging.yml file](https://github.com/spryker-shop/b2c-demo-shop/blob/202204.0-p2/deploy.spryker-b2c-staging.yml). - Create [deploy files](/docs/scos/dev/the-docker-sdk/{{site.version}}/deploy-file/deploy-file.html) for each of your environments. These files must be named in a particular manner: `deploy.(project)-(environment).yml`. For example, `deploy.example-staging.yml`. - [Define a Docker SDK version](/docs/scos/dev/the-docker-sdk/{{site.version}}/choosing-a-docker-sdk-version.html) for the project to use. -- Integrate [FlySystem](/docs/cloud/dev/spryker-cloud-commerce-os/configuring-data-import-from-an-s3-bucket.html) so that the project is using data in S3 Buckets instead of local storage. +- Integrate [FlySystem](/docs/ca/dev/configure-data-import-from-an-s3-bucket.html) so that the project is using data in S3 Buckets instead of local storage. - Use the option to [test your deployments locally](/docs/scos/dev/tutorials-and-howtos/howtos/howto-do-better-deployments.html#bootstrap-with-codedeployymlcode) to understand how your application will perform and work when deployed. - Before deploying your payment options, test them locally. For more information, see [HowTo: Debug payment integrations locally](/docs/scos/dev/tutorials-and-howtos/howtos/howto-debug-payment-integrations-locally.html). @@ -73,17 +74,17 @@ PaaS production email service has the following quotas: * Daily sending limit: 50.000 emails. * Sending limit messages per second: 14. -PaaS nonproduction email service has the following quotas: +PaaS non-production email service has the following quotas: * Daily sending limit: 200 emails. * Sending limit messages per second: 1 -Note that recipients of emails need to be individually [verified](https://docs.spryker.com/docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.html) for nonproduction systems. +Recipients of emails need to be individually [verified](/docs/ca/dev/verify-email-addresses.html) for non-production systems. Reach out to [Spryker Support](/docs/scos/user/intro-to-spryker/support/getting-support.html) if these are not sufficient to support your use case. {% endinfo_block %} -- Optional: *Delegate DNS*. To find out how to delegate a DNS name, see [Setting up a custom SSL certificate](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html). +- Optional: *Delegate DNS*. To find out how to delegate a DNS name, see [Setting up a custom SSL certificate](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html). ### DNS setup @@ -112,8 +113,8 @@ We do not normally support full delegation of your DNS to us and, therefore, do - *Verify that your Deploy file is set up correctly*. Verify that your project works and operates the production endpoints. You can set both testing and production endpoints in your Deploy file. Your developers need to mock a "live" operation of the project with its production endpoints by adjusting their local host entries. - *Variables and parameter store values are set up*. Double-check whether you have all environment variables and parameter store values set up. Remember that this has some lead time on our side. If you are still missing parameters, create them. -- *TLS certificates are provisioned*. If you delegate DNS to Spryker, TLS certificates for your endpoints are created automatically. If you want us to create TLS certificates for your endpoints but do not want to delegate your DNS, request the verification of DNS records by the [Support Portal](https://support.spryker.com). If you do not delegate your DNS and want to use your own certificates, provide them to us as described in [Setting up a custom SSL certificate](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html). -- *Deploy the production environment regularly*. This lets you detect potential issues early enough to fix them before going live. For instructions, see [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html). +- *TLS certificates are provisioned*. If you delegate DNS to Spryker, TLS certificates for your endpoints are created automatically. If you want us to create TLS certificates for your endpoints but do not want to delegate your DNS, request the verification of DNS records by the [Support Portal](https://support.spryker.com). If you do not delegate your DNS and want to use your own certificates, provide them to us as described in [Setting up a custom SSL certificate](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html). +- *Deploy the production environment regularly*. This lets you detect potential issues early enough to fix them before going live. For instructions, see [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html). {% info_block warningBox "Integration with payment providers" %} diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/release-notes.md b/docs/ca/dev/release-notes.md similarity index 87% rename from docs/cloud/dev/spryker-cloud-commerce-os/release-notes.md rename to docs/ca/dev/release-notes.md index 7bf6445a78c..b59f47db91a 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/release-notes.md +++ b/docs/ca/dev/release-notes.md @@ -7,6 +7,7 @@ originalArticleId: eee5e8bc-dd95-4b51-91f4-203962a2e8af redirect_from: - /docs/release-notes - /docs/en/release-notes + - /docs/cloud/dev/spryker-cloud-commerce-os/release-notes.html --- This document describes new features and enhancements released for Spryker Cloud Commerce OS. @@ -32,7 +33,7 @@ Flexibility. You can change environment variables according to a needed schedule #### Documentation -[Define parameter and secret values in SCCOS environments](/docs/cloud/dev/spryker-cloud-commerce-os/define-parameter-and-secret-values-in-sccos-environments.html) +[Define parameter and secret values in SCCOS environments](/docs/ca/dev/managing-parameters-in-the-parameter-store.html) ### Maintenance mode ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) @@ -45,8 +46,8 @@ Faster maintenance. You can enable maintenance mode more quickly, reducing downt #### Documentation -* [Enable and disable maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.html) -* [Configure access to applications in maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html) +* [Enable and disable maintenance mode](/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html) +* [Configure access to applications in maintenance mode](/docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html) ### Deployment optimization of RabbitMQ ![improvement](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/improvement.png) @@ -103,7 +104,7 @@ Benefits of a multi-store setup: ### Documentation -[Multi-store setups](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.html) +[Multi-store setups](/docs/ca/dev/multi-store-setups/multi-store-setups.html) ## January 2022 @@ -133,9 +134,9 @@ Increased the stability of Jenkins deployment. This update addresses critical is * **Documentation about Docker SDK installation on Windows**: updated Docker prerequisites for Windows with instructions for WSL2. See [Installing Docker prerequisites on Windows](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html). -* **Documentation about Onboarding deliverables**: updated the Spryker Cloud Commerce OS getting started page with the deliverables provided after the onboarding. See [Getting started with the Spryker Cloud Commerce OS](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html). +* **Documentation about Onboarding deliverables**: updated the cloud administration getting started page with the deliverables provided after the onboarding. See [Getting started with cloud administration](/docs/ca/dev/getting-started-with-cloud-administration.html). -* **Documentation about GitLab**: published the instructions on connecting a GitLab repository to the CD Pipeline. See [Connect a GitLab code repository](/docs/cloud/dev/spryker-cloud-commerce-os/connecting-a-code-repository.html#connect-a-gitlab-code-repository). +* **Documentation about GitLab**: published the instructions on connecting a GitLab repository to the CD Pipeline. See [Connect a GitLab code repository](/docs/ca/dev/connect-a-code-repository.html#connect-a-gitlab-code-repository). * **Documentation about Docker SDK**: published new and updated existing pages covering the following Docker SDK topics: deploy file reference, choosing a version, quick start guide, installation, services, modes overview, mount options, debugging, running tests, and troubleshooting. See [Docker SDK](/docs/scos/dev/the-docker-sdk/{{site.version}}/the-docker-sdk.html). diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/security/checking-ecr-image-scan-results.md b/docs/ca/dev/security/check-ecr-image-scan-results.md similarity index 83% rename from docs/cloud/dev/spryker-cloud-commerce-os/security/checking-ecr-image-scan-results.md rename to docs/ca/dev/security/check-ecr-image-scan-results.md index a552f15caee..731fb3aa13f 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/security/checking-ecr-image-scan-results.md +++ b/docs/ca/dev/security/check-ecr-image-scan-results.md @@ -1,5 +1,5 @@ --- -title: Checking ECR image scan results +title: Check ECR image scan results description: Protect your applications by resolving issues detected by ECR image scans. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/checking-ecr-image-scan-results @@ -7,9 +7,10 @@ originalArticleId: df76db2c-05f5-4ec8-b5b4-3dee7dd3a152 redirect_from: - /docs/checking-ecr-image-scan-results - /docs/en/checking-ecr-image-scan-results + - /docs/cloud/dev/spryker-cloud-commerce-os/security/checking-ecr-image-scan-results.html --- -This document describes how to check ECR image scan results. +This document describes how to check ECR image scan results. After a new code is pushed to a repository, ECR scans images for known vulnerabilities. You can check scan results and resolve detected issues to protect your applications. See [Image scanning](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) to learn more about ECR image scans. @@ -21,4 +22,4 @@ To check image scan results: 4. On the *Repositories* page, select the repository that contains the image whose scan you want to check. 5. In the *Vulnerabilities* column of the *Images* page, select **Details** next to the image whose scan you want to check. -You’ve located ECR image scan results. +You’ve located ECR image scan results. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/security/generating-access-keys.md b/docs/ca/dev/security/generate-access-keys.md similarity index 94% rename from docs/cloud/dev/spryker-cloud-commerce-os/security/generating-access-keys.md rename to docs/ca/dev/security/generate-access-keys.md index 02c1e36a648..3295ee1f84e 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/security/generating-access-keys.md +++ b/docs/ca/dev/security/generate-access-keys.md @@ -1,5 +1,5 @@ --- -title: Generating access keys +title: Generate access keys description: Learn how to generate access keys for your AWS account. template: howto-guide-template originalLink: https://cloud.spryker.com/docs/generating-access-keys @@ -7,6 +7,7 @@ originalArticleId: 624eb34a-4e28-40ec-a9cb-663ae1524d33 redirect_from: - /docs/generating-access-keys - /docs/en/generating-access-keys + - /docs/cloud/dev/spryker-cloud-commerce-os/security/generating-access-keys.html --- This document describes how to generate access keys. Access keys are used to access AWS Command Line Interface and connect integrated development environments, like PhpStorm. diff --git a/docs/ca/dev/security/security.md b/docs/ca/dev/security/security.md new file mode 100644 index 00000000000..99c2332ba21 --- /dev/null +++ b/docs/ca/dev/security/security.md @@ -0,0 +1,14 @@ +--- +title: Security +last_updated: Jan 16, 2023 +description: Explains how to check ECR image scan results and generate access keys, and introduces the web application firewall +template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/security/security.html +--- + +This section explains how to check ECR image scan results and generate access keys, and introduces the web application firewall: + +* [Checking ECR image scan results](/docs/ca/dev/security/check-ecr-image-scan-results.html) +* [Generating access keys](/docs/ca/dev/security/generate-access-keys.html) +* [Web Application Firewall (WAF)](/docs/ca/dev/security/web-application-firewall-waf.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/security/web-application-firewall-waf.md b/docs/ca/dev/security/web-application-firewall-waf.md similarity index 79% rename from docs/cloud/dev/spryker-cloud-commerce-os/security/web-application-firewall-waf.md rename to docs/ca/dev/security/web-application-firewall-waf.md index 32a8c9d6e9f..b52113018cd 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/security/web-application-firewall-waf.md +++ b/docs/ca/dev/security/web-application-firewall-waf.md @@ -2,10 +2,12 @@ title: Web Application Firewall (WAF) description: WAF protects your SCCOS applications from web exploits and bots. template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/security/web-application-firewall-waf.html --- AWS WAF is a web application firewall that helps protect your web applications or APIs against common web exploits, SQL injections, cross-site scripting, or bots that may affect availability, compromise security, or consume excessive resources. For more information on WAF, see [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). -WAF protects your SCCOS applications using a set of pre-defined rules. When web request triggers a rule, WAF blocks it. Occasionally, you will be getting false positives. Usually, in a web application, a false positive results into error 403. If you get the error, troubleshoot it by following [Tutorial — Troubleshooting 403 error](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html). +WAF protects your SCCOS applications using a set of pre-defined rules. When web request triggers a rule, WAF blocks it. Occasionally, you will be getting false positives. Usually, in a web application, a false positive results into error 403. If you get the error, troubleshoot it by following [Tutorial — Troubleshooting 403 error](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html). diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.md b/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.md similarity index 88% rename from docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.md rename to docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.md index cad988dc502..c32cdab9317 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.md +++ b/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.md @@ -6,6 +6,7 @@ originalArticleId: a0bdd6d7-2603-4bb6-8ab9-0899a6b2041f redirect_from: - /docs/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider - /docs/en/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider + - /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.html --- This document describes how to set up a custom domain name (domain) with a third-party DNS zone provider. @@ -72,10 +73,10 @@ See [Deploy File Reference - 1.0](/docs/scos/dev/the-docker-sdk/{{site.version}} 4. Depending on the environment you are setting up the domain for: -* [Deploy the application in the production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html). +* [Deploy the application in the production environment](/docs/ca/dev/deploy-in-a-production-environment.html). -* [Deploy the application in the staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html). +* [Deploy the application in the staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html). ## Next step -[Setting up a custom SSL certificate](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html) +[Setting up a custom SSL certificate](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-route-53.md b/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-route-53.md similarity index 88% rename from docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-route-53.md rename to docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-route-53.md index a1fcf97940e..993e833130d 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-route-53.md +++ b/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-route-53.md @@ -6,6 +6,7 @@ originalArticleId: 6a422776-6e65-48ae-8133-759954b13537 redirect_from: - /docs/setting-up-a-custom-domain-name-with-route-53 - /docs/en/setting-up-a-custom-domain-name-with-route-53 + - /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-route-53.html --- This document describes how to set up a custom domain name (domain) with its DNS zone hosted by [Route53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html). @@ -24,7 +25,7 @@ For a domain to start using the created hosted zone: 4. In the *Records* pane, locate the record with the *NS* type. 5. Copy the *Value* of this record, which is a list of nameservers. 6. On your domain registrar's side, set up the nameservers for your domain. Refer to the domain registrar's documentation for details. -7. Optional: [Set up a custom SSL certificate for the domain](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html). +7. Optional: [Set up a custom SSL certificate for the domain](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html). ## 3. Define domain names @@ -73,9 +74,9 @@ See [Deploy File Reference - 1.0](/docs/scos/dev/the-docker-sdk/{{site.version}} 4. Depending on the environment you are setting up the domain for: -* [Deploy the application in the production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html). +* [Deploy the application in the production environment](/docs/ca/dev/deploy-in-a-production-environment.html). -* [Deploy the application in the staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html). +* [Deploy the application in the staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html). 5. Let us know about the desired change via [support](https://spryker.force.com/support/s/). @@ -86,4 +87,4 @@ Give the DNS configuration 24-48 hours to propagate and you will be able to acce ## Next step -[Setting up a custom SSL certificate](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html) +[Setting up a custom SSL certificate](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name.md b/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name.md similarity index 80% rename from docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name.md rename to docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name.md index 5e94897de39..eeeb376e3a4 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name.md +++ b/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name.md @@ -6,17 +6,18 @@ originalArticleId: fbf9cb02-2a68-45bd-a404-258011585225 redirect_from: - /docs/setting-up-a-custom-domain-name - /docs/en/setting-up-a-custom-domain-name + - /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name.html --- With Spryker Cloud Commerce OS, you get domain names (domains) which are managed automatically for the staging and production environments. You can also set up custom domains during the initial setup or any time later. If you provided custom domains for the initial setup, follow [Set up a DNS zone](#set-up-a-dns-zone). If you want to set up a custom domain after the initial setup, depending on the desired DNS zone provider, see: -* [Setting up a custom domain name with Route 53](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-route-53.html) -* [Setting up a custom domain name with a third-party DNS zone provider](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-domain-name/setting-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.html) +* [Setting up a custom domain name with Route 53](/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-route-53.html) +* [Setting up a custom domain name with a third-party DNS zone provider](/docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.html) ## Set up a DNS zone -You can host the DNS zone of a domain with [Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html) or with a third-party provider. +You can host the DNS zone of a domain with [Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html) or with a third-party provider. If you choose the latter, you need to manage DNS records and SSL certificates with the DNS zone provider. ### Set up a DNS zone with Route 53 @@ -28,9 +29,9 @@ We created [Route 53 Hosted Zones](https://docs.aws.amazon.com/Route53/latest/De 4. In the *Records* section, locate the record with the *NS* type. 5. Copy the *Value* of this record, which is a list of nameservers. 6. On your domain registrar's side, set up the nameservers for the domain. Refer to the domain registrar's documentation for details. -7. Optional: [Set up a custom SSL certificate for the domain](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html). +7. Optional: [Set up a custom SSL certificate for the domain](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html). -Give the DNS configuration 24-48 hours to propagate and you will be able to access your application via the domain. +Give the DNS configuration 24-48 hours to propagate and you will be able to access your application via the domain. ### Set up a DNS zone with a third-party DNS zone provider @@ -42,12 +43,11 @@ We created load balancers for the staging and production environment during the * *{project_name}-prod* 3. In the *Load balancer:{load balancer name}* section, select **Copy** ![copy icon](https://spryker.s3.eu-central-1.amazonaws.com/cloud-docs/Spryker+Cloud/Setting+up+a+custom+domain+name/Setting+up+a+custom+domain+name/copy-icon.png) next to the DNS name field. - + 4. On the side of the DNS zone provider, set up a CNAME record using the copied *DNS name* as the record value. Refer to the DNS zone provider’s documentation for details. -Give the DNS configuration about an hour to propagate and you will be able to access your application via the domain. - -## Next step +Give the DNS configuration about an hour to propagate and you will be able to access your application via the domain. -[Setting up a custom SSL certificate](/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html) +## Next step +[Setting up a custom SSL certificate](/docs/ca/dev/setting-up-a-custom-ssl-certificate.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-notifications-for-5xx-errors.md b/docs/ca/dev/set-up-notifications-for-5xx-errors.md similarity index 91% rename from docs/cloud/dev/spryker-cloud-commerce-os/setting-up-notifications-for-5xx-errors.md rename to docs/ca/dev/set-up-notifications-for-5xx-errors.md index 26915724cf5..2298913ef94 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-notifications-for-5xx-errors.md +++ b/docs/ca/dev/set-up-notifications-for-5xx-errors.md @@ -1,7 +1,9 @@ --- -title: Setting up a notifications for 5xx errors +title: Set up a notifications for 5xx errors description: Learn how to set up notifications for 5xx errors via SNS template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-notifications-for-5xx-errors.html --- This document describes how to set up email notifications for 5xx errors via [Simple Notification Service](https://docs.aws.amazon.com/sns/latest/dg/welcome.html). The notifications are sent if, during a two-minute period, more than 20% of requests are getting 5xx responses. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.md b/docs/ca/dev/setting-up-a-custom-ssl-certificate.md similarity index 82% rename from docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.md rename to docs/ca/dev/setting-up-a-custom-ssl-certificate.md index 77e8ce6aa8e..f4e40696888 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.md +++ b/docs/ca/dev/setting-up-a-custom-ssl-certificate.md @@ -7,11 +7,12 @@ originalArticleId: 2e1dea17-21b4-4b25-ac8f-7cf2766f07eb redirect_from: - /docs/setting-up-a-custom-ssl-certificate - /docs/en/setting-up-a-custom-ssl-certificate + - /docs/cloud/dev/spryker-cloud-commerce-os/setting-up-a-custom-ssl-certificate.html --- -This document describes how to set up an SSL certificate (SSL) for a production environment. +This document describes how to set up an SSL certificate (SSL) for a production environment. -By default, all the domain names (domains) are provided with generic SSLs, which are managed automatically. For the production environment, you can set up a custom SSL certificate. +By default, all the domain names (domains) are provided with generic SSLs, which are managed automatically. For the production environment, you can set up a custom SSL certificate. {% info_block infoBox "Third-party DNS zone provider" %} @@ -36,27 +37,15 @@ To set up a custom SSL: * Certificate body * Certificate private key * Optional: Certificate chain - + {% info_block warningBox "Format" %} The values should be [PEM-encoded](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate-format.html). - -{% endinfo_block %} - -We set up the SSL shortly after you have provided it. - - -## Next step -[Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) - - - - - - - - +{% endinfo_block %} +We set up the SSL shortly after you have provided it. +## Next step +[Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/spryker-cloud-commerce-os-management.md b/docs/ca/dev/spryker-cloud-commerce-os-management.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/spryker-cloud-commerce-os-management.md rename to docs/ca/dev/spryker-cloud-commerce-os-management.md index bc285b08744..6a59b426007 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/spryker-cloud-commerce-os-management.md +++ b/docs/ca/dev/spryker-cloud-commerce-os-management.md @@ -3,6 +3,8 @@ title: Spryker Cloud Commerce OS management description: Assignment of responsibilities, consultation and reporting obligations. last_updated: Nov 21, 2022 template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/spryker-cloud-commerce-os-management.html --- This RACI Matrix defines responsibilities, consultation and reporting obligations while providing Platform-as-a-Service (PaaS) hosting for Spryker customers. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.md b/docs/ca/dev/starting-asynchronous-commands.md similarity index 88% rename from docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.md rename to docs/ca/dev/starting-asynchronous-commands.md index 619f351ad37..fa0ac5cb290 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.md +++ b/docs/ca/dev/starting-asynchronous-commands.md @@ -3,10 +3,10 @@ title: Starting asynchronous commands description: Learn how to run asynchronous commands last_updated: May 24, 2022 template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/starting-asynchronous-commands.html --- The Spryker architecture lets you run background asynchronous console commands as scheduled jobs in [Jenkins](/docs/scos/dev/back-end-development/console-commands/console-commands.html#jenkins-setup-commands). Jenkins is available as a Spryker Cloud service. For details about how to use it, see [Cronjobs](/docs/scos/dev/back-end-development/cronjobs/cronjobs.html). During the deployment, the scheduling of jobs is paused, and the jobs are terminated to roll out a new version. Therefore, long-lasting jobs should be tolerable to interruption and restart. - - diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.md b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.md similarity index 83% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.md rename to docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.md index 946e4e3d9db..8db804e87de 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.md @@ -4,6 +4,7 @@ description: Solution to absent assets, logs, or pipelines in the AWS Management template: troubleshooting-guide-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting-deployment/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html --- diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.md b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.md similarity index 78% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.md rename to docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.md index 774003a439d..5b79f9914a4 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.md @@ -5,6 +5,7 @@ template: troubleshooting-guide-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting-deployment/deployment-fails-due-to-a-failed-docker-authentication.html - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting-deployment/a-deployment-fails-due-to-a-failed-docker-authentication.html + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.html --- A deployment fails with the `Post https://auth.docker.io/token: EOF` error. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.md b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.md similarity index 85% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.md rename to docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.md index b8e3f2b040e..cb51526f0af 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.md @@ -4,6 +4,7 @@ description: This article describes how to troubleshoot the most common problems template: troubleshooting-guide-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting-deployment/jenkins-does-not-restart.html + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.html --- When deploying an application, Jenkins does not restart properly and the `Deploy_Scheduler` deployment step fails. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.md b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.md similarity index 51% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.md rename to docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.md index 1a45475ae04..0bea1a78d84 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.md @@ -5,12 +5,13 @@ template: concept-topic-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting.html - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting-deployment/troubleshooting-deployment.html + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.html --- This section contains solutions to common deployment issues. Browse the deployment troubleshooting: -* [Assets, logs, or pipelines are not visible in AWS Management](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html) -* [Deployment fails due to a failed Docker authentication](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.html) -* [Jenkins does not restart](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.html) +* [Assets, logs, or pipelines are not visible in AWS Management](/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html) +* [Deployment fails due to a failed Docker authentication](/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.html) +* [Jenkins does not restart](/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.md b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.md similarity index 84% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.md rename to docs/ca/dev/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.md index b8a4874bfd6..415f8188610 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.md @@ -4,6 +4,7 @@ description: Solution to a failed source branch change while saving pipeline set template: troubleshooting-guide-template redirect_from: - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting-deployment/changing-a-source-branch-fails.html + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.html --- diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.md b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.md similarity index 60% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.md rename to docs/ca/dev/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.md index eb0ca72ded5..46759bb297b 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.md @@ -2,6 +2,8 @@ title: Email address is not verified description: Solution to the error about unverified email addres. template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.html --- @@ -9,4 +11,4 @@ The `Email address is not verified` error is returned in the error log. ## Solution -Verify the related email address as described in [Verifying email addresses](/docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.html). +Verify the related email address as described in [Verifying email addresses](/docs/ca/dev/verify-email-addresses.html). diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.md b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.md similarity index 84% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.md rename to docs/ca/dev/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.md index 3ccd1927114..20f05c52cf0 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.md @@ -2,6 +2,8 @@ title: 'Fatal error: Allowed memory size of x bytes exhausted' description: Solution to the error about exhausted memory template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.html --- One of the following errors is returned in the error log: diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.md b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.md similarity index 69% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.md rename to docs/ca/dev/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.md index 3bc199ca261..b4c92d70f2e 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.md @@ -1,15 +1,17 @@ --- -title: Missing migration files on production environments +title: Missing migration files on production environments description: Troubleshoot issues you might encounter when you have your Spryker-based project in Cloud. Missing migration files on production environment last_updated: Jun 9, 2022 template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.html --- There are no tables in the DB after deploy. {% info_block warningBox "Note" %} -It is recommended to define a strategy for migrations at the start of the project. +It is recommended to define a strategy for migrations at the start of the project. We recommend to push all the migrations to a repository as a go-live preparation to make sure that all the migrations that are executed against production are also in the repositoriy to ease possible troubleshooting in the future. {% endinfo_block %} @@ -25,4 +27,4 @@ During the development you can keep your migrations ignored by a repositoriy to console propel:migration:delete ``` -Find more information about [deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html) or [customizing deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html) +Find more information about [deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html) or [customizing deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html) diff --git a/docs/ca/dev/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.md b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.md new file mode 100644 index 00000000000..5478c9ff82e --- /dev/null +++ b/docs/ca/dev/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.md @@ -0,0 +1,13 @@ +--- +title: Troubleshooting general issues +description: Solutions to common issues +template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.html +--- + + +* [Changing a source branch fails](/docs/ca/dev/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.html) +* [Email address is not verified](/docs/ca/dev/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.html) +* [Fatal error: Allowed memory size of x bytes exhausted](/docs/ca/dev/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.html) +* [Missing migration files on production environments](/docs/ca/dev/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.html) diff --git a/docs/ca/dev/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.md new file mode 100644 index 00000000000..a9a62deb5f3 --- /dev/null +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.md @@ -0,0 +1,21 @@ +--- +title: Troubleshooting tutorials +description: Learn how to troubleshoot common issues in Spryker Cloud Commerce OS +template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.html +--- + +The documents in this section explain how to troubleshoot common issues. You will learn what to check if an issue occurs and how to understand if an issue is related to the infrastructure or the application itself. + +To speed up the resolution of any issue, we encourage you to troubleshoot it using the provided tutorials. If you find an infrastructure related issue while troubleshooting, in your support ticket, provide all the information you collected. + +Browse the troubleshooting tutorials: +* [Tutorial — Troubleshooting a failed deployment](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.html) +* [Tutorial — Troubleshooting a killed process](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.html) +* [Tutorial — Troubleshooting an unavailable Zed](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.html) +* [Tutorial — Troubleshooting unavailable Yves or Glue](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.html) +* [Tutorial — Troubleshooting failing Yves authentication](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.html) +* [Tutorial — Troubleshooting Yves or Zed not restarting after deployment](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.html) +* [Tutorial — Troubleshooting 403 error](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html) +* [Tutorial — Troubleshooting failed Jenkins jobs](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.md index c4240efaf14..5ca02bc2ed0 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting 403 error description: Learn how to troubleshoot 403 error template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html --- A website functionality is not working properly, or there is a 403 status response code in the frontend logs. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.md similarity index 96% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.md index ee2c2bc27e3..259f41229bd 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting a failed deployment description: Learn how to troubleshoot a failed deployment template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.html --- A deployment fails, and there are no errors in the deploy or build output. Based on the step the deployment fails at, do the following: @@ -55,7 +57,7 @@ Check multiple log groups via Logs Insights as follows. Select the log groups co ![retry_run_pre-deploy_hook] 5. If the step fails, recheck the `PRE_BUILD State` by following steps 1 to 3. - If the state is `FAILED`, follow the steps in the later section. + If the state is `FAILED`, follow the steps in the later section. ### 2. Check the script of the step diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.md similarity index 82% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.md index e470807fdd1..df11a8ffd91 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting a killed process description: Learn how to troubleshoot a killed process template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.html --- One of the reasons for a process being killed is OOM Killer(Out of memory Killer). diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.md similarity index 95% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.md index f1376239cc2..fab7fa43fff 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting an unavailable Zed description: Learn how to troubleshoot an unavailable Zed template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.html --- Zed didn't restart after a deployment or you can't access it. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.md index 593a7adf24d..42a38f1d0d8 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting failed Jenkins jobs description: Learn how to troubleshoot Jenkins jobs issues template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.html --- A Jenkins job failed. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.md similarity index 84% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.md index 21c677d1589..0a929adc4d6 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting failing Yves authentication description: Learn what to do when Yves authentication fails template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.html --- Yves authentication fails for all customers. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.md similarity index 93% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.md index 6be13b3c755..0a863ddd817 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting unavailable Yves or Glue description: Learn how to troubleshoot unavailable Yves or Glue template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.html --- Yves or Glue didn't restart after a deployment or you can't access it. diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.md b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.md similarity index 79% rename from docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.md rename to docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.md index 24c76bb1987..e1f22b92ac3 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.md +++ b/docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.md @@ -2,6 +2,8 @@ title: Tutorial — Troubleshooting Yves or Zed not restarting after deployment description: Learn how to troubleshoot Yves or Zed not restarting after deployment template: troubleshooting-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.html --- Yves or Zed is not accessible after deployment or the deployment is failed. diff --git a/docs/ca/dev/troubleshooting/troubleshooting.md b/docs/ca/dev/troubleshooting/troubleshooting.md new file mode 100644 index 00000000000..28ca30f63a5 --- /dev/null +++ b/docs/ca/dev/troubleshooting/troubleshooting.md @@ -0,0 +1,15 @@ +--- +title: Troubleshooting tutorials +description: Learn how to troubleshoot common issues in Spryker Cloud Commerce OS +template: concept-topic-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting.html +--- + +This section contains solutions to common issues and troubleshooting tutorials. + +Browse the troubleshooting categories: + +* [Troubleshooting deployment](/docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.html) +* [Troubleshooting general issues](/docs/ca/dev/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.html) +* [Troubleshooting tutorials](/docs/ca/dev/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.md b/docs/ca/dev/verify-email-addresses.md similarity index 89% rename from docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.md rename to docs/ca/dev/verify-email-addresses.md index b1135a9f19e..87b01786052 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.md +++ b/docs/ca/dev/verify-email-addresses.md @@ -1,10 +1,12 @@ --- -title: Verifying email addresses +title: Verify email addresses description: Learn how to verify email addresses, so that your applications can send emails from them. template: howto-guide-template +redirect_from: + - /docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.html --- -For your applications to be able to send emails from an email address, you need to verify it. The verification is required to prevent spam from being sent from staging environments. +For your applications to be able to send emails from an email address, you need to verify it. The verification is required to prevent spam from being sent from staging environments. To verify an email address: diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.md b/docs/ca/dev/working-with-logs.md similarity index 92% rename from docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.md rename to docs/ca/dev/working-with-logs.md index fc9522f0349..0951191ff74 100644 --- a/docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.md +++ b/docs/ca/dev/working-with-logs.md @@ -7,6 +7,7 @@ originalArticleId: bf2fcf27-ef7f-4ff5-b491-850d20b73a1e redirect_from: - /docs/working-with-logs - /docs/en/working-with-logs + - /docs/cloud/dev/spryker-cloud-commerce-os/working-with-logs.html --- This document describes how to work with logs(events). Logs provide information about the state of application and related services. In Spryker Cloud Commerce OS, logging is maintained by [Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). @@ -41,4 +42,4 @@ To search in logs: ## Next step -[Preparation for going live](/docs/cloud/dev/spryker-cloud-commerce-os/preparation-for-going-live.html) +[Preparation for going live](/docs/ca/dev/preparation-for-going-live.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configure-deployment-pipelines.md b/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configure-deployment-pipelines.md deleted file mode 100644 index 4e74aa0f940..00000000000 --- a/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configure-deployment-pipelines.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Configure deployment pipelines -last_updated: Jan 16, 2023 -description: Explains how to customize and configure deployment pipelines in Spryker Cloud Commerce OS (SCCOS) -template: concept-topic-template ---- - -This section explains how to customize and configure deployment pipelines in Spryker Cloud Commerce OS (SCCOS): - -* [Deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html) -* [Deployment in states](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-in-states.html) -* [Customizing deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html) -* [Configuring Azure Pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.html) -* [Configuring GitHub Actions](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.html) -* [Configuring GitLab pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.html) -* [Configuring Bitbucket Pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/security/security.md b/docs/cloud/dev/spryker-cloud-commerce-os/security/security.md deleted file mode 100644 index a0b03c2b8d6..00000000000 --- a/docs/cloud/dev/spryker-cloud-commerce-os/security/security.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Security -last_updated: Jan 16, 2023 -description: Explains how to check ECR image scan results and generate access keys, and introduces the web application firewall -template: concept-topic-template ---- - -This section explains how to check ECR image scan results and generate access keys, and introduces the web application firewall: - -* [Checking ECR image scan results](/docs/cloud/dev/spryker-cloud-commerce-os/security/checking-ecr-image-scan-results.html) -* [Generating access keys](/docs/cloud/dev/spryker-cloud-commerce-os/security/generating-access-keys.html) -* [Web Application Firewall (WAF)](/docs/cloud/dev/spryker-cloud-commerce-os/security/web-application-firewall-waf.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.md b/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.md deleted file mode 100644 index 35c62ed16e0..00000000000 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Troubleshooting general issues -description: Solutions to common issues -template: concept-topic-template ---- - - -* [Changing a source branch fails](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.html) -* [Email address is not verified](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.html) -* [Fatal error: Allowed memory size of x bytes exhausted](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.html) -* [Missing migration files on production environments](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.md b/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.md deleted file mode 100644 index 8ca3b0627cb..00000000000 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Troubleshooting tutorials -description: Learn how to troubleshoot common issues in Spryker Cloud Commerce OS -template: concept-topic-template ---- - -The documents in this section explain how to troubleshoot common issues. You will learn what to check if an issue occurs and how to understand if an issue is related to the infrastructure or the application itself. - -To speed up the resolution of any issue, we encourage you to troubleshoot it using the provided tutorials. If you find an infrastructure related issue while troubleshooting, in your support ticket, provide all the information you collected. - -Browse the troubleshooting tutorials: -* [Tutorial — Troubleshooting a failed deployment](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.html) -* [Tutorial — Troubleshooting a killed process](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.html) -* [Tutorial — Troubleshooting an unavailable Zed](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.html) -* [Tutorial — Troubleshooting unavailable Yves or Glue](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.html) -* [Tutorial — Troubleshooting failing Yves authentication](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.html) -* [Tutorial — Troubleshooting Yves or Zed not restarting after deployment](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.html) -* [Tutorial — Troubleshooting 403 error](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html) -* [Tutorial — Troubleshooting failed Jenkins jobs](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.html) diff --git a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting.md b/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting.md deleted file mode 100644 index f65b7565386..00000000000 --- a/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Troubleshooting tutorials -description: Learn how to troubleshoot common issues in Spryker Cloud Commerce OS -template: concept-topic-template ---- - -This section contains solutions to common issues and troubleshooting tutorials. - -Browse the troubleshooting categories: - -* [Troubleshooting deployment](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.html) -* [Troubleshooting general issues](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.html) -* [Troubleshooting tutorials](/docs/cloud/dev/spryker-cloud-commerce-os/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.html) diff --git a/docs/pbc/all/dynamic-multistore/202307.0/base-shop/delete-stores.md b/docs/pbc/all/dynamic-multistore/202307.0/base-shop/delete-stores.md index 1b566f18ae5..87e6cf40bf8 100644 --- a/docs/pbc/all/dynamic-multistore/202307.0/base-shop/delete-stores.md +++ b/docs/pbc/all/dynamic-multistore/202307.0/base-shop/delete-stores.md @@ -35,7 +35,7 @@ On the technical side, removing a store helps with the following: ## Back up the database -Back up the store's database and make sure it's recoverable. For instructions, see [Create and restore database backups](/docs/cloud/dev/spryker-cloud-commerce-os/create-and-restore-database-backups.html). +Back up the store's database and make sure it's recoverable. For instructions, see [Create and restore database backups](/docs/ca/dev/create-and-restore-database-backups.html). ## Suspend Publish and Sync @@ -44,7 +44,7 @@ Back up the store's database and make sure it's recoverable. For instructions, s vendor/bin/console maintenance:enable ``` -For more information about maintenance mode, see [Enable and disable maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.html). +For more information about maintenance mode, see [Enable and disable maintenance mode](/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html). 2. Check the number of messaged in RabbitMQ. If there are too many, wait for them to be processed. diff --git a/docs/scos/dev/developer-getting-started-guide.md b/docs/scos/dev/developer-getting-started-guide.md index c4a19d81d9c..4f0dc278e54 100644 --- a/docs/scos/dev/developer-getting-started-guide.md +++ b/docs/scos/dev/developer-getting-started-guide.md @@ -142,12 +142,12 @@ For those stores that you wish to allow, don’t forget to edit `CodeBucketConfi ## 4. Configure CI Continuous Integration (CI) is a development practice where each part of the code can be verified by an automated build and automated tests. This allows for good code quality and that each new feature does not break the existing functionality. The following documents will help you to enable CI in different repositories: -* [Deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.html) -* [Customizing deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.html) -* [GitHub Actions](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-github-actions.html) -* [Configuring GitLab pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-gitlab-pipelines.html) -* [Azure Pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-azure-pipelines.html) -* [Configuring Bitbucket Pipelines ](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/configuring-bitbucket-pipelines.html) +* [Deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.html) +* [Customizing deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.html) +* [GitHub Actions](/docs/ca/dev/configure-deployment-pipelines/configure-github-actions.html) +* [Configuring GitLab pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.html) +* [Azure Pipelines](/docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.html) +* [Configuring Bitbucket Pipelines ](/docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.html) ## 5. Configure checkers diff --git a/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md b/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md index 4fd62b93c30..14b72941310 100644 --- a/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md +++ b/docs/scos/dev/guidelines/performance-guidelines/architecture-performance-guidelines.md @@ -208,7 +208,7 @@ Make sure to check the following articles on how to optimize the performance of - [Performance guidelines](/docs/scos/dev/guidelines/performance-guidelines.html) - [Data importer speed optimization](/docs/scos/dev/data-import/{{site.version}}/data-importer-speed-optimization.html) - [Integrating multi-queue publish structure](/docs/scos/dev/technical-enhancement-integration-guides/integrating-multi-queue-publish-structure.html) -- [Performance testing in staging environments](/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing.html) +- [Performance testing in staging environments](/docs/ca/dev/performance-testing-in-staging-enivronments.html) ## Application performance and load tests diff --git a/docs/scos/dev/guidelines/security-guidelines.md b/docs/scos/dev/guidelines/security-guidelines.md index 825a6212a07..2fb7afefd5b 100644 --- a/docs/scos/dev/guidelines/security-guidelines.md +++ b/docs/scos/dev/guidelines/security-guidelines.md @@ -25,7 +25,7 @@ related: link: docs/scos/dev/guidelines/project-development-guidelines.html --- -This document describes the data security guidelines you need to implement on the application level. Infrastructure security measures are not described, because they are implemented by default in [SCCOS](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html) and PaaS environments. +This document describes the data security guidelines you need to implement on the application level. Infrastructure security measures are not described, because they are implemented by default cloud environments. ## Passwords @@ -33,7 +33,7 @@ The most important about password security is to not save it in plain text. Ther ## Secrets -Store a secret in a secrets management system. See [Add variables in the Parameter Store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html) for more information about secrets and parameters. +Store a secret in a secrets management system. See [Add variables in the Parameter Store](/docs/ca/dev/add-variables-in-the-parameter-store.html) for more information about secrets and parameters. ## Encrypted communication @@ -61,7 +61,7 @@ The sections below detail configure places for various security headers. You can ### X-Content-Type-Options, X-Frame-Options, X-XSS-Protection, Content-Security-Policy #### Yves -For Yves set of default security headers in: `\Spryker\Yves\Application\ApplicationConfig::getSecurityHeaders()`. +For Yves set of default security headers in: `\Spryker\Yves\Application\ApplicationConfig::getSecurityHeaders()`. Default values: @@ -126,9 +126,9 @@ Content-Security-Policy: frame-ancestors 'self' #### Cache-Control header -You can enable custom Cache-Control header for the Storefront, Back Office, and Glue using plugins: -* `Spryker\Zed\Http\Communication\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Zed `\Pyz\Zed\EventDispatcher::getEventDispatcherPlugins()` -and configure using: `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_CONFIG`. +You can enable custom Cache-Control header for the Storefront, Back Office, and Glue using plugins: +* `Spryker\Zed\Http\Communication\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Zed `\Pyz\Zed\EventDispatcher::getEventDispatcherPlugins()` +and configure using: `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::ZED_HTTP_CACHE_CONTROL_CONFIG`. * `Spryker\Yves\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Yves `\Pyz\Yves\EventDispatcher::getEventDispatcherPlugins()` and configure using: `Spryker\Shared\Http\HttpConstants::YVES_HTTP_CACHE_CONTROL_ENABLED`, `Spryker\Shared\Http\HttpConstants::YVES_HTTP_CACHE_CONTROL_CONFIG`. * `Spryker\Glue\Http\Plugin\EventDispatcher\CacheControlHeaderEventDispatcherPlugin` plugin can be added into application specific method for Glue `\Pyz\Glue\EventDispatcher::getEventDispatcherPlugins()` diff --git a/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md b/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md index f6a2cfc0e81..69b79c6014b 100644 --- a/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/integrate-multi-database-logic.md @@ -11,7 +11,7 @@ This document describes how to switch from using a shared database to dedicated Update the Docker SDK to [version 1.48.0](https://github.com/spryker/docker-sdk/releases/tag/1.48.0) or higher. -For cloud environments, make sure your project supports a [separated setup](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multi-store-setups.html#separated-setup). +For cloud environments, make sure your project supports a [separated setup](/docs/ca/dev/multi-store-setups/multi-store-setups.html#separated-setup). ## Define databases diff --git a/docs/scos/dev/the-docker-sdk/202204.0/configure-services.md b/docs/scos/dev/the-docker-sdk/202204.0/configure-services.md index 03fe52093c1..034d05f505e 100644 --- a/docs/scos/dev/the-docker-sdk/202204.0/configure-services.md +++ b/docs/scos/dev/the-docker-sdk/202204.0/configure-services.md @@ -486,8 +486,8 @@ image: 2. Push and deploy the changes using one of the following guides: - * [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) - * [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) + * [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) + * [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) diff --git a/docs/scos/dev/the-docker-sdk/202204.0/installation-recipes-of-deployment-pipelines.md b/docs/scos/dev/the-docker-sdk/202204.0/installation-recipes-of-deployment-pipelines.md index b840666bc0b..7ed78df8463 100644 --- a/docs/scos/dev/the-docker-sdk/202204.0/installation-recipes-of-deployment-pipelines.md +++ b/docs/scos/dev/the-docker-sdk/202204.0/installation-recipes-of-deployment-pipelines.md @@ -5,7 +5,7 @@ last_updated: Nov 29, 2022 template: howto-guide-template --- -Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): +Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): ``` config @@ -102,13 +102,13 @@ For examples, see [b2c-demo-shop](https://github.com/spryker-shop/b2c-demo-shop/ ## Staging and Production environment recipes -For [Staging and Production](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: +For [Staging and Production](/docs/ca/dev/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: - destructive.yml - pre-deploy.yml - production.yml -You can use them as a hook definition when [customizing pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): +You can use them as a hook definition when [customizing pipelines](/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): ```shell image: diff --git a/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md b/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md index 4953e31903f..c953d10e68e 100644 --- a/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md +++ b/docs/scos/dev/the-docker-sdk/202212.0/configure-services.md @@ -492,8 +492,8 @@ image: 2. Push and deploy the changes using one of the following guides: - * [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) - * [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) + * [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) + * [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) diff --git a/docs/scos/dev/the-docker-sdk/202212.0/installation-recipes-of-deployment-pipelines.md b/docs/scos/dev/the-docker-sdk/202212.0/installation-recipes-of-deployment-pipelines.md index b840666bc0b..7ed78df8463 100644 --- a/docs/scos/dev/the-docker-sdk/202212.0/installation-recipes-of-deployment-pipelines.md +++ b/docs/scos/dev/the-docker-sdk/202212.0/installation-recipes-of-deployment-pipelines.md @@ -5,7 +5,7 @@ last_updated: Nov 29, 2022 template: howto-guide-template --- -Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): +Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): ``` config @@ -102,13 +102,13 @@ For examples, see [b2c-demo-shop](https://github.com/spryker-shop/b2c-demo-shop/ ## Staging and Production environment recipes -For [Staging and Production](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: +For [Staging and Production](/docs/ca/dev/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: - destructive.yml - pre-deploy.yml - production.yml -You can use them as a hook definition when [customizing pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): +You can use them as a hook definition when [customizing pipelines](/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): ```shell image: diff --git a/docs/scos/dev/the-docker-sdk/202307.0/configure-services.md b/docs/scos/dev/the-docker-sdk/202307.0/configure-services.md index 75e8d86708c..74fbee70683 100644 --- a/docs/scos/dev/the-docker-sdk/202307.0/configure-services.md +++ b/docs/scos/dev/the-docker-sdk/202307.0/configure-services.md @@ -490,8 +490,8 @@ image: 2. Push and deploy the changes using one of the following guides: - * [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) - * [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) + * [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) + * [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) diff --git a/docs/scos/dev/the-docker-sdk/202307.0/installation-recipes-of-deployment-pipelines.md b/docs/scos/dev/the-docker-sdk/202307.0/installation-recipes-of-deployment-pipelines.md index b840666bc0b..7ed78df8463 100644 --- a/docs/scos/dev/the-docker-sdk/202307.0/installation-recipes-of-deployment-pipelines.md +++ b/docs/scos/dev/the-docker-sdk/202307.0/installation-recipes-of-deployment-pipelines.md @@ -5,7 +5,7 @@ last_updated: Nov 29, 2022 template: howto-guide-template --- -Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): +Installation recipes contain the commands that are ran during the [install stage of deployment pipelines](/docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html#install-stage). The recipes are located in `config/install/`. For example, this is how they look in the [B2C Demo Shop](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install): ``` config @@ -102,13 +102,13 @@ For examples, see [b2c-demo-shop](https://github.com/spryker-shop/b2c-demo-shop/ ## Staging and Production environment recipes -For [Staging and Production](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: +For [Staging and Production](/docs/ca/dev/environments-overview.html) environments, there are [dedicated installation recipes](https://github.com/spryker-shop/b2c-demo-shop/tree/master/config/install/EU) with custom sections: - destructive.yml - pre-deploy.yml - production.yml -You can use them as a hook definition when [customizing pipelines](/docs/cloud/dev/spryker-cloud-commerce-os/configure-deployment-pipelines/customizing-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): +You can use them as a hook definition when [customizing pipelines](/docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html#adding-a-single-command-to-a-deployment-pipeline): ```shell image: diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-debug-payment-integrations-locally.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-debug-payment-integrations-locally.md index dc6c4a9db1f..55a22621c7f 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-debug-payment-integrations-locally.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-debug-payment-integrations-locally.md @@ -5,7 +5,7 @@ past_updated: Jul 27, 2022 template: howto-guide-template --- -Unlike [PaaS](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html) environments, local development environments let you debug your application using your IDE. This document shows how to debug most payment integrations locally to ensure that your integration works before deploying it. +Unlike [PaaS](/docs/ca/dev/getting-started-with-cloud-administration.html) environments, local development environments let you debug your application using your IDE. This document shows how to debug most payment integrations locally to ensure that your integration works before deploying it. Most payment integrations rely on a push notification to send feedback to requests made by your application. Normally, these push notifications would never reach your local development environment because the payment provider would not be able to resolve its DNS name. You can use tools like NGROK to set up a publicly available reverse proxy that gives you a publicly reachable URL that you can add to the configuration on your payment provider’s management console. ## Prerequisites diff --git a/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.md b/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.md index 25f2b23bf49..2aa8d608068 100644 --- a/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.md +++ b/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.md @@ -29,7 +29,7 @@ With the Spryker Commerce OS, you can create multiple stores per your business r * Define separate search preferences to create an entirely different set of rankings, rules, and settings per store—for example, a date format or a currency. * Set up a default store. -For details on all the multi-store infrastructure options, see [Multistore setup options](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html). +For details on all the multi-store infrastructure options, see [Multistore setup options](/docs/ca/dev/multi-store-setups/multistore-setup-options.html). ## Set up multiple stores @@ -189,7 +189,7 @@ Also, make sure that commands that need to trigger for each store have stores: ` ## Configure the deploy file -According to the desired infrastructure setup, configure the deploy file for the multi-store setup. In the following example, we configure the [multi-store setup 1](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html#setup-1-shared-infrastructure-resources-default): database, search engine, and key-value storage are shared: +According to the desired infrastructure setup, configure the deploy file for the multi-store setup. In the following example, we configure the [multi-store setup 1](/docs/ca/dev/multi-store-setups/multistore-setup-options.html#setup-1-shared-infrastructure-resources-default): database, search engine, and key-value storage are shared: Deploy file configuration for the multi-store setup 1: @@ -252,7 +252,7 @@ Defining stores by headers is not supported by default, but you can use the foll {% info_block infoBox %} -The workaround is only supported by the [multi-store store setup 1](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html#setup-1-shared-infrastructure-resources-default) when all the resources are shared. With the other setup, you need to manage the infrastructure configuration on the application level. +The workaround is only supported by the [multi-store store setup 1](/docs/ca/dev/multi-store-setups/multistore-setup-options.html#setup-1-shared-infrastructure-resources-default) when all the resources are shared. With the other setup, you need to manage the infrastructure configuration on the application level. **public/Glue/index.php** ```php diff --git a/docs/scos/user/intro-to-spryker/docs-release-notes.md b/docs/scos/user/intro-to-spryker/docs-release-notes.md index ef47372f9b3..b65f8592629 100644 --- a/docs/scos/user/intro-to-spryker/docs-release-notes.md +++ b/docs/scos/user/intro-to-spryker/docs-release-notes.md @@ -76,9 +76,9 @@ In August 2023, we have added and updated the following pages: - [Shipment + Service Points feature integration guide](/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-service-points-feature.html). - [Product Rating and Reviews feature integration guide](/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-feature.html). - [Shipment feature integration guide](/docs/pbc/all/carrier-management/202400.0/base-shop/install-and-upgrade/install-features/install-the-shipment-feature.html). -- [Best practises: Jenkins stability](/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html): Learn how to improve the stability of the scheduler component.. +- [Best practises: Jenkins stability](/docs/ca/dev/best-practices/best-practises-jenkins-stability.html): Learn how to improve the stability of the scheduler component.. - [Decoupled Glue infrastructure: Integrate the authentication](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-authentication.html): Learn how to create an authentication token for the Storefront and Backend API applications in your project. -- [Add variables in the Parameter Store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html):Learn how to define variables in the Parameter Store. +- [Add variables in the Parameter Store](/docs/ca/dev/add-variables-in-the-parameter-store.html):Learn how to define variables in the Parameter Store. For more details about these and other updates to the Spryker docs in August 2023, refer to the [docs release notes page on GitHub](https://github.com/spryker/spryker-docs/releases). @@ -89,7 +89,7 @@ In July 2023, we have added and updated the following pages: ### New pages - [Oryx: Color system](/docs/scos/dev/front-end-development/202212.0/oryx/building-applications/styling/oryx-color-system.html): Documentation on colors in Oryx. -- [Best practises: Jenkins stability](/docs/cloud/dev/spryker-cloud-commerce-os/best-practices/best-practises-jenkins-stability.html): Best practices for maintaining Jenkins stability. +- [Best practises: Jenkins stability](/docs/ca/dev/best-practices/best-practises-jenkins-stability.html): Best practices for maintaining Jenkins stability. - [HowTo: Reduce Jenkins execution by up to 80% without P&S and Data importers refactoring](/docs/scos/dev/tutorials-and-howtos/howtos/howto-reduce-jenkins-execution-costs-without-refactoring.html): Save Jenkins-related costs or speed up background jobs processing by implementing a single custom Worker for all stores. - [Release notes 202307.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.html): Release notes for the Spryker SCOS release 202307.0 - [Install the Product Rating and Reviews Glue API](/docs/pbc/all/ratings-reviews/202307.0/install-and-upgrade/install-the-product-rating-and-reviews-glue-api.html): This document describes how to integrate the [Product Rating and Reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/ratings-and-reviews.html) Glue API feature into a Spryker project. @@ -103,7 +103,7 @@ In July 2023, we have added and updated the following pages: ### Updated pages - [Integrate Usercentrics](/docs/pbc/all/usercentrics/integrate-usercentrics.html): Find out how you can integrate Usercentrics in your Spryker shop. - [Usercentrics](/docs/pbc/all/usercentrics/usercentrics.html): [Usercentrics](https://usercentrics.com/) is the Consent Management Platform (CMP) that lets you obtain and manage the consent of your users to use cookies across your store. -- [Adding variables in the parameter store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html): Added reserved variable sub-section and removed deprecated text. +- [Adding variables in the parameter store](/docs/ca/dev/add-variables-in-the-parameter-store.html): Added reserved variable sub-section and removed deprecated text. - [Security Release Notes 202306.0](/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202306.0/security-release-notes-202306.0.html): Added missing security HTTP headers. - [Merchant Users Overview](/docs/pbc/all/merchant-management/202212.0/marketplace/marketplace-merchant-feature-overview/merchant-users-overview.html): Added information about the assignment of groups for the merchant user. - [Handle data with Publish and Synchronization](/docs/scos/dev/back-end-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.html): Publish and Synchronization (P&S) lets you export data from Spryker backend (Zed) to external endpoints. @@ -144,7 +144,7 @@ In June 2023, we have added and updated the following pages: ## Updated pages - [Shipment feature integration guide](/docs/pbc/all/carrier-management/202400.0/unified-commerce/install-and-upgrade/install-the-shipment-feature.html). -- [Environments overview](/docs/cloud/dev/spryker-cloud-commerce-os/environments-overview.html). +- [Environments overview](/docs/ca/dev/environments-overview.html). - [Spryker Core Back Office + Warehouse User Management feature integration guide](/docs/pbc/all/back-office/202400.0/unified-commerce/install-and-upgrade/install-the-spryker-core-back-office-warehouse-user-management-feature.html). - [Warehouse User Management feature integration guide](/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-user-management-feature.html). - [Warehouse picking feature integration guide](/docs/pbc/all/warehouse-picking/202400.0/unified-commerce/install-and-upgrade/install-the-warehouse-picking-feature.html). @@ -172,8 +172,8 @@ In May 2023, we have added and updated the following pages: - [Docs release notes](/docs/scos/user/intro-to-spryker/docs-release-notes.html) - Multistore documentation: - - [Multistore setup options](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/multistore-setup-options.html): Learn about all the setup options you have for a multi-store environment. - - [Checklist for a new store implementation](/docs/cloud/dev/spryker-cloud-commerce-os/multi-store-setups/checklist-for-a-new-store-implementation.html): Overview of the high-level tasks and responsibilities of Spryker and Customer when setting up a new store. + - [Multistore setup options](/docs/ca/dev/multi-store-setups/multistore-setup-options.html): Learn about all the setup options you have for a multi-store environment. + - [Checklist for a new store implementation](/docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.html): Overview of the high-level tasks and responsibilities of Spryker and Customer when setting up a new store. - [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html): Learn how to install the App Orchestration Platform. - [Run the evaluator tool](/docs/scos/dev/guidelines/keeping-a-project-upgradable/run-the-evaluator-tool.html): Learn how to run the evaluator tool. - [Upgradability guidelines](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/upgradability-guidelines.html): @@ -187,7 +187,7 @@ In May 2023, we have added and updated the following pages: - [Single plugin argument](/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html): Resolve issues related to single plugin arguments inside the dependency provider’s methods. - [HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.12.0 and earlier](/docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.12.0-and-earlier.html) - [HowTo: Allow Zed SCSS/JS on a project level for `oryx-for-zed` version 2.13.0 and later](/docs/scos/dev/tutorials-and-howtos/howtos/howto-allow-zed-css-js-on-a-project-for-oryx-for-zed-2.13.0-and-later.html) -- [Add variables in the Parameter Store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html) +- [Add variables in the Parameter Store](/docs/ca/dev/add-variables-in-the-parameter-store.html) - [Change default branch](/docs/scu/dev/change-default-branch.html): Learn how to change the default branch in Spryker CI - [Oryx](/docs/scos/dev/front-end-development/202212.0/oryx/oryx.html) documentation: - [Set up Oryx](/docs/scos/dev/front-end-development/202212.0/oryx/getting-started/set-up-oryx.html): Learn how to set up an environment for developing in the Oryx framework. @@ -219,9 +219,9 @@ In May 2023, we have added and updated the following pages: - [HowTo: Set up multiple stores](/docs/scos/dev/tutorials-and-howtos/howtos/howto-set-up-multiple-stores.html): Learn how to set up multiple stores. - [App manifest](/docs/acp/user/app-manifest.html): Learn about the app manifest files and what necessary information they must contain - [Spryker Code Upgrader](/docs/scu/dev/spryker-code-upgrader.html): Learn how to use the Spryker Code Upgrader to update your project easily. -- [Performance testing in staging environments](/docs/cloud/dev/spryker-cloud-commerce-os/performance-testing-in-staging-enivronments.html): Our tips on executing the performance testing. +- [Performance testing in staging environments](/docs/ca/dev/performance-testing-in-staging-enivronments.html): Our tips on executing the performance testing. - [Configuring debugging in Docker](/docs/scos/dev/the-docker-sdk/202212.0/configuring-debugging-in-docker.html): Learn how to configure debugging in Docker. -- [Environment provisioning](/docs/cloud/dev/spryker-cloud-commerce-os/environment-provisioning.html): Learn how you can submit an environment provisioning request. +- [Environment provisioning](/docs/ca/dev/environment-provisioning.html): Learn how you can submit an environment provisioning request. - [Configure Algolia](/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia/configure-algolia.html): Learn how to configure the Algolia app. - [Integrate Algolia](/docs/pbc/all/search/202212.0/base-shop/third-party-integrations/algolia/integrate-algolia.html): Learn how to integrate the Algolia app. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202204.0/release-notes-202204.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202204.0/release-notes-202204.0.md index 47ef5ff62cc..cfe3b38a361 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202204.0/release-notes-202204.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202204.0/release-notes-202204.0.md @@ -8,7 +8,6 @@ redirect_from: --- The Spryker Commerce OS is an end-to-end solution for digital commerce. This document contains a business-level description of new features and enhancements. -For information about installing the Spryker Commerce OS, see [Getting started guide](/docs/scos/dev/developer-getting-started-guide.html). ## Spryker Commerce OS diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.md index d481c711ac3..1f44722e130 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202211.0/release-notes-202211.0.md @@ -8,7 +8,6 @@ redirect_from: --- The Spryker Commerce OS is an end-to-end solution for digital commerce. This document contains a business-level description of new features and enhancements. -For information about installing the Spryker Commerce OS, see [Getting started guide](/docs/scos/dev/developer-getting-started-guide.html). ## PHP 8.0 is the minimum version for all Spryker projects With 202211.0, Spryker released a new version of its Demo Shops requiring PHP 8.0 as their minimum PHP version. PHP 7.4 will no longer be supported. Spryker's new module releases will only be compatible with PHP version 8.0 or later. diff --git a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.md b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.md index 6acf2e17777..29043c43660 100644 --- a/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.md +++ b/docs/scos/user/intro-to-spryker/releases/release-notes/release-notes-202307.0/release-notes-202307.0.md @@ -208,8 +208,8 @@ Turn on and off the maintenance mode of an application using a dedicated pipelin #### Documentation -* [Enable and disable maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/enable-and-disable-maintenance-mode.html) -* [Configure access to applications in maintenance mode](/docs/cloud/dev/spryker-cloud-commerce-os/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html) +* [Enable and disable maintenance mode](/docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html) +* [Configure access to applications in maintenance mode](/docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html) ### [Cloud Self-Service] Environment variables management ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) @@ -219,7 +219,7 @@ Manage environment variables and secrets of applications using a UI without havi #### Documentation -[Add variables in the Parameter Store](/docs/cloud/dev/spryker-cloud-commerce-os/add-variables-in-the-parameter-store.html) +[Add variables in the Parameter Store](/docs/ca/dev/add-variables-in-the-parameter-store.html) ### [Cloud Observability] Infrastructure Health Check Monitoring Dashboard ![feature](https://spryker.s3.eu-central-1.amazonaws.com/docs/scos/user/intro-to-spryker/releases/release-notes/feature.png) diff --git a/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md b/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md index 1b5a2031976..ca385a6ec33 100644 --- a/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md +++ b/docs/scu/dev/onboard-to-spryker-code-upgrader/prepare-a-project-for-spryker-code-upgrader.md @@ -29,7 +29,7 @@ Currently, the Upgrader supports GitHub, GitLab and Azure. If you want to use a ## Migrate to Spryker Cloud Commerce OS -The Upgrader supports only projects that run on [Spryker Cloud Commerce OS (SCCOS)](/docs/cloud/dev/spryker-cloud-commerce-os/getting-started-with-the-spryker-cloud-commerce-os.html). If you are running Spryker on premises, migrate to SCCOS. +The Upgrader supports only projects that run in [cloud environments](/docs/ca/dev/getting-started-with-cloud-administration.html). If you are running Spryker on premises, migrate to cloud. ## Minimum technical requirements diff --git a/docs/scu/dev/roll-back-upgrades.md b/docs/scu/dev/roll-back-upgrades.md index 4761388b598..749ebc252ba 100644 --- a/docs/scu/dev/roll-back-upgrades.md +++ b/docs/scu/dev/roll-back-upgrades.md @@ -8,8 +8,8 @@ redirect_from: To roll back an upgrade, you need to deploy the previous version of the application using the regular deploy process. For instructions, see one of the following documents: -* [Deploying in a staging environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-staging-environment.html) -* [Deploying in a production environment](/docs/cloud/dev/spryker-cloud-commerce-os/deploying-in-a-production-environment.html) +* [Deploying in a staging environment](/docs/ca/dev/deploy-in-a-staging-environment.html) +* [Deploying in a production environment](/docs/ca/dev/deploy-in-a-production-environment.html) ## Other deployment pipelines