Skip to content

Added 'Upgrading Kibana' section to install docs#7807

Merged
LeeDr merged 5 commits intoelastic:masterfrom
LeeDr:installDocUpdate
Aug 5, 2016
Merged

Added 'Upgrading Kibana' section to install docs#7807
LeeDr merged 5 commits intoelastic:masterfrom
LeeDr:installDocUpdate

Conversation

@LeeDr
Copy link
Copy Markdown

@LeeDr LeeDr commented Jul 22, 2016

Addressing the first task "Upgrade documentation, especially in the context of rolling upgrades" of #5347

NOTE: This section for installs from repositories was commented out before. I uncommented it. Maybe it was temporarily commented out just during 5.0 alphas?

[float]
include::kibana-repositories.asciidoc[]

@epixa
Copy link
Copy Markdown
Contributor

epixa commented Jul 22, 2016

The repositories stuff is commented out because you cannot install master from package repos. The section gets uncommented in the actual release branches (5.0, 4.5, etc.).

. https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] existing `.kibana` index in Elasticsearch
. save a backup copy of the existing `config/kibana.yml`
. take note of the Kibana plugins that are installed;
.. `/opt/kibana/bin/kibana plugin --list` on 4.x versions of Kibana.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we should hardcode these absolute paths in the docs since different install mechanisms are going to result in different paths.

@tbragin
Copy link
Copy Markdown
Contributor

tbragin commented Jul 23, 2016

@LeeDr Thanks for getting this started!

A couple of comments:

  • Versioning
    • We have versioned documentation, so instead of saying in 4.x and 5.x we should simply show correct instructions in each version.
  • Consistency
    • Capitalization: Generally should use a capital letter at the beginning or end of bullet
  • Content
    • I like the "upgrading" section, but it feels like the new install from packages section is still light (or even gone?). Where is this section in this version of the docs? With 4.6 changes we're planning, will our install locations be more consistent with ES? Regardless, I still think we should document them (see this issue).

@LeeDr
Copy link
Copy Markdown
Author

LeeDr commented Jul 27, 2016

@debadair you had made a comment about bullets instead of numbered list for the upgrade section. The basic install steps above it are bullets. But the Install and Start Kibana from Archive File section below it was numbered. Should I change just the upgrade section from numbers to bullets? And should I also change the Install and Start Kibana from Archive File section to bullets?


. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing .kibana index.
. Back up the `kibana.yml` configuration file.
. Take note of the Kibana plugins that are installed;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Colon, instead of semicolon. :-)

@debadair
Copy link
Copy Markdown
Contributor

Made a few very picky comments--incorporate or ignore as you see fit. Other than that, LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants