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

RHDEVDOCS-3567 - Release notes for v1.3.2 #40110

Merged
merged 1 commit into from
Dec 24, 2021

Conversation

DebarghoGhosh
Copy link
Contributor

@DebarghoGhosh DebarghoGhosh commented Dec 22, 2021

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:

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 22, 2021
@netlify
Copy link

netlify bot commented Dec 22, 2021

✔️ 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

@DebarghoGhosh
Copy link
Contributor Author

@reginapizza @iam-veeramalla @varshab1210 Please review

[id="gitops-release-notes-1-3-2_{context}"]
= Release notes for {gitops-title} 1.3.2

{gitops-title} 1.3.1 is now available on {product-title} 4.6, 4.7, 4.8, and 4.9.

Choose a reason for hiding this comment

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

Please change the release to 1.3.2

@@ -15,7 +15,7 @@ In the table, features are marked with the following statuses:
|*OpenShift GitOps* 6+|*Component Versions*|*OpenShift Versions*|*Support status*

|*Version*|*kam*|*Helm*|*Kustomize*|*Argo CD*|*ApplicationSet*|*Dex*||
|1.3.0|0.0.40|3.6.0|4.2.0|2.1.2|0.2.0|2.28.0|4.6-4.9|GA
|1.3.0|0.0.40|3.6.0|4.2.0|2.1.8|0.2.0|2.30.0|4.6-4.9|GA

Choose a reason for hiding this comment

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

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.

[id="fixed-issues-1-3-2_{context}"]
== Fixed issues

* Previously, in the `OperaturHub` if you filter by "Disconnected" under the *Infrastructure Features* the {gitops-title} did not appear, since it 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*.

Choose a reason for hiding this comment

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

since it should be changed to since.


* Previously, in the `OperaturHub` if you filter by "Disconnected" under the *Infrastructure Features* the {gitops-title} did not appear, since it 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*.

* When using an "Application-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:

Choose a reason for hiding this comment

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

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 ?

Argo service account does not have <random verb> on <random resource type> in namespace the-namespace-you-deleted.
----
+
This bug is fixed.

Choose a reason for hiding this comment

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

Please add JIRA IDs for all the bugs.

@iam-veeramalla
Copy link

@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.

@iam-veeramalla
Copy link

LGTM

[id="fixed-issues-1-3-2_{context}"]
== Fixed issues

The following issues were resolved in the current release:

Choose a reason for hiding this comment

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

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.


In addition to the fixes and stability improvements, the following sections highlight what is new in {gitops-title} 1.3.2:

* Upgraded Argo CD to version *v2.1.8*

Choose a reason for hiding this comment

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

Suggested change
* 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.


* Upgraded Argo CD to version *v2.1.8*

* Upgraded Dex to version *v2.30.0*

Choose a reason for hiding this comment

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

Suggested change
* Upgraded Dex to version *v2.30.0*
* Upgraded Dex to version *2.30.0*


The following issues were resolved in the current release:

* 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]

Choose a reason for hiding this comment

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

Suggested change
* 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]


* {gitops-title} is now annotated as "Deep Insights" under the *Capability* Level. link:https://issues.redhat.com/browse/GITOPS-1519[GITOPS-1519]

* 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]

Choose a reason for hiding this comment

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

Suggested change
* 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]

+
This bug is fixed. link:https://issues.redhat.com/browse/GITOPS-1521[GITOPS-1521]

* {gitops-title} is now annotated as "Deep Insights" under the *Capability* Level. link:https://issues.redhat.com/browse/GITOPS-1519[GITOPS-1519]

Choose a reason for hiding this comment

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

Suggested change
* {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


* 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]

* 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:

Choose a reason for hiding this comment

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

Suggested change
* 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.

Copy link
Contributor

@Preeticp Preeticp left a comment

Choose a reason for hiding this comment

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

@DebarghoGhosh PTAL at the suggestions.


The following issues have been resolved in the current release:

* 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]
Copy link
Contributor

@Preeticp Preeticp Dec 24, 2021

Choose a reason for hiding this comment

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

the {gitops-title} Operator
disconnected We do not use double quotes to indicate GUI features/user entered values
CSV file?

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* 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]

Copy link
Contributor

Choose a reason for hiding this comment

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

the Disconnected Cluster - should this be disconnected see the doc link provided in the issue )


* 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]

* 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:
Copy link
Contributor

Choose a reason for hiding this comment

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

  • a Namespace-scoped Argo 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

+
[source,text]
----
Argo service account does not have <random verb> on <random resource type> in namespace the-namespace-you-deleted.
Copy link
Contributor

Choose a reason for hiding this comment

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

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 _

+
This bug is fixed. link:https://issues.redhat.com/browse/GITOPS-1521[GITOPS-1521]

* {gitops-title} is annotated as "Deep Insights" under the *Capability* Level. link:https://issues.redhat.com/browse/GITOPS-1519[GITOPS-1519]
Copy link
Contributor

@Preeticp Preeticp Dec 24, 2021

Choose a reason for hiding this comment

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

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.


* {gitops-title} is annotated as "Deep Insights" under the *Capability* Level. link:https://issues.redhat.com/browse/GITOPS-1519[GITOPS-1519]

* 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]
Copy link
Contributor

Choose a reason for hiding this comment

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

Argo CD Operator
the resource.exclusion/resource.inclusion field
the resource.inclusion field configured in the Argo CD CR
argocd-cm configuration map

@Preeticp Preeticp added branch/enterprise-4.9 branch/enterprise-4.10 dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs labels Dec 24, 2021
@Preeticp Preeticp added this to the Next Release milestone Dec 24, 2021
@Preeticp
Copy link
Contributor

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 Preeticp added peer-review-done Signifies that the peer review team has reviewed this PR do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Dec 24, 2021
made review changes

build error

made review changes

review changes done

made review changes
@Preeticp Preeticp added the lgtm Indicates that a PR is ready to be merged. label Dec 24, 2021
@Preeticp Preeticp merged commit 7325f06 into openshift:main Dec 24, 2021
@Preeticp
Copy link
Contributor

/cherrypick enterprise-4.9

@Preeticp
Copy link
Contributor

/cherrypick enterprise-4.10

@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 24, 2021
@openshift-cherrypick-robot

@Preeticp: new pull request created: #40163

In response to this:

/cherrypick enterprise-4.9

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.

@openshift-cherrypick-robot

@Preeticp: new pull request created: #40164

In response to this:

/cherrypick enterprise-4.10

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.9 branch/enterprise-4.10 dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs lgtm Indicates that a PR is ready to be merged. peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants