Add ability to modify docker-compose configuration #722
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds the ability for modules to extend the docker-compose.yml configuration with sidecar containers (or override existing configuration).
This was referenced Aug 20, 2024
kovshenin
reviewed
Sep 3, 2024
| } | ||
|
|
||
| public function filter_compose( array $config ) : array { | ||
| $config['services']'foo'] = [ |
There was a problem hiding this comment.
Suggested change
| $config['services']'foo'] = [ | |
| $config['services']['foo'] = [ |
mikelittle
requested changes
Sep 20, 2024
|
|
||
| ## How Local Server works | ||
|
|
||
| Local Server internally uses Docker Compose to create and manage containers for the Altis environment. When a user runs the `composer server start` command, Local Server dynamically provisions a `docker-compose.yml` file based on the user's preferences. (This file is only regenerated when starting Local Server to avoid conflicts or surprising behaviour for users.) |
There was a problem hiding this comment.
Suggested change
| Local Server internally uses Docker Compose to create and manage containers for the Altis environment. When a user runs the `composer server start` command, Local Server dynamically provisions a `docker-compose.yml` file based on the user's preferences. (This file is only regenerated when starting Local Server to avoid conflicts or surprising behaviour for users.) | |
| Local Server internally uses Docker Compose to create and manages containers for the Altis environment. When a user runs the `composer server start` command, Local Server dynamically provisions a `docker-compose.yml` file based on the user's preferences. (This file is only regenerated when starting Local Server to avoid conflicts or surprising behaviour for users.) |
There was a problem hiding this comment.
Could you also wrap lines at 132 chars please? As per our MD linting standards.
| $config = []; | ||
| foreach ( $packages as $name => $package ) { | ||
| $extra = $package->getExtra(); | ||
| if ( ! isset( $extra['altis'] ) || ! isset( $extra['altis']['local-server'] ) ) { |
There was a problem hiding this comment.
This would be clearer as a positive test:
Suggested change
| if ( ! isset( $extra['altis'] ) || ! isset( $extra['altis']['local-server'] ) ) { | |
| if ( isset( $extra['altis'] ) && isset( $extra['altis']['local-server'] ) ) { | |
| $config[ $name ] = $extra['altis']['local-server']; | |
| } |
There was a problem hiding this comment.
I'd agree if it were a straight if/else, but this is more of a return-early pattern. Not strongly opinionated so if you feel it's much more readable that way I'll update
|
I like the idea of this. |
kovshenin
approved these changes
Sep 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds the ability for any Composer package (including the root/project itself) to modify the docker-compose configuration, making it possible for modules to add containers or alter the existing configuration.
This can be used for better modularity and conditional behaviour, such as for optional features like Elasticsearch or Node.js. It also provides the ability for users to customise Docker behaviour fairly directly in their project.
My plan is to transition the ES + Kibana containers to the Enhanced Search package, and then eventually someday remove it from the default bundle, allowing a clearer opt-in for customers who have actually bought it. PR for that incoming soon.