puppet-sahara/releasenotes/notes/deprecate-sahara-all-7b730356a653c0ab.yaml
Tobias Urdin 690de27e49 Deprecate the sahara-all service
It's deprecated and is not recommend for usage by upstream as
it has minimal testing.

This adds notes on what should be removed/changed when sahara-all
is to be removed, adds a warning to the sahara::service::all class
and adds a detailed release note on why and how to move away from it.

Change-Id: I7a208813a396f9434ac512ec10e8355aa05d56f9
2019-02-08 11:16:45 +01:00

21 lines
1.0 KiB
YAML

---
upgrade:
- |
The now deprecated sahara::service::all class that manages the sahara-all service
is not recommended to be used as the sahara-all service has minimal testing upstream.
It's recommended that deployments move to using the separate API and engine services
which can be deployed like shown in the puppet-sahara/examples/basic.pp file.
Please see below on how to move away from the sahara-all service.
- Set ```enabled``` to ```false``` in ```sahara::service::all``` will stop the sahara-all service
- Setup ```sahara::service::api``` and ```sahara::wsgi::apache``` classes
- Setup ```sahara::service::engine``` class
Full example on how this is done can be seen in the puppet-sahara/examples/basic.pp
examples file.
deprecations:
- |
The sahara::service::all class that manages the sahara-all service is deprecated.
It's recommended to not use the sahara-all service and instead use the separated
API and engine services, the sahara-all service has minimal testing upstream.