Deploy File Reference - 1.0

This reference page describes version 1 of the Deploy file format. This is the newest version.

Deploy File Structure

The topics below are organized alphabetically for top-level keys and sub-level keys to describe the hierarchy.

You can use the extended YAML syntax according to YAML™ Version 1.2. Find B2B/B2C deploy file examples for development and demo environments in the table:

version:

Defines the version of the Deploy file format.

This reference page describes the Deploy file format for versions 1.*.

version: 1.0

namespace: spryker-demo
...

namespace:

Defines the namespace to separate different deployments in a single environment.

For example, Docker images, containers and volume names start with a namespace: to avoid intersections between different deployments on a single host machine.

version: 1.0
namespace: spryker-demo

tag:

Defines a tag to separate different boots for a single deployment.

By default, the tag is a randomly generated, unique value.

For example, Docker images and volumes are tagged with a tag: to avoid intersections between different boots for a signle deployment on a single host machine. The tag can be set directly in the deploy file to ensure that all the boots of a deployment run with the same images and volumes.

version: 1.0

tag: '1.0'

version: 1.0

tag: 'custom-one'

environment:

Defines the environment name for Spryker applications mainly to point to specific configuration files, namely config/Shared/config-default_%environment_name%{store}.php.

The APPLICATION_ENV environment variable is set for all the corresponding Spryker applications.

version: 1.0

environment: 'docker'

image:

Defines the Docker image configuraion to run Spryker applications in.

image:tag

Defines the image tag according to the spryker/php images located at Docker Hub. Possible values are:

1. spryker/php:7.2 - applies the default image (currently, it is Debian).

2. spryker/php:7.2-debian - applies Debian as a base image.

3. spryker/php:7.2-alpine - applies Alpine as a base image. The Alpine images are smaller, but you may have issues with:

   • iconv
   • NFS
   • Non-lating languages
   • Tideways

version: 1.0

image:  
    tag: spryker/php:7.2

image: php:

Defines the PHP settings for Spryker applications.

• image: php: ini: - defines php.ini configuration.
• image: php: enabled-extensions - defines enabled PHP extensions. Only blackfire and newrelic are allowed here.

image:
    ...
    php:
        ini:
            memory_limit: 2048M
        enabled-extensions:
            - blackfire
            - newrelic

regions:

Defines the list of Regions.

• regions: services: - defines settings for Region-specific services:. Only database: is currently allowed here.
• regions: stores: - defines the list of Stores.
• regions: stores: services: - defines application-wide, Store-specific settings for Services. Only broker:, key_value_store: and search: are currently allowed here. See services: to learn more.

version: "1.0"

regions:
	REGION-1:
		services:
			# Region-specific services settings

		stores:
			STORE-1:
				services:
					# Store-specific services settings
			STORE-2:
				services:
					# Store-specific services settings
			

groups:

Defines the list of Groups.

• groups: region: - defines the relation to a Region by key.
• groups: applications: - defines the list of Applications. See groups: applications: to learn more.

version: "1.0"

groups:
	BACKEND-1:
		region: REGION-1
		applications:
			zed_1:
				application: zed
				endpoints:
					zed.store1.spryker.local:
						store: STORE-1
						services:
							# Application-Store-specific services settings
					zed.store2.spryker.local:
						store: STORE-2
						services:
							# Application-Store-specific services settings
	STOREFRONT-1:
		region: REGION-1
		applications:
			yves_1:
				application: yves
				endpoints:
					yves.store1.spryker.local:
						store: STORE-1
						services:
							# Application-Store-specific services settings
					yves.astore2t.spryker.local:
						store: STORE-2
						services:
							# Application-Store-specific services settings
			glue_1:
				application: glue
				endpoints:
					glue.store1.spryker.local:
						store: STORE-1
					glue.store2.spryker.local:
						store: STORE-2
		

Applications can be defined as Store-agnostic, as in the example above. Also, applications can be defined as Store-specific by leaving a single endpoint pointing to each application. You can see it in the example below. You can use both approaches to scale applications separately by Store.

version: "1.0"

groups:
	BACKEND-1:
		region: REGION-1
		applications:
			zed_store_1:
				application: zed
				endpoints:
					zed.store1.spryker.local:
						store: STORE-1
			zed_store_2:
				application: zed
				endpoints:
					zed.store2.spryker.local:
						store: STORE-2
		

groups: applications:

Defines the list of Applications.

The key must be project-wide unique.

Each application: should contain the following:

• groups: applications: application: - defines the type of Application. Possible values are Zed, Yves and Glue.
• groups: applications: endpoints: - defines the list of Endpoints to access the Application. See groups: applications: endpoints: to learn more.

services:

Defines the list of Services and their project-wide settings.

Each service has its own set of settings to be defined. See Services to learn more.

Find common settings for all services below:

• engine: - defines a third-party application supported by Spryker that does the job specific for the Service. For example, you can currently set database:engine: to postgres or mysql.
• endpoints: - defines the list of Endpoints that point to the Service web interface or port.
• version: - defines the version of the service to be installed. If database:engine: is set to mysql, also defines if MySQL or MariaDB is used according to the version. See Database for detailed configuration instructions.

services:
database:
	engine: postgres
	version: 9.6
	root:
		username: "root"
		password: "secret"

broker:
	engine: rabbitmq
	api:
		username: "root"
		password: "secret"
	endpoints:
		queue.spryker.local:

	session:
		engine: redis
		version: 5.0

	key_value_store:
		engine: redis

	search:
		engine: elastic
		version: 6.8

	scheduler:
		engine: jenkins
		version: 2.176
		endpoints:
			scheduler.spryker.local:

	mail_catcher:
		engine: mailhog
		endpoints:
			mail.spryker.local:

docker/sdk demo-data

groups: applications: endpoints:

Defines the list of Endpoints to access the Application.

The format of the key is domain[:port]. The key must be project-wide unique.

• groups: applications: endpoints: store: defines the Store as context to process requests within.
• groups: applications: endpoints: services: defines the Store-specific settings for services. Only session: is currently allowed here. See Services to learn more.

services: endpoints: Defines the list of Endpoints to access a Service for development or monitoring needs. The format of the key is domain[:port]. The key must be project-wide unique.

• services: endpoints: protocol: defines the protocol. Possible values are: tcpand http. The default one is http.

A port must be defined if protocol is set to tcp. The TCP port must be project-wide unique.

docker:

Defines the settings for Spryker Docker SDK tools to make deployment based on Docker containers.

version: 1.0

docker:

	ssl:
		enabled: true

	testing:
		store: STORE-1

	mount:
		baked:
		

docker: docker-machine: Defines the virtualization engine to be used for the overall development environment. Possible values are:

1. docker:.
2. parallels: Parallels requires a paid license to be used.

When no engine is defined in deploy.yml, the Docker Engine is used.

docker: newrelic:

Defines the New Relic configuration.

• docker: newrelic: license: - defines the New Relic license which should be acquired from New Relic.

docker:
    newrelic:
        license: eu01xxaa7460e1ea3abdfbbbd34e85c10cd0NRAL

docker: ssl:

Defines configuration for SSL module in Spryker Docker SDK.

If docker: ssl: enabled: is set to true, all endpoints use HTTPS.

version: 1.0

docker:
	ssl:
		enabled: true
		

To enable secure connection in your browser, register the self-signed CA certificate from ./docker/generator/openssl/default.crt in your system.

docker: debug:

Defines the configuration for debugging.

If docker: debug: enabled: is set to true, all applications work in debugging mode.

version: 1.0

docker:
	debug:
		enabled: true
		

docker: logs:

• docker: logs: path: defines the path to the directory with Docker logs.

docker: testing:

Defines the configuration for testing.

• docker: testing: store: defines a Store as the context for running tests using specific console commands, like docker/sdk console code:test.

docker: mount

Defines the mode for mounting source files into application containers.

1. baked:- source files are copied into the image, so they cannot be changed from host machine.

As mount: is a platform-specific setting. You can define multiple mount modes. Use theplatforms: list to define the mount mode for a particular platform. Possible platforms are windows, macos and linux.

The first mount mode matching the host platform is selected by default.

version: 1.0

docker:
	mount:
		native:
			platforms:
				- linux

		docker-sync:
			platforms:
				- macos
				- windows
		

composer:

Defines the composer settings to be used during deployment.

1. mode: - defines whether packages should be installed from the require or require-dev section of composer.json. Possible values are --no-devand -dev.

2. autoload: - defines composer autoload options. Possible values are --optimize and --classmap-authoritative.

Services

You can configure and use external tools that are shipped with Spryker in Docker as services. If a service has a dedicated configuration, it is configured and run when the current environment is set up and executed.

The following services are supported:

• blackfire
  

• broker
  

• database
  

• key_value_store
  

• kibana
  

• mail_catcher
  

• redis-gui
  

• scheduler
  

• search
  

• session
  

• swagger
  

blackfire: An application profiler Service used for testing and debugging.

• Project-wide
  • blackfire: engine: - possible value is blackfire.
  • blackfire: server-id: - defines the server id used to authenticate with Blackfire. Use it only if you have a shared agent between multiple environments.
  • blackfire: server-token: - defines the server token used to authenticate with Blackfire. Use it only if you have a shared agent between multiple environments.
  • blackfire: client-id: - defines the client ID from the Client ID/Client Token credentials pair.
  • blackfire: client-token: - defines the client Token from the Client ID/Client Token credentials pair.

broker:

A message broker Service.

• Project-wide

  • broker: engine: - possible values is rabbitmq.
  • broker: api: username, database: api: password: - defines the credentails for the message broker’s API.
  • broker: endpoints: - defines the service’s port or/and web-interface that can be accessed via given endpoints.

• Store-specific

  • broker: namespace: - defines a namespace (virtual host).
  • broker: username:, broker: password: - defines the credentials to access the namespace (virtual host) defined by broker: namespace:.

database:

An SQL database management system Service.

• Project-wide

  • database: engine: - possible values are postgresand mysql.
  • database: version: - defines the version of the database engine. If database:engine: is set to mysql, also defines if MySQL or MariaDB is used according to the version. See Database for detailed configuration instructions.
  • database: root: username:, database: root: password: - defines the user with root privileges.
  • database: endpoints: - defines the service’s port that can be accessed via given endpoints.

• Region-specific

  • database: database: - defines database name.
  • database: username:, database: password: - defines database credentials.

key_value_store:

A key-value store Service for storing business data.

• Project-wide

  • key_value_store: engine: - possible value is: redis.
  • session: endpoints: - defines the service’s port that can be accessed via given endpoints.

• Store-specific

  • key_value_store: namespace: - defines a namespace (number for Redis).

kibana:

A Service to visualize Elasticsearch data and navigate the Elastic Stack.

• Project-wide
  • kibana: engine: - possible value is: kibana.
  • kibana: endpoints: - defines the service’s port and web interface that can be accessed via given endpoints.

mail_catcher:

A mail catcher Service used to catch all outgoing emails for development or testing needs.

• Project-wide

  • mail_catcher: engine: - possible value is mailhog.
  • mail_catcher: endpoints:- defines the service’s port and web interface that can be accessed via given endpoints.

redis-gui:

A Service that provides a graphical user interface to access Redis databases.

• Project-wide
  • redis-gui: engine: - possible value is redis-commander.
  • redis-gui: endpoints:- defines the service’s port and web interface that can be accessed via given endpoints.

scheduler:

A scheduler Service used to run application-specific jobs periodically in the background.

• Project-wide
  • scheduler: engine: - possible value is jenkins.
  • scheduler: endpoints: - defines the service’s port and web interface that can be accessed via given endpoints.

search:

A search Service that provides a distributed, multitenant-capable full-text search engine.

• Project-wide
  • search: engine: - possible value is elastic.
  • search: endpoints: - defines the service’s port and web interface that can be accessed via given endpoints.

session:

A key-value store Service for storing session data.

• Project-wide

  • session: engine: - possible values is redis.
  • session: endpoints: - defines the service’s port that can be accessed via given endpoints.

• Endpoint-specific

  • session: namespace: - defines a namespace (number for Redis).

swagger:

The swagger-ui Service used to run Swagger UI to develop API endpoints.

• Project-wide
  • swagger: engine:- possible value is swagger-ui.
  • swagger-ui: endpoints: - defines the service’s port or/and web interface that can be accessed via given endpoints.

Change log

• Initial reference document is introduced.