Documentation for dynamic scaling of Argo CD application controller.

[masauso-lungu]

• Jira issue: RHDEVDOCS-5617
• CherryPick versions: gitops-docs-1.10 and gitops-docs-1.11 branches
• Doc preview: Dynamic scalling of Argo CD applications
• OCP team: DevTools
• SME reviews by: @ishitasequeira , @reginapizza
• QE reviews by: @varshab1210
• Peer reviews by: @ekristova (draft reviewer), @nalhadef

[ocpdocs-previewbot]

🤖 Updated build preview is available at:
https://67913--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/37291

[eromanova97]

Hello @masauso-lungu I just saw your message about this PR not being finished, but as I already started my review, I will post my initial comments here so that it does not go to waste. I can then do the full review once the PR is finished. Thank you!

Also, the preview link you put in the PR did not work for me, so here is the link if you could please update it :) thanks!
https://67913--docspreview.netlify.app/openshift-gitops/latest/argocd_instance/argo-cd-cr-component-properties#gitops-argo-cd-dynamic-scaling_argo-cd-cr-component-properties

[eromanova97]

Notes from the meeting:
We discussed with @masauso-lungu what would be the best solution to include the CLI steps to enable dynamic scaling of shards.

My suggestion is to not include it as an optional step 6, because I imagine the user would begin the procedure and go from step 1 to step 5 without noticing that there is an alternative solution added as step 6.

There are two solutions that come to mind:

1. First would be to create two procedures, one for web console and second for CLI
   But, as @masauso-lungu correctly pointed out, a lot of the same information would be repeated in these two procedures.

2. The second solution would be to change the procedure as follows:

   • we would have two main bullet points, something like:

     • To enable dynamic shard scaling in web console, follow the steps below.
       1.
       2.
       etc. (that would be the steps that are currently included as steps 1. - 5.)

     • To enable dynamic shard scaling using CLI, run the following command:
       $ oc edit argocd <argocd-instance> -n <namespace> (command from step 6)
       Example
       <add example of the edited YAML file, same as in step 4 of the current procedure>
       Example output
       $ argocd.argoproj.io/<argocd-instance> edited

I hope my description is clear enough, @masauso-lungu please let me know if you want some example of what I mean, but I hope I was able to explain it nicely during our conversation :D Thank you!

[masauso-lungu]

Notes from the meeting: We discussed with @masauso-lungu what would be the best solution to include the CLI steps to enable dynamic scaling of shards.

My suggestion is to not include it as an optional step 6, because I imagine the user would begin the procedure and go from step 1 to step 5 without noticing that there is an alternative solution added as step 6.

There are two solutions that come to mind:

1. First would be to create two procedures, one for web console and second for CLI
   But, as @masauso-lungu correctly pointed out, a lot of the same information would be repeated in these two procedures.

2. The second solution would be to change the procedure as follows:

   • we would have two main bullet points, something like:

     • To enable dynamic shard scaling in web console, follow the steps below.
       1.
       2.
       etc. (that would be the steps that are currently included as steps 1. - 5.)
     • To enable dynamic shard scaling using CLI, run the following command:
       $ oc edit argocd <argocd-instance> -n <namespace> (command from step 6)
       Example
       <add example of the edited YAML file, same as in step 4 of the current procedure>
       Example output
       $ argocd.argoproj.io/<argocd-instance> edited

I hope my description is clear enough, @masauso-lungu please let me know if you want some example of what I mean, but I hope I was able to explain it nicely during our conversation :D Thank you!

Thank you Eliska for the summary. The new commit will be best on the second solution as agreed.

[masauso-lungu]

Hello @ishitasequeira , this PR is ready for reviews.
The files directly linked to this issue are:

1. argocd_instance/argo-cd-cr-component-properties.adoc
2. modules/gitops-argo-cd-dynamic-scaling.adoc

Other files are imported as my PR's content was outdated.

On the section for using the command line interface, I have adjusted the commands to make it easier to verify the cofiguration. Let me know if everything checks out.

[eromanova97]

Hello @masauso-lungu I left some comments so please take a look. I am not feeling the greatest, so I might have missed something or suggested something wrongly. So once you implement the changes or answer to my suggestions, please ping me and I look at the issue once again. Thank you for understanding!

[masauso-lungu]

Hello @ishitasequeira kindly review the content of this PR.

[reginapizza]

just a couple typo comments but otherwise LGTM

[masauso-lungu]

/label sme-review-done

[varshab1210]

LGTM, thanks

[masauso-lungu]

LGTM, thanks

Thank you @varshab1210

[masauso-lungu]

/label qe-approved

[masauso-lungu]

/label peer-review-needed

[nalhadef]

/label peer-review-in-progress
/remove-label peer-review-needed

[Srivaralakshmi]

@ekristova Great! Because both topics are advanced level, they must reside under the Declarative cluster configuration chapter. Also, can you please do a thorough review of this PR? I see scope for improvements and it will be a good experience for both of you. Thanks!

@masauso-lungu please sync up with @ekristova. TY!

[masauso-lungu]

Hello @masauso-lungu @Srivaralakshmi I actually have an idea about how to include this. I am working on it in my PR: https://github.com/openshift/openshift-docs/pull/69199/files#diff-4c57a7ed081d06dddb5c1f711b55565a1a847260a3311ad3bf911ea3a0e6af49R13

You can see I added a note where would the sharding section go. I am trying to connect with SME to have the changes addressed as soon as possible, but I had no luck so far so I am not sure when this is going to be merged. So in the meantime, @masauso-lungu can you contact me so that we can discuss this? Thank you!

Thank you @ekristova .....

[eromanova97]

Hello @masauso-lungu to make it as easy as possible for you, I quickly added comments explaining what needs to be changed in structure. I will do a thorough review later but I wanted to give you these tips as soon as possible so that you are not blocked :) Thank you!

[eromanova97]

I went through the PR thoroughly now and I had some more suggestions, I hope it is helpful. I know that it must be frustrating that we are changing things again, but hopefully these are the last big changes that should happen :) Thank you!

[Srivaralakshmi]

@masauso-lungu Thanks for the good work! Left a few suggestions for you to consider.

[eromanova97]

Hello @masauso-lungu there is one more small adjustment that needs to be done, it is based on this peer review comment I received: #69199 (comment) so please create the modules the same way as it is in my PR now.
Other than that, my PR is currently going through the merge review so once it is merged, you can rebase and add your sections under the round-robin module, as I commented here in the assembly. Thank you!

Edit: my issue is now merged :)

[eromanova97]

Hello @masauso-lungu good work! I have just very small suggestions for you, otherwise looks good to me! :)

Also, I have just one additional question, I was just curious, if we could utilize checking the logs for the verification of this feature, similarly to the round-robin algorithm procedure. It is just something I wondered about :) Thank you!

[masauso-lungu]

/label merge-review-needed

[skrthomas]

I have a few style things I noted you probably should consider/address before merging. Just ping me on Slack when you have them incorporated or if you have any questions :)

[skrthomas]

/cherrypick gitops-docs-1.10

[skrthomas]

/cherrypick gitops-docs-1.11

[openshift-cherrypick-robot]

@skrthomas: new pull request created: #70694

In response to this:

/cherrypick gitops-docs-1.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.

[openshift-cherrypick-robot]

@skrthomas: new pull request created: #70695

In response to this:

/cherrypick gitops-docs-1.11

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.