Upgrade Path Builder about stack-docs HOT 7 CLOSED

On my side, I've integrated the builder with elastic.co locally by using @sylvie777's iframe-embedding technique:

I tried to integrate the source directly, but Twine creates some truly shudder-inducing code which doesn't play very well with ContentStack and results in a 500 error when you try to load the page. I couldn't figure out why.

In the long-term, I think we'll need to hand-roll a simple in-house system for this tool. Requirements would be:

1. Allow the content-creator to easily define the branches in a tree like the one above.
2. The content-creator should have complete control over the form UI of each node in the tree.
3. As the user navigates to each node in the tree, render the form UI defined by the content-creator.
4. As the user enters input into each form, store this form data.
5. The content-creator should have access to a getNextNodeId(formData) hook. This hook is called when the user clicks the "Next" button. The formData object contains all of the user's input. The content-creator can write conditions to evaluate against this form data and return the id of the next node to be shown.

from stack-docs.

Nice work @debadair! I realize this is very much WIP and I apologize if this is already on your radar. It looks like there is a missing line break after group headings on the 6.0 upgrade checklist.

from stack-docs.

No need to apologize...I have a list, this anomaly wasn’t on it. :-)

from stack-docs.

@debadair Love the way this looks!

Text cuts off and there is no scroll bar, so I can't progress forward or read all of the text
To Replicate: "Let's Go, Select version=5.6, EC=yes, Products=Logstash & Kibana.

It happens in a few places -- there is also some odd spacing.

Sorry for the noise if this is a known bug!

from stack-docs.

I know this is still a work in progress, I played around with it a bit. I probably haven't hit all the paths yet, here are the things I came across so far:

Btw, I love that we have this app to help demystify all the different paths 🎆 🍾 ❤️ :

• "What version of Elasticsearch are you currently running?" starts with version 2.x. It's hurts just to say it, we have customers with clusters still on 1.x and even 0.x I believe :/ And if we intend to share this with the community, I am sure there will be pre-2.x clusters out there as well. Do we want to consider adding a pre-2.x path where they will just be doing reindexing or everything, a full cluster restart, etc.. :D .
• I selected 5.0-5.5 -> Not using Cloud -> Yes for X-pack (check all of them) -> Next .. When I step through and click on Next from the “You must perform a two-step rolling upgrade:” page, it shows this at the top of the next screen:

Upgrading to 6.0 on Elastic Cloud
On Elastic Cloud, all major configuration changes to upgrade Elasticsearch, Kibana, and X-Pack are handled for you. 

So somehow the not using Cloud path got mixed up with the Cloud part further down the flow

• 5.6 upgrade path, when I get to "Upgrading from 5.6 to 6.0", it already shows the statement

You can perform a rolling upgrade to 6.0, upgrading one node at time instead of shutting down the entire cluster. 

This is before our check for TLS. Maybe we can delay showing this statement until after the TLS check?

• On the TLS check, when I click on No and then Next, it gives an error
  
• When selecting 2.x ES cluster + Yes to Are you running on ES cloud, the link we share for upgrading their 2.x cluster to 5.6 is broken (https://www.elastic.co/guide/en/cloud/current/ec-upgrading-v5.html.). How about sharing this link instead (https://www.elastic.co/guide/en/cloud/current/upgrading.html)?
• The beats (https://www.elastic.co/guide/en/beats/reference/6.0/breaking-changes.html) and LS (https://www.elastic.co/guide/en/logstash/reference/6.0/breaking-changes.html) breaking changes links are also broken, should be https://www.elastic.co/guide/en/beats/libbeat/6.0/breaking-changes.html and https://www.elastic.co/guide/en/logstash/6.0/breaking-changes.html.
• Even though ES hadoop is selected, when we list the breaking changes, there is no breaking changes link for it, we can add a link to https://www.elastic.co/guide/en/elasticsearch/hadoop/6.0/breaking-changes.html ?
• For the upgrade from 2.x path, we simply say "Upgrading to 5.6
  Before you can upgrade to 6.0, you need to shut down your cluster and upgrade to 5.6.", and at the end we provide breaking changes for 6.0. I think we will want to call out breaking changes between 5.0-5.5 as well to make sure they review those?

Excited to see this tool!

from stack-docs.

I've checked in the source: https://github.com/elastic/stack-docs/blob/master/docs/60_upgrade_guide.html

It's now staged at: https://stag-www.elastic.co/products/upgrade_guide

My list of outstanding items is shrinking:

• Add a line about the changeme password to the preparing to upgrade list.

• Revise info about Beats upgrade order/requirements.

• Make the last page more distinctive so it's clear you've finished.

• Edit
• Test, test, test

from stack-docs.

Shipped.

from stack-docs.