-
Notifications
You must be signed in to change notification settings - Fork 1.8k
RHDEVDOCS-6449: Content creation for the Progressive Sync feature #98296
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
base: gitops-docs-main
Are you sure you want to change the base?
RHDEVDOCS-6449: Content creation for the Progressive Sync feature #98296
Conversation
@Dhruv-Soni11: This pull request references RHDEVDOCS-6449 which is a valid jira issue. In 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 openshift-eng/jira-lifecycle-plugin repository. |
🤖 Wed Sep 17 07:52:06 - Prow CI generated the docs preview: |
90b551f
to
1b7d62e
Compare
/retest |
/retest-required |
96ac556
to
014d597
Compare
@Dhruv-Soni11: This pull request references RHDEVDOCS-6449 which is a valid jira issue. In 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 openshift-eng/jira-lifecycle-plugin repository. |
@Dhruv-Soni11: This pull request references RHDEVDOCS-6449 which is a valid jira issue. In 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 openshift-eng/jira-lifecycle-plugin repository. |
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
argocd_application_sets/using-progressive-sync-in-openshift-gitops.adoc
Outdated
Show resolved
Hide resolved
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.
updated my comments
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.
argocd_application_sets/using-progressive-sync-in-openshift-gitops.adoc
Outdated
Show resolved
Hide resolved
argocd_application_sets/using-progressive-sync-in-openshift-gitops.adoc
Outdated
Show resolved
Hide resolved
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
8850d23
to
ac2ec16
Compare
argocd_application_sets/using-progressive-sync-in-openshift-gitops.adoc
Outdated
Show resolved
Hide resolved
LGTM, thanks |
b540e6d
to
bfef928
Compare
@Dhruv-Soni11: This pull request references RHDEVDOCS-6449 which is a valid jira issue. In 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 openshift-eng/jira-lifecycle-plugin repository. |
Thanks @Dhruv-Soni11, LGTM! |
argocd_application_sets/using-progressive-sync-in-openshift-gitops.adoc
Outdated
Show resolved
Hide resolved
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
modules/gitops-creating-appset-sync-manifest-using-rollingsync.adoc
Outdated
Show resolved
Hide resolved
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.
LGTM, a quick case correction suggested above.
6f2df65
to
2f734f8
Compare
Incorporating SME review comments Adding QE and SME feedback Incorporating additional SME review comments
2f734f8
to
d261338
Compare
@Dhruv-Soni11: all tests passed! Full PR test history. Your PR dashboard. 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-sigs/prow repository. I understand the commands that are listed 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.
this look good to me, a few minor suggestions, but it all depends on whether we are allowed to publish about alpha-quality s/w
* You have logged in to the {OCP} cluster as an administrator. | ||
* You have installed the {gitops-shortname} Operator on your {OCP} cluster. | ||
* You can access the default Argo CD instance in the `openshift-gitops` namespace. | ||
* You have created an Argo CD ApplicationSet in your defined namespace, for example, `openshift-gitops`. |
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.
* You have created an Argo CD ApplicationSet in your defined namespace, for example, `openshift-gitops`. | |
* You have created an Argo CD `ApplicationSet` resource/controller in your defined namespace, for example, `openshift-gitops`. |
|
||
[IMPORTANT] | ||
==== | ||
This is an experimental, alpha-quality feature. It allows you to control the order in which the `ApplicationSet` controller creates or updates the Applications owned by an `ApplicationSet` resource. The feature might be removed in future releases or changed in a non-backwards-compatible way. For more information, see the upstream documentation for link:https://github.com/argoproj/argoproj/blob/main/community/feature-status.md#alpha[Feature Status in Argo Projects (Github docs)]. |
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.
We need a decision here from DPM/CS over whether we can publish alpha-quality s/w, due to support considerations. Is this dev preview or tech preview?
* You have installed the {gitops-shortname} Operator on your {OCP} cluster. | ||
* You can access the default Argo CD instance in the `openshift-gitops` namespace. | ||
* You have created an Argo CD ApplicationSet in your defined namespace, for example, `openshift-gitops`. | ||
* You have created a few Argo CD applications using an Argo CD ApplicationSet, which is defined in your namespace, for example, `openshift-gitops`. |
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.
as above for ApplicationSet
|
||
.Procedure | ||
|
||
. Set the `RollingSync` parameter for the `applicationSet` spec. The following example contains a sample YAML configuration. |
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.
. Set the `RollingSync` parameter for the `applicationSet` spec. The following example contains a sample YAML configuration. | |
. Set the `RollingSync` parameter for the `ApplicationSet` spec. The following example contains a sample YAML configuration. |
namespace: guestbook-{{.env}} | ||
---- | ||
|
||
. Apply the YAML file by running the following command. |
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.
. Apply the YAML file by running the following command. | |
. Apply the YAML file by running the following command: |
|
||
If the **Progressive Sync** section is missing from the Application details: | ||
|
||
* Confirm that the application is managed by an `ApplicationSet` with the `RollingSync` strategy. |
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.
* Confirm that the application is managed by an `ApplicationSet` with the `RollingSync` strategy. | |
* Confirm that the application is managed by an `ApplicationSet` controller with the `RollingSync` strategy. |
|
||
:_mod-docs-content-type: PROCEDURE | ||
[id="gitops-adding-extraCommandArgs-to-argo-cd_{context}"] | ||
= Adding the 'extraCommandArgs' argument to the Argo CD CR |
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 think these are meant to be ticks indicating code, instead of single quotes - 'extraCommandArgs'
But again I don't think we are allowed to have styled content in titles, according to style guide, so maybe just leave plain
OCP docs has a strict policy of not documenting dev preview content , only tech preview. It may be possible for a Content Strategist or DPM to get an exception to this rule, but this probably needs the approval of the support team. More information available here: https://redhat-documentation.github.io/supplementary-style-guide/#developer-preview-guidance
|
Version(s):
gitops-docs-1.18
Issue:
https://issues.redhat.com/browse/RHDEVDOCS-6449
Link to docs preview:
Using Progressive Sync in OpenShift GitOps
QE review:
SME review: atali@redhat.com
QE review: @varshab1210
Peer review:
Additional information: