Skip to content

Upgrading from Spring Boot 1.x section #10313

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

Closed
snicoll opened this issue Sep 16, 2017 · 7 comments
Closed

Upgrading from Spring Boot 1.x section #10313

snicoll opened this issue Sep 16, 2017 · 7 comments
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@snicoll
Copy link
Member

snicoll commented Sep 16, 2017

The amount of changes between 1.x and 2 are important and it is expected we'll get a lot of users asking questions when they upgrade (it is already happening with early adopters and maintainers of downstream spring modules).

We usually have the release notes covering the upgrades aspect but I am wondering if we shouldn't try something a bit more structured for 2.0. Release notes are single page and can be a bit overwhelming (I expect the one on 2.0 to be!).

This issue is meant to gather feedback and plan future actions.

@snicoll snicoll added for: team-attention An issue we'd like other members of the team to review type: documentation A documentation update labels Sep 16, 2017
@philwebb
Copy link
Member

I'd still prefer to keep history out of the user guide if at all possible. Would a dedicated wiki page work?

@snicoll
Copy link
Member Author

snicoll commented Sep 19, 2017

A dedicated wiki page is what the release notes are today so I don't believe it does otherwise I wouldn't have created the issue :) I am with you it shouldn't be in the user guide.

The main goal here is that I think we should be a bit more thorough as the changes can be more intrusive. I think a set of dedicated pages on the wiki should work but it's really about us taking the time to analyse and describe what has changed.

@wilkinsona
Copy link
Member

A separate wiki page sounds good to me

@philwebb philwebb added priority: normal and removed for: team-attention An issue we'd like other members of the team to review labels Sep 22, 2017
@philwebb philwebb added this to the 2.0.0.RC1 milestone Sep 22, 2017
@ryonday
Copy link

ryonday commented Oct 18, 2017

I ran into difficulties trying to migrate a Spring Boot 1.3.8 app to 2.0 because entire swaths of the Actuator code base have been deleted due to the switch to Micrometer including classes that were prescribed for direct use such as CounterService and GaugeService.

It's not immediately apparent from documentation what the migration path is here, and perhaps the Micrometer folks would consider supporting some of the old Actuator classes in their micrometer-spring-legacy project so that there is at least a drop-in to keep older applications chugging along.

@gregturn
Copy link
Contributor

gregturn commented Nov 1, 2017

Things I'd suggest including in such a guide.

  • Metrics - since the whole face of metrics is changed (usage, customized, health, URIs), we should provide some sort of matrix showing "if you used CounterService, switch to ...". Additionally, show HOW to enable metrics, since they are now disabled unless you put in a certain property. I would certainly illustrate memory-based as well as at least Redis.
  • Spring Security's default posture - with the overhaul of Spring Security's default position, I would favor showing what it does NOW when added to classpath, simple options to change the password, and best plan to plugin a custom policy.
  • Security/Actuator - Previous point bleeds into this. May need a point-by-point listing of what the old actuator endpoints where, and how they've changed with/without Spring Security on the classpath, and how to tune sensitivity.
  • Document that /health has been replaced with something else. Show the new path, and optionally show how to customize a Boot HealthIndicator to point at the old path?
  • Illustrate that 1.x had JMX and Web-based endpoints on by default, but in 2.x, you must enable one, the other, or both.

I don't know where, @dsyer / @spencergibb , but I feel as if there needs to be a counterpart to this document over in Spring Cloud to go along with Finchley (or Edgware)? Stuff like the updated starter names, etc. would fit nicely in an "Upgrading my Spring Cloud app" document.

@philwebb
Copy link
Member

philwebb commented Nov 1, 2017

Thanks @gregturn. We can use this wiki page for the content.

@snicoll
Copy link
Member Author

snicoll commented Feb 14, 2018

I think the migration guide is in decent shape now.

@snicoll snicoll closed this as completed Feb 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

5 participants