-
Notifications
You must be signed in to change notification settings - Fork 50
add Private Operator Upgrade Policy #894
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 Private Operator Upgrade Policy #894
Conversation
@@ -79,6 +79,10 @@ You'll receive separate `{OPERATOR_KEY}` values for each environment. Be sure to | |||
| Integration (`integ`) | For testing only. Debug mode is available in the integration environment. | | |||
| Production (`prod`) | For managing production traffic. | | |||
|
|||
## Private Operator Upgrade Policy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious why this is separated from the Operator Version section - other cloud pages have the two sections next to each other.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @atarassov-ttd the structure of the AKS doc is different, and the Operator Version section is in the middle of the Deployment section. It'll be great to revisit these docs and make them more parallel. For now, I moved Operator Version up out of the Deployment section so all four docs have these two sections together. They are now both at the top, top heading level, basically -- consistently across all versions. A small step towards consistent structure.
|
||
The following sections provide information about supported versions and, where applicable, the deprecation timeline. | ||
|
||
### Private Operator Upgrade Policy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like this should go under Private Operator Versions section below. Otherwise it looks out of context.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@atarassov-ttd done. But then, I wonder if the version table should go first, and then the upgrade policy second, in the main docs? I put the upgrade policy first, to be noticed. But versioning is first, upgrade is second. I will switch those around actually. (done)
- [Private Operator for AKS](#private-operator-for-aks) | ||
|
||
:::important | ||
If you're using an older version, refer to [Private Operator Upgrade Policy](#private-operator-upgrade-policy) for information about the support lifetime for your version. We recommend upgrading to the latest version as soon as possible to take advantage of new and improved features. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If upgrade policy is moved here, this note would look redundant. Wonder if the recommendation (without reference to the upgrade policy) should go into the Deprecation Schedule section (where the policy is now).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not totally sure I understood this but I updated the wording to refer to the applicable table. I think it's clear. We can do post-release updates if needed.
|
||
### Private Operator for AWS | ||
|
||
The latest ZIP file is linked in the Release Notes column in the following table. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no ZIP file for AWS deployments, so this text does not apply.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, thx. Updated to:
The latest ZIP file is available in the Assets section at the bottom of the linked Release Notes in the following table.
| AKS Version Name | Version #/Release Notes | AKS Download | Date | Deprecation Date | | ||
| ------- | ------ | ------ | ------ | ------ | | ||
| Q2 2025 | TBD | TBD | TBD | TBD | | ||
<!-- | Q1 2025 | 5.49.7 | [v5.49.7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.49.7) | Mar 19, 2025 | Mar 31, 2026 | --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious why this is commented out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@atarassov-ttd good point. It should probably come out -- but we did have this release. The info I was given (LC Confluence page) had it, but if you click through on the link, this artifact does not exist on the page.
If we could provide a different link, we could include this version. Otherwise, we should leave it out.
@clarkxuyang any input?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At the time of release Q1 2025, aks private operator was in final testing. It is not announced as part of Q1 release.
|
||
| Version Name | Version #/Release Notes | AWS Version | Date | Deprecation Date | | ||
| ------- | ------ | ------ | ------ | ------ | | ||
| Q2 2025 | TBD | TBD | TBD | TBD | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we also include projected timelines for the Q4 2025 release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To my understanding, we should mention future releases as little as possible -- ideally not at all. I think we should stick with schedules for what we have. Perhaps a KK adjudication.
:::important | ||
If you're using an older version, refer to the applicable table, Deprecation Date column, for information about the support lifetime for your version. We recommend upgrading to the latest version as soon as possible to take advantage of new and improved features. | ||
::: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest moving the policy here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @atarassov-ttd oops about to publish and just noticed this comment.
I'd previously moved this to below the versions section based on your earlier comment #894 (comment).
The trouble is, the Important note is at the end of the H2 intro and then we have the individual H3 sections for each Private Operator. So it isn't good to interject another H2 section in there. To me, "the versions section" includes the parent and the children.
Given we need to get this out, keeping it as is. But if you take a look and need it moved still, happy to do it as a fast follow.
|
||
### Private Operator for AWS | ||
|
||
The latest ZIP file is available in the Assets section at the bottom of the linked Release Notes in the following table. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@clarkxuyang there is indeed a ZIP for AWS in the release notes. Is it worthwhile linking it here? Our docs are centered around marketplace experience which does not require the zip. Is zip required only for setup experience outside of marketplace?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ZIP is only required for the setup experience outside of the marketplace. The public documentation doesn’t explain how to use it, I feel including the link might cause confusion.
add Private Operator Upgrade Policy, in 4 Private Operator guides plus overview.