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.

Sign up for GitHub

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

Jump to bottom

Update MSI documentation #31950

Merged
merged 3 commits into from
Aug 29, 2018
Merged

Update MSI documentation #31950

merged 3 commits into from
Aug 29, 2018

Conversation

codebrain
Copy link
Contributor

Updates images for 6.3 (and future) installers.

@colings86 colings86 added >docs General docs changes :Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts labels Jul 11, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra

russcam
russcam reviewed Jul 31, 2018
View reviewed changes
Copy link
Contributor

@russcam russcam left a comment

Choose a reason for hiding this comment

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

I can't comment inline on docs/reference/images/msi_installer/msi_installer_xpack.png, so will add here. This image needs to be updated to the newer UI that removes mention of the Basic license being valid only for 30 days. the Basic license applied is now perpetual in 6.3.0+, in line with other X-Pack bundled distributions

russcam
russcam reviewed Jul 31, 2018
View reviewed changes
Copy link
Contributor

@russcam russcam left a comment

Choose a reason for hiding this comment

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

Line 406 of windows.asciidoc: replace use of {es} with Elasticsearch

@russcam
Copy link
Contributor

russcam commented Jul 31, 2018 •
edited
Loading

Replace usage of {xpack} with X-Pack and usage of {es} with Elasticsearch

@russcam
Copy link
Contributor

russcam commented Jul 31, 2018

The warning section:

WARNING: Uninstallation will remove all directories and their contents created as part of
installation, including data within the data directory. If you wish to retain your data upon
uninstallation, it is recommended that you make a copy of the data directory beforehand or consider using the snapshot API.

is out of date. Since 6.2.0, the installer does not delete data, config or logs directories upon uninstall.

@russcam
Copy link
Contributor

russcam commented Jul 31, 2018

The note section:

NOTE: {xpack} includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
https://www.elastic.co/subscriptions[available subscriptions] or {ref}/security-settings.html[disable Security].
The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.

should indicate that only the trial license is valid for 30 days; the Basic license is perpetual.

@russcam
Copy link
Contributor

russcam commented Jul 31, 2018 •
edited
Loading

Example code

start /wait msiexec.exe /i elasticsearch-{version}.msi /qn INSTALLDIR="C:\Custom Install Directory" PLUGINS="x-pack"

must include the version as the final directory for INSTALLDIR. This can be achieved by using the {version} attribute and allowing attribute substitutions in the source block

@codebrain
Copy link
Contributor Author

@russcam

  1. Have updated image to reflect new license text.
  2. Replaced all {es} and {xpack}.
  3. Warning section updated to reflect data, config or logs directories not being deleted.
  4. License validity period updated.
  5. Added {version} to install directory via command line.

russcam
russcam reviewed Aug 28, 2018
View reviewed changes
Copy link
Contributor

@russcam russcam left a comment

Choose a reason for hiding this comment

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

Left a couple more comments.

I'm wondering if the term X-Pack should be de-emphasised here too. @eskibars, thoughts?

docs/reference/setup/install/windows.asciidoc Outdated
installation, **including data within the data directory**. If you wish to retain your data upon
uninstallation, it is recommended that you make a copy of the data directory beforehand or consider using the snapshot API.
installation, **except for data, config or logs directories**. If you wish to retain your data upon
uninstallation, it is recommended that you make a copy of your data directory beforehand or consider using the snapshot API.
Copy link
Contributor

Choose a reason for hiding this comment

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

If you wish to retain your data upon uninstallation, it is recommended that you make a copy of your data directory

This doesn't align with the previous sentence, since data directory is not removed on uninstall

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. I think asking the user to backup their data on an upgrade is probably good advice anyway, so will rephrase.

docs/reference/setup/install/windows.asciidoc Outdated

[[msi-installer-xpack]]
image::images/msi_installer/msi_installer_xpack.png[]

NOTE: {xpack} includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
NOTE: X-Pack includes a choice of a Trial license (valid for 30 days) or Basic license (valid perpetually). After that, you can obtain one of the
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be a bit clearer to separate out the license types from their validity e.g.

X-Pack includes a choice of a Trial or Basic license. A Trial license is valid for 30 days, after which you can obtain one of the available subscriptions. The Basic license on the other hand is free and perpetual. Consult the https://www.elastic.co/subscriptions[available subscriptions] for further details on which features are available under which license.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perfect

russcam
russcam approved these changes Aug 29, 2018
View reviewed changes
Copy link
Contributor

@russcam russcam left a comment

Choose a reason for hiding this comment

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

Changes LGTM. I think we can always follow up re: X-Pack in a subsequent PR.

@codebrain codebrain merged commit 4736258 into elastic:6.3 Aug 29, 2018
codebrain pushed a commit that referenced this pull request Aug 29, 2018
@codebrain
Update MSI documentation (#31950)
0b58bf3
@codebrain
Copy link
Contributor Author

Ported to 6.x, 6.3, 6.4 and master

codebrain pushed a commit that referenced this pull request Aug 29, 2018
@codebrain
Update MSI documentation (#31950)
2dc4a5b
dnhatn added a commit that referenced this pull request Aug 29, 2018
@dnhatn
Merge branch 'master' into ccr
5632e31 
* master:
  Painless: Add Bindings (#33042)
  Update version after client credentials backport
  Fix forbidden apis on FIPS (#33202)
  Remote 6.x transport BWC Layer for `_shrink` (#33236)
  Test fix - Graph HLRC tests needed another field adding to randomisation exception list
  HLRC: Add ML Get Records API (#33085)
  [ML] Fix character set finder bug with unencodable charsets (#33234)
  TESTS: Fix overly long lines (#33240)
  Test fix - Graph HLRC test was missing field name to be excluded from randomisation logic
  Remove unsupported group_shard_failures parameter (#33208)
  Update BucketUtils#suggestShardSideQueueSize signature (#33210)
  Parse PEM Key files leniantly (#33173)
  INGEST: Add Pipeline Processor (#32473)
  Core: Add java time xcontent serializers (#33120)
  Consider multi release jars when running third party audit (#33206)
  Update MSI documentation (#31950)
  HLRC: create base timed request class (#33216)
  [DOCS] Fixes command page titles
  HLRC: Move ML protocol classes into client ml package (#33203)
  Scroll queries asking for rescore are considered invalid (#32918)
  Painless: Fix Semicolon Regression (#33212)
  ingest: minor - update test to include dissect (#33211)
  Switch remaining LLREST usage to new style Requests (#33171)
  HLREST: add reindex API (#32679)
dnhatn added a commit that referenced this pull request Aug 29, 2018
@dnhatn
Merge branch '6.x' into ccr-6.x
fd4397e 
* 6.x:
  Fix forbidden apis on FIPS (#33202)
  HLRC: Add ML Get Records API (#33085)
  [ML] Fix character set finder bug with unencodable charsets (#33234)
  Tests fix - Graph HLRC client overly long line and syncing core’s copy of GraphExploreResponseTests taken from protocol. Related to #33231
  Test fix - Graph HLRC test was missing field name to be excluded from randomisation logic
  Parse PEM Key files leniantly (#33173)
  Core: Add java time xcontent serializers (#33120)
  Consider multi release jars when running third party audit (#33206)
  Update MSI documentation (#31950)
  [DOCS] Fixes command page titles
  HLRC: Move ML protocol classes into client ml package (#33203)
  Painless: Fix Semicolon Regression (#33212)
@russcam russcam mentioned this pull request Nov 1, 2018
Closed
@mark-vieira mark-vieira added the Team:Delivery Meta label for Delivery team label Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@russcam russcam russcam approved these changes

Assignees
No one assigned
Labels
:Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts >docs General docs changes Team:Delivery Meta label for Delivery team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@codebrain @elasticmachine @russcam @colings86 @mark-vieira