RHDEVDOCS-3567 - Release notes for v1.3.2#40110
Conversation
openshift-ci
bot
added
the
size/M
|
✔️ Deploy Preview for osdocs ready! 🔨 Explore the source changes: 38a55f0 🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/61c5cd9297ffc000076f7c1e 😎 Browse the preview: https://deploy-preview-40110--osdocs.netlify.app |
|
@reginapizza @iam-veeramalla @varshab1210 Please review |
There was a problem hiding this comment.
Please change the release to 1.3.2
There was a problem hiding this comment.
Dont we update patch releases here ?
1.3.0 does not support Dex 2.30.0, it is actually supported by 1.3.2. To be more clear I think we should update the dependency matrix for z-stream releases as well.
There was a problem hiding this comment.
since it should be changed to since.
There was a problem hiding this comment.
I am now confused, do we call it application-scoped Argo CD or namespace scoped Argo CD. Can you tell me where did you find the phrase application-scoped Argo CD ?
There was a problem hiding this comment.
Please add JIRA IDs for all the bugs.
|
@DebarghoGhosh I understand that we have upgraded the support matrix to reflect the Dex version upgrade as well as Argo CD version upgrade but can we also add this as a pointer to make it much visible. |
|
LGTM |
There was a problem hiding this comment.
While past tense is fine here too, the most widely used tenses in RNs would be present or present perfect (are resolved or have been resolved), because our focus isn't on the process in the past but on the result in the present.
There was a problem hiding this comment.
| * Upgraded Argo CD to version *v2.1.8* | |
| * Upgraded Argo CD to version *2.1.8* |
imo, looks a bit cleaner without v.
Also the word version is already used.
And other versions in this doc don't contain v. in front of them, keeping the format consistent would be nice.
There was a problem hiding this comment.
| * Upgraded Dex to version *v2.30.0* | |
| * Upgraded Dex to version *2.30.0* |
There was a problem hiding this comment.
| * Previously, in the `OperaturHub` if you filter by "Disconnected" under the *Infrastructure Features* the {gitops-title} did not appear, since the Operator did not had the related annotation set in its CSV. The {gitops-title} is now annotated with "Disconnected Cluster" as an *Infrastructure Feature*. link:https://issues.redhat.com/browse/GITOPS-1539[GITOPS-1539] | |
| * Previously, the {gitops-title} did not appear in the `OperatorHub` when you filtered by "Disconnected" under the *Infrastructure Features*, since the Operator did not have the related annotation set in its CSV. With this update, the {gitops-title} is annotated with "Disconnected Cluster" as an *Infrastructure Feature*. link:https://issues.redhat.com/browse/GITOPS-1539[GITOPS-1539] |
There was a problem hiding this comment.
| * Previously, the ArgoCD operator managed the `resource.exclusion` by itself but it completely ignored the `resource.inclusion`. This prevented the Resource Inclusion configured in Argo CD CR to generate in the `argocd-cm configmap`. This bug is fixed.link:https://issues.redhat.com/browse/GITOPS-1518[GITOPS-1518] | |
| * Previously, the ArgoCD operator managed the `resource.exclusion` by itself but ignored the `resource.inclusion`. This prevented the Resource Inclusion configured in Argo CD CR to generate in the `argocd-cm configmap`. This bug is fixed. link:https://issues.redhat.com/browse/GITOPS-1518[GITOPS-1518] |
There was a problem hiding this comment.
| * {gitops-title} is now annotated as "Deep Insights" under the *Capability* Level. link:https://issues.redhat.com/browse/GITOPS-1519[GITOPS-1519] | |
| * {gitops-title} is annotated as "Deep Insights" under the *Capability* Level. link:https://issues.redhat.com/browse/GITOPS-1519[GITOPS-1519] |
Most instances of "now" can be easily removed from the release notes. RH templates avoid using "now" as it can be misleading, the context for the changes is the release version, not "now". Hope it makes sense. Current templates: https://redhat-documentation.github.io/supplementary-style-guide/#release-notes
There was a problem hiding this comment.
| * When using an "Namespace-scoped" argocd (e.g. one that is not scoped to All Namepsaces in a cluster), the {gitops-title} dynamically maintains a list of managed namespaces. These namespaces includes the `argocd.argoproj.io/managed-by` label. This list of namespaces gets cached in argocd *Settings > Clusters > "in-cluster" > NAMESPACES*. However, if one of these namespaces gets deleted, the operator doesn't seem to notice, and the namespace remains in that list. This breaks both the *CONNECTION STATE* in that cluster config, and also all sync attempts after the namespace gets deleted. The sync will show errors. For example: | |
| * When using an "Namespace-scoped" argocd, for example, argocd that is not scoped to All Namepsaces in a cluster, the {gitops-title} dynamically maintains a list of managed namespaces. These namespaces include the `argocd.argoproj.io/managed-by` label. This list of namespaces is stored in a cache in argocd *Settings > Clusters > "in-cluster" > NAMESPACES*. Before this update, if you deleted one of these namespaces, the Operator ignored that, and the namespace remained in the list. This behavior broke the *CONNECTION STATE* in that cluster configuration, and all sync attempts resulted in errors. For example: |
Most suggestions are based on the IBM SG. We should avoid using Latin abbreviations (e.g.) and using "cache" as a verb. Gets deleted is a bit colloquial. And we always describe previous problems with the past tenses.
DebarghoGhosh
force-pushed
the
release-notes-v1.3.2-3567
branch
from
f6b6eca to
903f504
Compare
Preeticp
left a comment
Preeticp
left a comment
There was a problem hiding this comment.
@DebarghoGhosh PTAL at the suggestions.
There was a problem hiding this comment.
the {gitops-title} Operator
disconnected We do not use double quotes to indicate GUI features/user entered values
CSV file?
There was a problem hiding this comment.
| * Previously, the {gitops-title} did not appear in the `OperatorHub` when you filtered by "Disconnected" under the *Infrastructure Features*, since the Operator did not have the related annotation set in its CSV. With this update, the {gitops-title} is annotated with "Disconnected Cluster" as an *Infrastructure Feature* link:https://issues.redhat.com/browse/GITOPS-1539[GITOPS-1539] | |
| * Previously, in the OperatorHub UI under the *Infrastructure Features* section, when you filtered by `Disconnected` the {gitops-title} Operator did not show in the search results, as the Operator did not have the related annotation set in its CSV file. With this update, the `Disconnected Cluster` annotation has been added to the {gitops-title} Operator as an infrastructure feature. link:https://issues.redhat.com/browse/GITOPS-1539[GITOPS-1539] |
There was a problem hiding this comment.
- a
Namespace-scopedArgo CD instance, - example, an Argo CD instance that is...
- argocd - Argo CD names of products need to be mentioned as is with the appropriate case, space etc. Please check all the instances in the PR.
- the {gitops-title}/{gitops-title} - An article is not required in this case.
- argocd Settings > Clusters > "in-cluster" > NAMESPACES./Argo CD -> Settings -> Clusters -> "in-cluster" -> NAMESPACES. Please go through the OCP doc contributing guidelines: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#quick-markup-reference
There was a problem hiding this comment.
Check System or software variable to be replaced by the user: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#quick-markup-reference Also see Supplementary style guide for more details.
<random_verb>
<random_resource_type>
the-namespace-you-deleted - add angular bracket and replace - with _
There was a problem hiding this comment.
This should be The {gitops-title} Operator
Deep Insights
Suggest: With this update, the {gitops-title} Operator has been annotated with the Deep Insights capability level.
There was a problem hiding this comment.
Argo CD Operator
the resource.exclusion/resource.inclusion field
the resource.inclusion field configured in the Argo CD CR
argocd-cm configuration map
Preeticp
added
branch/enterprise-4.9
branch/enterprise-4.10
dev-tools
|
Can you please confirm if this needs to be part of 4.8 as well? 4.9 and 4.10 seem to be the correct versions. |
Preeticp
added
peer-review-done
DebarghoGhosh
force-pushed
the
release-notes-v1.3.2-3567
branch
from
c90a324 to
563a0ca
Compare
made review changes build error made review changes review changes done made review changes
DebarghoGhosh
force-pushed
the
release-notes-v1.3.2-3567
branch
from
af40abc to
38a55f0
Compare
|
/cherrypick enterprise-4.9 |
|
/cherrypick enterprise-4.10 |
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
|
@Preeticp: new pull request created: #40163 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@Preeticp: new pull request created: #40164 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
5 participants
Aligned team: Dev Tools
OCP version for cherry-picking: enterprise-4.9
JIRA issues:https://issues.redhat.com/browse/RHDEVDOCS-3567
Preview pages: https://deploy-preview-40110--osdocs.netlify.app/openshift-enterprise/latest/cicd/gitops/gitops-release-notes
SME+QE review:
Peer-review: