Add debugging section to the core manual #560

hschaeidt · 2018-08-07T13:27:57Z

resolves #551

teohhanhui · 2018-08-07T13:40:52Z

core/debugging.md

+# the different stages of this Dockerfile are meant to be built into separate images
+# https://docs.docker.com/compose/compose-file/#target
+
+ARG BUILD_ENV=prod


It's used in line 43, to distinguish between the prod and dev image. The alternative would be to override the build target for the php service.

The idea was to add a stage before doing all the composer stuff and before the entrypoints are set. Otherwise it would probably also require to re-set the entrypoints as they are set in api_platform_php, for the dev stage too. And that leads to duplicate code. But I'm usually not a docker user, so please correct me if I'm wrong.

The alternative would be to override the build target for the php service.

Yes, that is what should be done.

This dev stage cannot be here. It'll get in the way of other stages. 😄

It has to be at the end, as I've mentioned in #560 (comment)

You only need to re-set the ENTRYPOINT if you're setting CMD. If you don't change that, it'll simply use what's already set in the base image.

You are right. It makes sense said like that and keeps things simpler

teohhanhui · 2018-08-07T13:42:00Z

core/debugging.md

+ARG VARNISH_VERSION=6.0
+
+-FROM php:${PHP_VERSION}-fpm-alpine AS api_platform_php
+FROM php:${PHP_VERSION}-fpm-alpine AS api_platform_php_prod


Please keep this stage untouched, but instead put the api_platform_php_dev stage at the very end of the Dockerfile (after Varnish).

Also, with this change we don't have to use diff format, but just say to append to the end of the Dockerfile.

alanpoulain · 2018-08-07T14:35:08Z

core/debugging.md

@@ -0,0 +1,83 @@
+# Debugging
+
+The default docker stack is shipped without a xdebug/dev stage. It is easy


docker => Docker
xdebug => Xdebug.
Remove /dev?
It is => It's
develoment => development
api => API

alanpoulain · 2018-08-07T14:36:18Z

core/debugging.md

+
+## Add a development stage to the Dockerfile
+
+To avoid deploying api-platform to production with an active xdebug extension,


api-platform => API Platform
xdebug => Xdebug
is is => it's

teohhanhui · 2018-08-08T11:13:32Z

core/debugging.md

+
+The default Docker stack is shipped without a Xdebug stage. It's easy
+though to add [Xdebug](https://xdebug.org/) to your project, for development
+purposes such as debugging tests or api requests remotely.


teohhanhui · 2018-08-08T11:20:17Z

core/debugging.md

+ARG XDEBUG_VERSION=2.6.0
+RUN apk add --no-cache $PHPIZE_DEPS; \
+    pecl install xdebug-$XDEBUG_VERSION; \
+    docker-php-ext-enable xdebug


ARG XDEBUG_VERSION=2.6.0 RUN set -eux; \ apk add --no-cache --virtual .build-deps $PHPIZE_DEPS; \ pecl install xdebug-$XDEBUG_VERSION; \ docker-php-ext-enable xdebug; \ apk del .build-deps

teohhanhui · 2018-08-08T11:20:55Z

core/debugging.md

+
+## Configure Xdebug with docker-compose override
+
+Using a [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files)  


teohhanhui · 2018-08-08T11:21:31Z

core/debugging.md

+    docker-php-ext-enable xdebug
+```
+
+## Configure Xdebug with docker-compose override


Configure Xdebug with Docker Compose Override

(since we use title case)

teohhanhui · 2018-08-08T11:21:56Z

core/debugging.md

+though to add [Xdebug](https://xdebug.org/) to your project, for development
+purposes such as debugging tests or api requests remotely.
+
+## Add a development stage to the Dockerfile


Add a Development Stage to the Dockerfile

(since we use title case)

teohhanhui · 2018-08-08T11:30:08Z

core/debugging.md

+      #
+      # Choose some other port than `9000`, as this one is already occupied by FPM
+      # Make sure to also change your listening port in the IDE to this value
+      XDEBUG_CONFIG: remote_enable=1


XDEBUG_CONFIG: >- remote_enable=1 ...

(folded scalar, with "strip" block chomping)

teohhanhui · 2018-08-08T11:30:59Z

core/debugging.md

+
+```yml
+version: '3.4'
+ services:


wrong indentation (remove leading space)

teohhanhui · 2018-08-08T11:32:27Z

core/debugging.md

+
+## Troubleshooting
+
+Inspect the installation with the following command, the requested Xdebug


Inspect the installation with the following command. The requested Xdebug version should be displayed in the output.

hschaeidt · 2018-08-08T12:05:02Z

Thanks for this in-depth review. I will fix the rest soon.

resolves api-platform#551

dunglas · 2018-10-01T12:38:20Z

Thanks @hschaeidt. Very useful PR!

teohhanhui suggested changes Aug 7, 2018

View reviewed changes

alanpoulain reviewed Aug 7, 2018

View reviewed changes

hschaeidt force-pushed the 2.3 branch 2 times, most recently from 8ebc0b7 to 8edd55a Compare August 8, 2018 11:12

teohhanhui suggested changes Aug 8, 2018

View reviewed changes

hschaeidt force-pushed the 2.3 branch from 8edd55a to 8040221 Compare August 8, 2018 11:36

hschaeidt force-pushed the 2.3 branch from 8040221 to b6a046b Compare August 8, 2018 13:41

hschaeidt mentioned this pull request Aug 13, 2018

Add a how to create dev/debug stage using xdebug section #551

Closed

Add debugging section to the core manual

e1a8911

resolves api-platform#551

hschaeidt force-pushed the 2.3 branch from b6a046b to e1a8911 Compare August 13, 2018 11:00

dunglas merged commit 1af09b9 into api-platform:2.3 Oct 1, 2018

		@@ -0,0 +1,83 @@
		# Debugging

		The default docker stack is shipped without a xdebug/dev stage. It is easy


		## Add a development stage to the Dockerfile

		To avoid deploying api-platform to production with an active xdebug extension,


		## Configure Xdebug with docker-compose override

		Using a [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files)


		## Troubleshooting

		Inspect the installation with the following command, the requested Xdebug

Uh oh!

Add debugging section to the core manual #560

Add debugging section to the core manual #560

Uh oh!

Conversation

hschaeidt commented Aug 7, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

teohhanhui Aug 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hschaeidt commented Aug 8, 2018

Uh oh!

dunglas commented Oct 1, 2018

Uh oh!

Uh oh!

teohhanhui Aug 7, 2018 •

edited

Loading