Related Documents
Document Properties
Kbid
27914Q
Last Modified
09-Jul-2021
Added to KB
20-Jul-2016
Public Access
Everyone
Status
Online
Doc Type
Guidelines, Concepts & Cookbooks
Product
  • Gradle Tools
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10
Related Product

Overview - Build, Assembly and Deployment

1 Introduction

The present page serves as an overview for the topic. All available documents for the topic can be found here.

The present document replaces the document Overview - Gradle-Based Build and Deployment (KB-ID L25628)

2 About the Topic

2.1 Continuous Integration

Isoftware engineering, continuous integration is the practice of frequently merging and testing individual changes to code artifacts with a shared code base.

Intershop 7 (as of version 7.4 CI) and Intershop Commerce Management are bundled with Gradle-based tools that are used to build, assemble, upgrade, downgrade, deploy and undeploy system components. These tools are designed to implement flexible continuous delivery processes.

The goals of the continuous delivery process include:

  • Provide feedback as fast as possible to the developers
  • Continuously build, integrate, deploy and test the product to be delivered
  • Automate as much as possible to reduce the maintenance efforts of the build system

2.2 Build Process

The process of converting ("compiling") source code into executable software.

In the Intershop 7 context, several build process types were employed (up to Intershop 7.4):

  • smoke build
  • rolling build
  • latest build

Beginning with the continuous integration support for Intershop 7 and Intershop Commerce Management, Intershop replaces this approach with

  • snapshot build
  • nightly build
  • release build

2.3 Assembly

Depending on the context, "assembly" may be

  • the process of combining deployment components as produced by a build process into deployable products or extensions, and
  • the result of doing so, i.e., the assembled deployable and executable product or extension that can be released.

Depending on the project-specific configuration, an assembly can produce

  • a product or an extension, and
  • a major, minor, patch or custom fix version (of a product or an extension)

2.4 Deployment

Deployment is all of the activities that make a software system available for use. The deployment process consists of several interrelated activities with possible transitions between them. These activities can occur at the producer side or at the customer side or both. Because every software system is unique, the precise processes or procedures within each activity can hardly be defined. Therefore, "deployment" should be interpreted as a general process that has to be customized according to specific requirements or characteristics.

Intershop includes the following activities into the deployment:

  • provide environment (e.g. productive, test, backup)
  • install/update software
  • configure software

http://en.wikipedia.org/wiki/Software_deployment


3 Overview

Note

The property valid from indicates the first version for which this document is valid.

The property valid to indicates the last version for which this document is valid.

The version numbers 7.x are related to the products Intershop 7 or Intershop Commerce Suite.

All other version numbers are related to the product Intershop Gradle Tools.

Please note that the Intershop Customer Knowledge Base provides product-related filter criteria.


TitleLastmodifiedvalid fromvalid to
Concept - Continuous Delivery Tools2021/03/08 18:36:341.0
Concept - Gradle Assembly Tools2020/02/03 13:53:141.0 
Concept - Gradle Build Tools2020/02/03 13:53:151.0
Concept - Gradle Deployment Tools2020/02/03 13:53:161.0 
Concept - Planning an Intershop 7 Deployment2020/02/03 13:53:177.5 
Cookbook - Custom Fix Recipes (valid to 7.4 CI)2020/02/03 13:53:177.4.6.17.4.6.2
Cookbook - Deployment of Solr Search Adapters2020/06/23 16:28:227.10
Cookbook - Deployment Tools ICM 7.102021/04/06 09:36:207.10
Cookbook - Deployment Tools ICM 7.82020/02/03 13:53:187.87.8
Cookbook - Deployment Tools ICM 7.92020/02/03 13:53:197.97.9
Cookbook - Encryption2021/06/02 10:57:037.10.31
Cookbook - Gradle Assembly Tools2020/11/23 09:40:332.11.6
Cookbook - Gradle Assembly Tools (valid to 7.8)2020/02/03 13:53:211.02.11
Cookbook - Gradle Build Tools2020/02/03 13:53:221.0
Cookbook - Gradle Deployment Tools (7.4 CI - ICM 7.7)2020/02/03 13:53:227.4.67.7
Cookbook - Gradle Developer Workflow2020/08/17 15:33:292.11
Cookbook - Gradle Developer Workflow (valid to Gradle Tools 2.7)2020/02/03 13:53:241.02.7
Cookbook - Hotfix Recipes2020/02/03 13:53:257.4.6.37.5
Cookbook - Setup CI Infrastructure2020/06/16 15:11:192.11
Cookbook - Setup CI Infrastructure (valid to Gradle Tools 2.3)2020/02/03 13:53:272.32.3
Cookbook - Setup CI Infrastructure (valid to Gradle Tools 2.7)2020/02/03 13:53:282.72.7
Cookbook - Setup CI Infrastructure (valid to GradleTools 1.1)2020/02/03 13:53:281.01.1
Cookbook - Setup CI Infrastructure (valid to GradleTools 2.1)2020/02/03 13:53:292.02.1
Cookbook - Solr Cloud Server2021/04/19 11:34:417.10
Guide - Deployment Solr Cloud Server2021/02/04 16:00:227.9
Guide - General Database Setup2020/02/03 13:53:317.5 
Guide - Quick Database Setup With DBCA Templates2018/03/14 14:32:39 7.0 
Guide - Quick Project Setup2020/06/23 16:28:437.10
Guide - Quick Project Setup (valid to Gradle Tools 2.7)2020/02/03 13:53:327.67.7
Guide - Quick Project Setup (valid to Gradle Tools 2.11)2020/02/03 13:53:337.9 
Guide - Setup Microsoft SQL Server as Intershop Development Database2020/05/26 20:25:517.10
Guide - Setup Microsoft SQL Server as Intershop Production Database2020/02/04 13:16:017.10 
Guide - Setup Oracle XE as Intershop Development Database2020/02/03 13:53:337.4.6
Public Release Notes - Gradle Tools - Version 1.02020/02/03 13:53:341.01.0
Public Release Notes - Gradle Tools - Version 1.12020/02/03 13:53:341.11.1
Public Release Notes - Gradle Tools - Version 2.02020/02/03 13:53:352.02.0
Public Release Notes - Gradle Tools - Version 2.12020/02/03 13:53:362.12.1
Public Release Notes - Gradle Tools - Version 2.112020/02/03 13:53:362.112.11
Public Release Notes - Gradle Tools - Version 2.32020/02/03 13:53:372.32.3
Public Release Notes - Gradle Tools - Version 2.72020/02/03 13:53:382.72.7
Reference - Gradle Assembly Tools2020/02/03 13:53:391.0 
Reference - Gradle Build Tools2020/02/03 13:53:401.0 
Reference - Gradle Deployment Tools2020/02/03 13:53:421.0 
Support Article - Authenticate a User Against an LDAP System2021/07/08 15:15:137.37.9
Support Article - Build Configuration Updated to Gradle Tools Version 2.112019/04/11 09:57:447.67.9
Support Article - Build Fails With an Exception Concerning Gradlew2019/04/11 09:57:457.4.67.4.6
Support Article - Configure an Alternative Phantom JS Driver Download URL2019/04/11 09:57:477.6
Support Article - Creating Another Application Within an Already Existing Channel2020/08/18 11:17:347.10
Support Article - Deployment Stops While Looking for Oracle 19 Drivers2020/03/23 10:59:537.97.9
Support Article - Gradlew Commands Fail with Stack Map Frame Exception2019/04/11 09:58:034.7
Support Article - Install Intershop 7.4 CI on Windows2019/04/11 09:58:057.4.6.17.4.6.2
Support Article - Installation and Basic Configuration of Apache Solr Search on a Dedicated Apache Tomcat Server Instance for ICM2019/04/11 09:58:077.07.4
Support Article - Keep Existing Development Environments Working After Importing Intershop 7.5.2 / 7.5.3 to the Nexus2021/07/09 14:00:027.57.5
Support Article - Keeping CSV Mapping Template Files Up-To-Date After Deployment2021/07/09 14:00:027.6
Support Article - OpenSSL Error Unable to Load Config Info From /usr/local/ssl/openssl.cnf2021/07/09 14:00:077.3
Support Article - Preparing a Rolling Deployment Without Downtime2021/07/09 14:00:097.7
Support Article - Re-Deployment of Intershop 7.4 CI Overwrites the Valid "encryption.properties"2021/07/09 14:00:127.4.67.4.6
Support Article - Simple Deployment of an ICM Demo Server2021/07/09 14:00:207.6
Support Article - Tomcat Listener JreMemoryLeakPreventionListener Causes a Full Garbage Collection Every Hour2021/07/09 14:00:267.07.3
Video Tutorial - Continuous Integration (valid to Intershop 7.4 CI)2021/07/09 14:04:467.4.67.4.6
Video Tutorial - Intershop CI Structure Overview2021/07/09 14:04:477.6
Video Tutorial - Prepare Your Artifact Repository Server2021/07/09 14:04:487.6
Video Tutorial - Simple Deployment of a Production System2021/07/09 14:04:517.6
Video Tutorial - Simple Setup of a Development-System2021/07/09 14:04:517.6

4 Document Groups

The present section provides a more detailed view about the available documents then the generic report above.

4.1 Basics

DocumentDescription
Concept - Continuous Delivery ToolsThis is an overview about the idea behind Intershop Continous Delivery Tools. It should help to understand the big picture.
Cookbook - Setup CI Infrastructure

Previous versions of this cookbook can be found here:

If a build engineer or system administrator wants to start with the preparation of an environment with all necessary servers and source artifacts, he should start with this document. This documents prepares also some necessary artifacts for an simple setup of a demo environment.

Guide - Quick Project Setup

Intershop 7 (since IS 7.4 CI) is delivered with tools that can be used to build, assemble, upgrade, downgrade, deploy and undeploy software components.

The present document is intended as a quick start guide for consultants and developers for a quick project setup.

Note

The activities described in this document are intended to give a rough overview of the setup steps. The document helps to get a first impression about the functionalities of the Intershop platform and the "look and feel" when developing applications.

Be aware that this quick guide does neither describe the quickest solution for many developers, nor do the approaches mentioned here meet the requirements of a full-scale project setup.

To set up a development environment, please follow the Cookbook - Setup CI Infrastructure (valid to Gradle Tools 2.7) instead, which focuses on creating a reusable infrastructure for multiple developers.

For more detailed information to a complete CI Infrastructure, please refer to Cookbook - Setup CI Infrastructure (valid to Gradle Tools 2.7).

For more detailed information about deploying Intershop 7 instances, please refer to Cookbook - Gradle Deployment Tools (7.4 CI - ICM 7.7).

The procedures described in the present guide are based on Intershop 7.6 in combination with Intershop Gradle Tools 2.7.

Previous versions of this cookbook can be found here:

Cookbook - Gradle Developer Workflow

If a developer wants to start with development of components (cartridges), he find the first information in this document.

A previous version of this cookbook can be found here:

Cookbook - Gradle Developer Workflow (valid to Gradle Tools 2.7)


4.2 Build Tools

DocumentDescription
Concept - Gradle Build Tools

Developers and build engineers can find the most important information for the configuration of the component build in this document:

  • Server and their functionality
  • Information about the environment variables
  • All available Gradle plugins
  • Directory / file layouts for system component sets and system components.
Cookbook - Gradle Build Tools

This cookbook contains recipes for some special cartridge build configurations and some special tasks.

Reference - Gradle Build ToolsThis is the reference of Intershop build plugins and extensions.

4.3 Assembly Tools

DocumentDescription
Concept - Gradle Assembly Tools

If a developer wants to start with development of an assembly, he should read this document first.

Cookbook - Gradle Assembly Tools

This cookbook contains recipes for the implementation of an assembly.

A previous version of this cookbook can be found here:

Cookbook - Gradle Assembly Tools (valid to 7.8)

Reference - Gradle Assembly Tools

This document describes the Gradle DSL extension of the Intershop assembly plugins.

4.4 Deployment Tools

DocumentDescription
Concept - Gradle Deployment Tools If a developer, build engineer or administrator wants to get an overview of the functionality and important plugins of the deployment tools, he should use this document.
Cookbook - Deployment Tools ICM 7.10

This cookbook contains recipes for the implementation of a deployment.

Previous versions of this cookbook can be found here:

Reference - Gradle Deployment Tools

This document describes the Gradle DSL extension of the Intershop deployment plugins.

4.5 Database

DocumentDescription
Guide - Setup Oracle XE as Intershop Development Database

This guide helps to set up an Oracle XE for Intershop. This database can be used for development or presentation cases.

Guide - Setup Microsoft SQL Server as Intershop Development DatabaseThis document describes how to configure MS SQL Edition and Intershop 7 for use as a development database.
Guide - General Database Setup

This guide is addressed to system administrators/DBAs who have to set up an Oracle database instance for Intershop 7. It does not describe the steps to do in detail, but summarizes the general requirements and common settings that an Intershop 7 cluster expects as preconditions to function properly.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets