Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add upgrade and deprecation notices for 1.20 manual #1215

Merged
merged 1 commit into from
Oct 31, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions _includes/manuals/1.20/1.2_release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
This section will be updated prior to the next release.

### Headline features

#### UI Improvements

Multiple changes have been made in the graphical user interface, thanks to the
Expand Down Expand Up @@ -40,7 +39,7 @@ for more information.

#### FIPS compliance

Foreman should now run properly in FIPS-enabled environments.
Foreman can now run properly in FIPS-enabled environments.

### Release notes for {{page.version}}
#### API
Expand Down Expand Up @@ -376,7 +375,10 @@ Foreman should now run properly in FIPS-enabled environments.

### Deprecations

* The ability to disable login, organizations or locations via settings has been deprecated and will be
removed in version 1.21. Please enable these settings in your `settings.yaml` file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate what this effectively mean for users upgrading or installing 1.20? A warning messages in logs? I believe it's not enough and we should be more verbose, probably some persistent banner, they need to test it now, not after there is no way back. Any ideas?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a notification of this change pointing to the discussion thread on discourse that will be displayed to all admins for a month after the upgrade.

* The `snippets` template macro has been deprecated and will be removed in 1.22, please use `snippet` instead.
* The `modulepath` setting had no effect and has been removed.

### Upgrade warnings

Expand All @@ -387,5 +389,12 @@ same time. In order to prevent this in future, we decided to add a constraint on
means that existing duplicates need to be unified manually. Either delete all duplicates from `puppetclasses`
table or try using [foreman-maintain](https://github.com/theforeman/foreman_maintain) that should fix the issue.
For more information, see [the redmine issue](http://projects.theforeman.org/issues/24923/)
* A change introduced to the host fact API in 1.19.0 has led to incompatibilities and has been reverted.
Any scripts using this API may need to be updated accordingly.
See ([the redmine issue](https://projects.theforeman.org/issues/25188)) for more details.
* The ability to define `puppetconfdir`, `puppetvardir` and `puppetssldir` via `settings.yaml` has
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ssl_* settings mentioned can still be set via settings.yaml (which the installer does). It's that they previously were derived from puppetssldir if unset.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated the text, let me know it it is clearer now. thanks!

been removed. The `ssl_certificate`, `ssl_ca_file` and `ssl_priv_key` options, which defaulted to using these
values as part of their default, should now be configured via the UI, CLI or API, or a default value for
them can be set directly in `settings.yaml` or via the installer.

### Contributors