Skip to content

Make it clear the settings need to be applied after restoring to an unconfigured instance #381

Merged
lildude merged 4 commits into
masterfrom
keeran/update-restore-message
Mar 27, 2018
Merged

Make it clear the settings need to be applied after restoring to an unconfigured instance #381
lildude merged 4 commits into
masterfrom
keeran/update-restore-message

Conversation

@keeran

@keeran keeran commented Mar 26, 2018

Copy link
Copy Markdown

Following a restore we should prompt the user to save settings on the appliance as this will trigger any necessary migrations.

Comment thread bin/ghe-restore Outdated

if ! $cluster; then
echo "Visit https://$hostname/setup/settings to review appliance configuration."
echo "Visit https://$hostname/setup/settings to review appliance configuration. Settings must be applied to complete any necessary migrations."

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.

How about:

You must now visit https://$hostname/setup/settings to review and save appliance configuration

I feel like this is giving a direct command to the user and actually mentions 'saving' the configuration. Users who are unfamiliar with GHE may not know that hitting 'Save settings' is the equivalent of 'applying settings'?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agree we should probably be a little firmer here, though "you must" feels a little odd to me.

How about:

Please visit https://$hostname/setup/settings to review and save the appliance configuration.

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 still feel that sounds almost optional though… How about:

To complete the restore process, please visit https://$hostname/setup/settings to review and save the appliance configuration.

Then at least we're giving people the reason for doing this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oooo, nice ✨

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Hahah words are hard. Hesitated making this change due to the repetition of 'complete' (previous output says it's complete, now I need to do something to complete it). If neither of you think it's an issue I'll go ahead with it :)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good point @keeran. How about changing "Completed" in the line above to "Finished", so users will see:

Finished restore of 5.5.5.5:122 from snapshot 20180326T020444
To complete the restore process, please visit https://5.5.5.5/setup/settings to review and save the appliance configuration.

Or move to the end of the line:

Restore of 5.5.5.5:122 from snapshot 20180326T020444 finished.
To complete the restore process, please visit https://5.5.5.5/setup/settings to review and save the appliance configuration.

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.

@keeran @lildude good suggestions 👍

My vote goes for the second one:

Restore of 5.5.5.5:122 from snapshot 20180326T020444 finished.
To complete the restore process, please visit https://5.5.5.5/setup/settings to review and save the appliance configuration.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Thanks chaps! ✨

@keeran keeran self-assigned this Mar 26, 2018
snh
snh previously requested changes Mar 27, 2018
Comment thread bin/ghe-restore

if ! $cluster; then
echo "Visit https://$hostname/setup/settings to review appliance configuration."
echo "To complete the restore process, please visit https://$hostname/setup/settings to review and save the appliance configuration."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It should only be necessary to do this if you are restoring on to an unconfirmed appliance, as we automatically run ghe-config-apply on configured appliances at the end of the restore process:

# When restoring to a host that has already been configured, kick off a
# config run to perform data migrations.
if $cluster; then
echo "Configuring cluster ..."
ghe-ssh "$GHE_HOSTNAME" -- "ghe-cluster-config-apply" 1>&3 2>&3
elif $instance_configured; then
echo "Configuring storage ..."
if [ "$GHE_VERSION_MAJOR" -ge 2 ]; then
ghe-ssh "$GHE_HOSTNAME" -- "ghe-config-apply --full" 1>&3 2>&3
else
echo " This will take several minutes to complete..."
ghe-ssh "$GHE_HOSTNAME" -- "sudo enterprise-configure" 1>&3 2>&3
fi
fi

Maybe the if could be changed to if ! $instance_configured; then so that this message only appears on un-configured appliances.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah, good point. Nice catch @snh.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@keeran don't forget this 😉 (I'd like to merge this before merging by big PR so it makes it in before I create the legacy branch).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

@lildude ooops - read pre-coffee, thanks :)

Comment thread bin/ghe-restore Outdated
fi

echo "Completed restore of $GHE_HOSTNAME from snapshot $GHE_RESTORE_SNAPSHOT"
echo "Finished restore of $GHE_HOSTNAME from snapshot $GHE_RESTORE_SNAPSHOT"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Re-reading this, I think we should go with the second wording as per #381 (comment)

@lildude lildude left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@rubiojr rubiojr dismissed snh’s stale review March 27, 2018 13:02

release time

@lildude lildude merged commit dc27068 into master Mar 27, 2018
@lildude lildude deleted the keeran/update-restore-message branch March 27, 2018 13:09
@lildude lildude changed the title Update post-restore messaging Make it clear the settings need to be applied after restoring to an unconfigured instance Mar 27, 2018
@lildude lildude mentioned this pull request Mar 27, 2018
dooleydevin pushed a commit that referenced this pull request Jul 14, 2023
…t-always-restore-column-encryption-keys

Backport 349 for 3.9: Always restore column encryption keys
@dooleydevin dooleydevin mentioned this pull request Jul 26, 2023
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