Introduction
This document is addressed to customers and partners and provides information on prerequisites for setting up the system.
Please address these topics to the respective departments and bring as much information as possible to the kickoff meeting. When the setup phase - consisting of discovery phase, base setup phase, and connect & test phase - has started, we need IT experts from the customer present until all questions are clarified. This helps to expedite the setup process.
References
Mandatory Prerequisites
There are indispensable information that must be provided in advance and are essential for the initial setup of the system in the base setup phase.
The following table shows prerequisites for setting up environments and related responsibilities.
Info
| Question to Partner and Customer | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Access to:
| Provide all parties' public IPs (including ports) that should be whitelisted during the project phase to gain access to storefront and back office, as well as backend systems.
| ||||||||||||||||||||||||
| Questions to Partner | |||||||||||||||||||||||||
| Jenkins | Define the authentication provider: We want to increase the security in regards to accessing the Intershop Commerce Platform (somebody left the project, but access will not be removed) and want to reduce the effort on both sides when setting up user access (single user account). Therefore, we strongly recommend to use a Microsoft account to log in. This is mandatory for Azure DevOps and we want to use this for authentication on Jenkins, too. Provide list of users with name, e-mail and public SSH key to access:
Please note that the following SSH key formats are accepted:
| ||||||||||||||||||||||||
| Questions to Customer | |||||||||||||||||||||||||
| VPN and private IP address range | Do we need to establish a VPN connection to connect any backend services from the customer? Or will access be provided via public internet? See also CaaS FAQ - How to set up a VPN? (if necessary) If the answer is yes:
VPN is an additional optional service which can be provided by Intershop. To set up a VPN, it is necessary to agree on used private IP ranges to prevent network address conflicts. Default private IP ranges in the Intershop ICM system are as follows: Standard
10.2.x.y or 10.3.x.y can also be used instead of the 10.1.x.y. Please check the potential IP conflicts with all ranges. Alternative A
172.22.x.y or 172.23.x.y can also be used instead of the 172.21.x.y. Please check the potential IP conflicts with all ranges. Alternative B
| ||||||||||||||||||||||||
| Domains | Define the domains of the web shop for all environments. See Domain Examples below. | ||||||||||||||||||||||||
| SSL Certificates | Provide SSL certificates for the domains described above (dedicated, SAN or a Wildcard Certificate), also see Reference - CaaS FAQ | What are the Requirements for DNS and SSL/TLS Certificates? | ||||||||||||||||||||||||
| Jenkins | If development is also done by the customer, answer the questions regarding Jenkins in the "Partner" section above as well. | ||||||||||||||||||||||||
| Mail Service | Provide an SMTP service or an endpoint to which Intershop relays customer e-mails (e.g. order confirmation mails), see Mail Service - Necessary Information below. Is the mail service already available? If not, when will it be available? Please note that Intershop does not provide any mail service. However, it is required to have one. See Reference - CaaS FAQ | How to Configure the Mail Service of ICM? |
195.110.61.246 (Jena)
TBD (location/usage like London office or ERP service)
done (whitelisted)
more information required (source (web or application server?), protocol, port, etc.)Domain Examples
The following table shows domain information including example domains. These must be defined by the customer. See CaaS FAQ - Requirements for DNS and SSL/TLS Certificates.
For the PWA, domains are necessary for the storefront and the backend, which includes backoffice and REST API. For classic storefront, they are identical.
Best practice example (mydomain.com will be replaced by the customer's domain):
Storefront
| Environment | Cluster | Domain Name (to be configured by the customer to point to "CNAME") |
|---|---|---|
| PRD | live | shop.mydomain.com |
| edit | shop-edit.mydomain.com | |
| UAT | live | shop-uat-live.mydomain.com |
| edit | shop-uat-edit.mydomain.com | |
| INT | live | shop-int-live.mydomain.com |
| edit | shop-int-edit.mydomain.com |
Backend (Backoffice and REST API)
| Environment | Cluster | Domain Name (to be configured by the customer to point to "CNAME") |
|---|---|---|
| PRD | live | backend.mydomain.com |
| edit | backend-edit.mydomain.com | |
| UAT | live | backend-uat-live.mydomain.com |
| edit | backend-uat-edit.mydomain.com | |
| INT | live | backend-int-live.mydomain.com |
| edit | backend-int-edit.mydomain.com |
Mail Service - Necessary Information
The following information must be defined by the customer and is required to connect to a 3rd party mail provider like a Microsoft 365 (Exchange) account. Of course, one account can be offered for all environments.
| Parameter | PRD | UAT | INT |
|---|---|---|---|
| AppSvr1 |
|
|
|
| URL | TBD | TBD | TBD |
| Port | TBD | TBD | TBD |
| User | TBD | TBD | TBD |
| Password | Provide via one-time link like https://onetimesecret.com/ | ||
1 Outgoing public IP of app servers for ICM clusters (live and edit)
Empty fields (TBD) must be defined/provided.