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.

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

Upgrade guide document #1229

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Upgrade guide document #1229

merged 1 commit into from
Jul 11, 2024

Conversation

ksamoray
Copy link
Collaborator

@ksamoray ksamoray commented Jun 10, 2024

Add a document describing the upgrade process.
Plus improve precheck failure and warning reporting, as it lacks documentation on NSX side.

@ksamoray ksamoray requested review from annakhm and salv-orlando June 10, 2024 09:34
website/docs/guides/upgrade.html.markdown Outdated Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Outdated Show resolved Hide resolved
NSX Terraform Provider offers support for [upgrading NSX components](https://docs.vmware.com/en/VMware-NSX/4.1/upgrade/GUID-E04242D7-EF09-4601-8906-3FA77FBB06BD.html).

The provider support consists of several resources and data sources which can perform a complete upgrade cycle when applied correctly.
The NSX upgrade process upgrades the manager components of NSX, Edge appliances, and the NSX bits on the compute hosts.
Copy link
Member

Choose a reason for hiding this comment

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

Another pedant suggestion, consider replacing with:

"The NSX Terraform provider support upgrades for NSX on ESX hosts, NSX Edge appliances, and NSX manager appliances"

website/docs/guides/upgrade.html.markdown Outdated Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Outdated Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Show resolved Hide resolved
website/docs/guides/upgrade.html.markdown Outdated Show resolved Hide resolved

The provider support consists of several resources and data sources which can perform a complete upgrade cycle.
The NSX Terraform provider support upgrades for NSX on ESX hosts, NSX Edge appliances, and NSX manager appliances.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Lets emphasize that upgrade configuration and state should be dedicated to upgrade only, and not shared with regular terraform config and state
Also do we want to recommend that state is cleared post successful upgrade?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done - I added a note at the beginning of the doc, about state management for upgrade.

host_group {
display_name = "HostWithDifferentSettings"
parallel = false
hosts = ["375c260d-3196-487c-b5eb-046de958f6af"]
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if we should add host data source for this..

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

You mean, within the example? As we do have a host data source (transport_node, and host_transport_node).
Or do you mean a list-providing DS, e.g. nsxt_host_transport_nodes?

Copy link
Collaborator

Choose a reason for hiding this comment

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

No, I think single one is enough. If we can use the existing DS for the transport node here, I think its preferrable

@ksamoray ksamoray force-pushed the upgrade_doc branch 5 times, most recently from c9a5266 to 2ec4ba4 Compare June 20, 2024 11:32

When preparation is complete, it is required to validate the readiness for upgrade using the
[nsxt_upgrade_prepare_ready](../data-sources/upgrade_prepare_ready.html.markdown) data source.
When NSX preparation results with failures or warnings, the data source will result will fail the upgrade.
Copy link
Collaborator

Choose a reason for hiding this comment

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

will result will fail => will fail

Add a document describing the upgrade process.

Signed-off-by: Kobi Samoray <[email protected]>
@ksamoray ksamoray merged commit f1556b6 into vmware:master Jul 11, 2024
3 checks passed
@ksamoray ksamoray deleted the upgrade_doc branch July 11, 2024 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants