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

Cosmos 3546 #207

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Cosmos 3546 #207

wants to merge 5 commits into from

Conversation

vipinakavarpu
Copy link
Contributor

No description provided.

PavitraS
PavitraS reviewed Jul 5, 2023
View reviewed changes
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
@vipinakavarpu vipinakavarpu marked this pull request as ready for review July 12, 2023 22:10
@xmen4xp
Copy link
Contributor

xmen4xp commented Jul 14, 2023

@vipinakavarpu @PavitraS
Some high level comments:

  1. Lets not use the word CRD anywhere. Just call it datamodel.
    CRD is an implementation detail.

  2. We should avoid the term source of truth.
    It is not the source of truth, rather it is previously released or installed datamodel.

  3. We need examples of backward incompatiblity at install time.

  4. Can we structure the doc as follows:

Upgrading the Datamodel
Purpose
What is backward compatibility check?
Build
    Parameters
    When does backward compatibility check fail?
    What is considered a non-breaking change?
        Examples
    What is considered a breaking change?   
        Examples
    How to perform force upgrade ?
        
Install
    Parameters
    When does backward compatibility check fail?
    What is considered a non-breaking change?
        Examples
    What is considered a breaking change?   
        Examples
    How to perform force upgrade ?

xmen4xp
xmen4xp suggested changes Jul 14, 2023
View reviewed changes
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated
1. Ensure there are no CR objects for the dsl node crd that is being upgraded
Port forward port 5001 of nexusapp-mgr pod in cosmos-cd namespace
```
kubectl port-forward -n cosmos-cd nexus-app-mgr-7865f8df58-h7hbj 5018:5001
Copy link
Contributor

Choose a reason for hiding this comment

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

This step is only applicable for Trion (not for Nexus).
So, for Nexus, we should provide the steps to set the force flags via Nexus cli.
For trion, We can capture this detail in a confluence page.

docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md Outdated
<details>
<summary>Show example</summary>

1. Remove the GET URI from the spec
Copy link
Contributor

Choose a reason for hiding this comment

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

This is Not correct.
Removal of an API should be backward incompatible, even if it is GET

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@xmen4xp current behavior is any change to RestAPISpec is backward compatible and that is how expected behavior was documented in UAT test plan (case 12 and 13) https://confluence.eng.vmware.com/display/NSBU/Datamodel+Upgrade+UAT+Plan @rafal-slominskii @PavitraS please update if I am missing anything

Copy link
Contributor

Choose a reason for hiding this comment

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

@xmen4xp IIRC last time when we were talking about this (and testing, as @vipinakavarpu mentioned in UAT plan), we have established that we allow changes in API. We had this idea (as stated with red here https://miro.com/app/board/uXjVOM8wPKU=/?moveToWidget=3458764537971146485&cot=14 ), but conclusion was to allow it.
If thats not the case know, it has to be changed in compare library, as rn its working like that

docs/getting_started/DMUpgrade.md Outdated Show resolved Hide resolved
docs/getting_started/DMUpgrade.md
</details>

## What is considered a backward incompatible change?

Copy link
Contributor

Choose a reason for hiding this comment

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

We also need examples for changes to RestAPISpec that are flagged as backward incompatible.

rafal-slominskii
rafal-slominskii previously approved these changes Jul 14, 2023
View reviewed changes
Copy link
Contributor

@rafal-slominskii rafal-slominskii left a comment

Choose a reason for hiding this comment

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

I think @xmen4xp has raised most of the relevant issues. For me its understandable.

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

@rafal-slominskii rafal-slominskii rafal-slominskii left review comments

@PavitraS PavitraS PavitraS left review comments

@xmen4xp xmen4xp xmen4xp requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
cla-not-required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@vipinakavarpu @xmen4xp @rafal-slominskii @PavitraS @vmwclabot