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

Add 3.0 to 3.1 migration documentation #456

Merged
merged 9 commits into from
Oct 10, 2024

Conversation

ipetrov117
Copy link
Contributor

Adds migration documentation to our "Day 2" docs that specifies the steps users should take in order to migrate their 3.0.X Edge environments to Edge 3.1.

Copy link
Contributor

@atanasdinov atanasdinov left a comment

Choose a reason for hiding this comment

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

LGTM! Raised some points for discussion but happy to approve after we align on those.

asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
Comment on lines 1002 to 1004
=== Migration steps

After executing the <<day2-migration-downstream-prerequisites, prerequisite>> steps, you can proceed to follow the <<day2-downstream-clusters, downstream cluster>> upgrade documentation for the `Edge 3.1` release.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need this section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

IMO, yes. This marks the logical next step to the downstream cluster update mechanism. Without it users will not be sure where to proceed once the prerequisite steps have concluded.

Copy link
Contributor

Choose a reason for hiding this comment

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

This might be somewhat related to #456 (comment) and how we lay out the structure itself.

Copy link
Collaborator

@ranjinimn ranjinimn left a comment

Choose a reason for hiding this comment

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

@ipetrov117 I have a few suggestions.
Apart from that, I will need to review the local PDF version of the document to let you know about the sections and sub sections. Can you please upload it here? Else, I will generate a PDF and check if it the sections and sub sections look okay.

For a list of `Edge 3.1` component versions, refer to the <<release-notes, release notes>>.

[#day2-migration-mgmt]
== Management cluster
Copy link
Collaborator

Choose a reason for hiding this comment

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

can you please share the locally generated PDF of this content? That would help me to assess the TOC, sub sections.

[#day2-migration-mgmt]
== Management cluster

This section covers how to migrate a `management` cluster from `Edge 3.0` to `Edge 3.1.0`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

please help me understand. Are we creating Edge 3.1.0? or Just 3.1? The reason I ask is because for Edge 3.0, only Edge 3.0 was created and not 3.0.0.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We are migrating a 3.0 cluster to the Edge 3.1.0 release. I am not sure what the best versioning convention should be here. Lemme know if I should change this to 3.1 instead.

asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
asciidoc/day2/migration.adoc Outdated Show resolved Hide resolved
@ipetrov117 ipetrov117 merged commit cecf91d into suse-edge:main Oct 10, 2024
1 check passed
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.

5 participants