Skip to content

Commit

Permalink
docs: deprecate lagoon.template settings
Browse files Browse the repository at this point in the history
  • Loading branch information
rocketeerbkw committed Jan 31, 2025
1 parent 1898946 commit 8880a03
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 22 deletions.
1 change: 1 addition & 0 deletions docs/concepts-basics/docker-compose-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -428,3 +428,4 @@ The corrected version combines both aliases into a single mapping key - you'll n
These settings have been deprecated and should be removed from use in your `docker-compose.yml`.

* `services.[name].labels.lagoon.rollout`
* `services.[name].labels.lagoon.template`
24 changes: 2 additions & 22 deletions docs/concepts-basics/lagoon-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -512,26 +512,6 @@ environments:
mariadb: mariadb-single
```

### `environments.[name].templates`

The Lagoon build process checks the `lagoon.template` label from the `docker-compose.yml` file in order to check if the service needs a custom template file \(read more about them in the [documentation of `docker-compose.yml`](docker-compose-yml.md)\).

Sometimes you might want to override the **template** just for a single environment, and not for all of them:

`service-name: template-file`

* `service-name` is the name of the service from `docker-compose.yml` you would like to override.
* `template-file` is the path and name of the template to use for this service in this environment.

#### Example Template Override

```yaml title=".lagoon.yml"
environments:
main:
templates:
mariadb: mariadb.main.deployment.yml
```

### `environments.[name].autogenerateRoutes`

This allows for any environments to get autogenerated routes when route autogeneration is disabled.
Expand Down Expand Up @@ -799,8 +779,6 @@ environments:
- www.example.ch
types:
mariadb: mariadb
templates:
mariadb: mariadb.main.deployment.yml
cronjobs:
- name: drush cron
schedule: "M * * * *" # This will run the cron once per hour.
Expand Down Expand Up @@ -834,3 +812,5 @@ These settings have been deprecated and should be removed from use in your `.lag
* `environments.[name].routes.[service].[route].insecure`

The `None` option is equivalent to `Redirect`.

* `environments.[name].templates`

0 comments on commit 8880a03

Please sign in to comment.