Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Email service section #2399

Merged
merged 3 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions _data/sidebars/ca_dev_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ entries:
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: Set up DNS
url: /docs/ca/dev/set-up-dns.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
Expand Down Expand Up @@ -92,8 +94,13 @@ entries:
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: Email service
url: /docs/ca/dev/email-service/email-service.html
nested:
- title: Email quota restrictions
url: /docs/ca/dev/email-service/email-quota-restrictions.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
Expand Down
18 changes: 18 additions & 0 deletions docs/ca/dev/email-service/email-quota-restrictions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Email quota restrictions
description: Amazon Simple Email Service has specific quota restrictions
last_updated: Dec 15, 2023
template: concept-topic-template
---

SCCOS production email service has the following quotas:
* Daily sending limit: 50.000 emails.
* Sending limit messages per second: 14.

SCCOS non-production email service has the following quotas:
* Daily sending limit: 200 emails.
* Sending limit messages per second: 1

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 quotas are insufficient to support your use case.
11 changes: 11 additions & 0 deletions docs/ca/dev/email-service/email-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Email service
description: SCCOS is shipped with Amazon Simple Email Service
last_updated: Dec 15, 2023
template: concept-topic-template
---

There is the native mail service included with Spryker Cloud Commerce OS - [Amazon Simple Email Service](https://console.aws.amazon.com/ses/). You can use it as is or integrate a third-party service. If you choose to use it, keep the following in mind:

- To send emails from an email address, verification is required. For details, see [Verify email addresses](/docs/ca/dev/email-service/verify-email-addresses.html).
- Emails are subject to quota restrictions. For details, see [Email quota restrictions](/docs/ca/dev/email-service/email-quota-restrictions.html).
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: Learn how to verify email addresses, so that your applications can
template: howto-guide-template
redirect_from:
- /docs/cloud/dev/spryker-cloud-commerce-os/verifying-email-addresses.html
- /docs/ca/dev/verify-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.
Expand Down
40 changes: 2 additions & 38 deletions docs/ca/dev/preparation-for-going-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,48 +82,12 @@ Four weeks before your project goes live, ensure you addressed all the items fro
- *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 don't want to delegate your DNS, request the verification of DNS records by the [Support Portal](https://support.spryker.com). If you don't 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).
- *The DNS names and strategy for your shop are clear*. You know how users are going to access your shop. Verify that you control access to the DNS to be able to manage DNS. For example, you want to use `spryker.com` as the domain for your shop, but you want a user to access the Storefront by the `www.spryker.com` subdomain.
- *Decide how email sending should be handled*. If you want to send emails using Spryker, decide whether you want to use the native mail service shipped with Spryker Cloud Commerce OS or integrate a third-party one. If you want to use the native one, let us know the email address that you want to send emails from. We will lift sending restrictions and help you validate the needed DNS name.

{% info_block warningBox "Email quota restrictions" %}

SCCOS production email service has the following quotas:
* Daily sending limit: 50.000 emails.
* Sending limit messages per second: 14.

SCCOS non-production email service has the following quotas:
* Daily sending limit: 200 emails.
* Sending limit messages per second: 1

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 quotas are insufficient to support your use case.

{% endinfo_block %}

- *Decide how email sending should be handled*. If you want to send emails using Spryker, decide whether you want to use the native mail service shipped with Spryker Cloud Commerce OS or integrate a third-party one. If you want to use the native one, let us know the email address that you want to send emails from. We will lift sending restrictions and help you validate the needed DNS name. See [Email service](/docs/ca/dev/email-service/email-service.html) for more information about the default email service and its restrictions.
- 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

You normally add a CNAME record in your DNS Management for the domains you want to use for your application. This CNAME corresponds to the DNS name of the load balancer of your environment to make your application accessible to the outside world. You can get the load balancer information from our support team. Generally, the DNS setup has these steps:
- You add the endpoint you want to use in the appropriate `deploy.yml` file and send it to us using a support case, mentioning that you have added a new endpoint that you want to set up for DNS configuration.
- We terraform this endpoint and send you back DNS entries for TLS verification (so that we can issue TLS certificates for your site).
- You set these entries in your DNS management and let us know when you are done.
- Terraforming can then be completed, and you receive the CNAME DNS records that you can then set in your DNS management to point your DNS names to the newly created endpoints.
- After this is completed, your application becomes accessible through the new endpoints.

{% info_block infoBox "Info" %}

This process can take a full week to complete due to DNS propagation and the terraform work that needs to be done. To avoid double work, ensure the endpoint selection is final and tested.

{% endinfo_block %}

To use a root domain for your application (for example, spryker.com), use an IP address instead of the load balancer DNS name, as this is required for an ARECORD. In this case, let our team know so they can provide you with an IP instead of the load balancer address. Do not set load balancer IP addresses as an ARECORD. The IP addresses are subject to rotation.

{% info_block infoBox "Info" %}

We do not normally support full delegation of your DNS to us and, therefore, do not suggest that you change your domain’s NS records to ours.

{% endinfo_block %}
See [Set up DNS](/docs/ca/dev/set-up-dns.html) for details on how to set up DNS for your application.

### Application

Expand Down
26 changes: 26 additions & 0 deletions docs/ca/dev/set-up-dns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Set up DNS
description: Learn how to set up DNS for your SCCOS project
template: concept-topic-template
---

You normally add a CNAME record in your DNS Management for the domains you want to use for your application. This CNAME corresponds to the DNS name of the load balancer of your environment to make your application accessible to the outside world. You can get the load balancer information from our support team. Generally, the DNS setup has these steps:
- You add the endpoint you want to use in the appropriate `deploy.yml` file and send it to us using a support case, mentioning that you have added a new endpoint that you want to set up for DNS configuration.
- We terraform this endpoint and send you back DNS entries for TLS verification (so that we can issue TLS certificates for your site).
- You set these entries in your DNS management and let us know when you are done.
- Terraforming can then be completed, and you receive the CNAME DNS records that you can then set in your DNS management to point your DNS names to the newly created endpoints.
- After this is completed, your application becomes accessible through the new endpoints.

{% info_block infoBox "Info" %}

This process can take a full week to complete due to DNS propagation and the terraform work that needs to be done. To avoid double work, ensure the endpoint selection is final and tested.

{% endinfo_block %}

To use a root domain for your application (for example, spryker.com), use an IP address instead of the load balancer DNS name, as this is required for an ARECORD. In this case, let our team know so they can provide you with an IP instead of the load balancer address. Do not set load balancer IP addresses as an ARECORD. The IP addresses are subject to rotation.

{% info_block infoBox "Info" %}

We do not normally support full delegation of your DNS to us and, therefore, do not suggest that you change your domain’s NS records to ours.

{% endinfo_block %}
Loading