doc: OpenShift argocd CLI client command reference documentation #650

anandf · 2024-01-31T11:00:38Z

What type of PR is this?
/kind documentation

What does this PR do / why we need it:

Have you updated the necessary documentation?

Documentation update is required by this PR.
Documentation has been updated.

Which issue(s) this PR fixes:

Fixes #?

Test acceptance criteria:

Unit Test
E2E Test

How to test changes / Special notes to the reviewer:

openshift-ci · 2024-01-31T11:00:56Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from anandf. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Srivaralakshmi

@anandf Thanks for the doc inputs! Left some suggestions for you to consider. PTAL. Thank you!

docs/OpenShift GitOps CLI User Guide.md

docs/cli/argocd_account.md

docs/OpenShift GitOps CLI User Guide.md

Srivaralakshmi · 2024-02-09T14:47:48Z

@anandf How about the updates to these sections?

Update these existing sections:

Srivaralakshmi · 2024-02-09T14:55:48Z

@anandf Can we add some content for these sections, if they are relevant at all?

About the OpenShift argo cd CLI (I think this is a nice to have section)
Logging in to the OpenShift argo cd CLI using a web browser
usage instructions - information that must go as admonitions such as Note, Important, Tip, caution, or warning.

anandf · 2024-02-13T12:41:38Z

@anandf How about the updates to these sections?

Update these existing sections:

Creating an application by using the oc tool

https://docs.openshift.com/gitops/1.11/argocd_applications/deploying-a-spring-boot-application-with-argo-cd.html#creating-an-application-by-using-the-oc-tool_deploying-a-spring-boot-application-with-argo-cd

https://docs.openshift.com/gitops/1.11/declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.html#creating-an-application-by-using-the-oc-tool_configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations

Synchronizing your application with your Git repository

https://docs.openshift.com/gitops/1.11/declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.html#synchronizing-your-application-application-with-your-git-repository_configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations

Added sections for creating and syncing app using CLI in both normal and core modes.

anandf · 2024-02-13T12:43:17Z

@anandf Can we add some content for these sections, if they are relevant at all?

Logging in to the OpenShift argo cd CLI using a web browser

This is not applicable. One has to login via the CLI itself. Its not possible to login via web browser like its possible for oc login

Srivaralakshmi · 2024-02-19T12:29:18Z

docs/OpenShift GitOps CLI User Guide.md

+
+#### Core mode
+
+In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands. The commands would be run as user configured in the kubeconfig file. 


@anandf The commands would be run as user configured in the kubeconfig file.

By this, do you mean that the commands are pre-configured in the kubeconfig file to be automatically run by default for the user from the CLI for executing commands?

I have reworded the sentences to clarify.
In summary, the credentials are available in the kubeconfig file and that would be used for executing the commands in the core mode.

Srivaralakshmi · 2024-02-19T12:38:43Z

docs/OpenShift GitOps CLI User Guide.md

+
+In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands. The commands would be run as user configured in the kubeconfig file. 
+
+  1. With the default context in kubeconfig file


@anandf I guess what you mean is .. for step 1 -- Use this default context in kubeconfig file

and then step 2 is optional if users want to customize the context in case they are using multiple ArgoCD instances. If so, then they must have to use the step 2 option to set the context to interact with the appropriate ArgoCD instance of their choice. Right?

My only confusion is, do they have to edit this [context] parameter? Can we have a quick call tomorrow when you are available to understand this better?

Can we give an example here? I think that will help. WDYT?

Yes. Instead of numbered steps, I have put them as Options so users can choose one of the available options to run the commands. Yes [context] is a placeholder which users have to fill in. I have provided detailed examples for each option.

Thanks @anandf for the clarifications and additional inputs.
The rest LGTM.

Srivaralakshmi · 2024-02-27T13:59:21Z

docs/OpenShift GitOps CLI User Guide.md

+Use the CLI tool to manage Red Hat OpenShift GitOps from a terminal. You can install the CLI tool on different platforms.
+
+### Installing the Red Hat OpenShift GitOps CLI on Linux using an RPM
+For Red Hat Enterprise Linux (RHEL) version 8, you can install the Red Hat OpenShift GitOps CLI as an RPM.


@anandf what about Red Hat Enterprise Linux (RHEL) version 9? is it not applicable?

Should we update this to RHEL 9?

I think its better not to mention the version at all. Customers can be either in RHEL 8/9 version.

@anandf version must be mentioned. something like, For Red Hat Enterprise Linux (RHEL) version 8 and later ?

No mentioning is not a good practice.

Srivaralakshmi · 2024-02-28T07:13:50Z

docs/OpenShift GitOps CLI User Guide.md

+        # subscription-manager repos --enable="gitops-1.12-for-rhel-8-x86_64-rpms"
+        ```
+    - Linux on IBM zSystems and IBM® LinuxONE (s390x)
+        ```
+        # subscription-manager repos --enable="gitops-1.12-for-rhel-8-s390x-rpms"
+        ```
+    - Linux on IBM Power (ppc64le)
+        ```
+        # subscription-manager repos --enable="gitops-1.12-for-rhel-8-ppc64le-rpms"
+        ```
+    - Linux on ARM (aarch64, arm64)
+        ```
+        # subscription-manager repos --enable="gitops-1.12-for-rhel-8-aarch64-rpms"
+        ```


@anandf FOr RHEL 9, would the repo inputs be the following ones?

"gitops-1.12-for-rhel-9-x86_64-rpms"

"gitops-1.12-for-rhel-9-s390x-rpms"

"gitops-1.12-for-rhel-9-ppc64le-rpms"

"gitops-1.12-for-rhel-9-aarch64-rpms"

@anandf Please provide clarifications for these queries:

For ROSA, OSD, and ARO distros, will all these steps, commands, and procedures hold good as is?

Is there any difference between what GitOps offers OCP v/s what we do for OSD, ROSA, and ARO distros?

Can you please confirm that there are no changes or special configurations needed to use GitOps argocd CLI on OSD, ROSA, and ARO distros out of the box?

Thank you!

Srivaralakshmi · 2024-02-28T08:50:14Z

docs/OpenShift GitOps CLI User Guide.md

+You have an active OpenShift Container Platform subscription on your Red Hat account.
+You have root or sudo privileges on your local system.
+#### Procedure
+- Register with Red Hat Subscription Manager:


@anandf Steps should be in an ordered/numbered list as they are a sequence of steps. This comment applies to all the CLI installation procedures on different operating systems.

Srivaralakshmi · 2024-03-05T15:06:10Z

docs/OpenShift GitOps CLI User Guide.md

+      ```
+      # argocd login --username admin --password ${ADMIN_PASSWD} openshift-gitops.openshift-gitops.apps-crc.testing
+      ```
+  3. If the argo application is created with manual sync policy, then the user has to trigger the sync operation manually. This can be done by using the `argocd` CLI in normal mode as below


@anandf The 3rd step of sync procedure in normal mode here must be this right:
argocd app sync openshift-gitops/app-spring-petclinic

For cluster:
argocd app sync openshift-gitops/app-cluster-configs

There is no --core here. Correct?

@anandf In CEE confluence content, we have this 3rd step as extra:

Validate that you are able to run argocd commands in normal mode by executing the following command to list all Applications.
$ argocd app list

Do we need it here too in the downstream docs? Please confirm.

Signed-off-by: Anand Francis Joseph <[email protected]>

…mmands Signed-off-by: Anand Francis Joseph <[email protected]>

Signed-off-by: Anand Francis Joseph <[email protected]>

…onfig file Signed-off-by: Anand Francis Joseph <[email protected]>

Signed-off-by: Anand Francis Joseph <[email protected]>

openshift-ci · 2024-04-15T09:31:32Z

@anandf: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/v4.14-ci-index-gitops-operator-bundle	`75cf183`	link	true	`/test v4.14-ci-index-gitops-operator-bundle`
ci/prow/v4.14-images	`75cf183`	link	true	`/test v4.14-images`

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.

openshift-ci bot added the kind/documentation Improvements or additions to documentation label Jan 31, 2024

openshift-ci bot requested review from jgwest and trdoyle81 January 31, 2024 11:00

Srivaralakshmi reviewed Feb 9, 2024

View reviewed changes

anandf force-pushed the add_cli_documentation branch from 1117176 to 704c8aa Compare February 13, 2024 12:40

Srivaralakshmi reviewed Feb 19, 2024

View reviewed changes

anandf force-pushed the add_cli_documentation branch from 62ff9e0 to 62f769f Compare February 19, 2024 13:06

Srivaralakshmi reviewed Feb 27, 2024

View reviewed changes

Srivaralakshmi reviewed Feb 28, 2024

View reviewed changes

Srivaralakshmi reviewed Mar 5, 2024

View reviewed changes

anandf added 13 commits April 15, 2024 14:57

Initial commit for CLI command reference documentation

12f89b9

Signed-off-by: Anand Francis Joseph <[email protected]>

Added note about core mode of execution for MicroShift installations

f36bae9

Signed-off-by: Anand Francis Joseph <[email protected]>

Updated the version output for verification

120c9a3

Signed-off-by: Anand Francis Joseph <[email protected]>

Converted args to table entries

95d31ff

Signed-off-by: Anand Francis Joseph <[email protected]>

Added configuration section and changed global commands to utility co…

b96e4b0

…mmands Signed-off-by: Anand Francis Joseph <[email protected]>

Formatted basic syntax commands

2569942

Signed-off-by: Anand Francis Joseph <[email protected]>

Added the parent argocd command reference

18665b2

Signed-off-by: Anand Francis Joseph <[email protected]>

Updated the app creation and app sync commands

8527333

Signed-off-by: Anand Francis Joseph <[email protected]>

Added a short description for Global options

2994db7

Signed-off-by: Anand Francis Joseph <[email protected]>

Added tips warning and notes for commands and description for user guide

e69581c

Signed-off-by: Anand Francis Joseph <[email protected]>

Removed accidental commit of unresolved conflicts

ed2086f

Signed-off-by: Anand Francis Joseph <[email protected]>

Addressed review comments related to core mode and options with kubec…

b1f376e

…onfig file Signed-off-by: Anand Francis Joseph <[email protected]>

Corrected some formatting errors and typos

965062a

Signed-off-by: Anand Francis Joseph <[email protected]>

anandf added 10 commits April 15, 2024 14:57

Made some minor corrections

370df4e

Signed-off-by: Anand Francis Joseph <[email protected]>

Added RHEL8 or later and corrected the repo name

6cde0d4

Signed-off-by: Anand Francis Joseph <[email protected]>

Updated repos for RHEL 8 and RHEL 9 separately

7dd2cbf

Signed-off-by: Anand Francis Joseph <[email protected]>

Corrected command for getting the secret and fixed the build info output

a400287

Signed-off-by: Anand Francis Joseph <[email protected]>

Corrected the server url option

edf7cc7

Signed-off-by: Anand Francis Joseph <[email protected]>

Added note about passwords containing shell variables

0e288ea

Signed-off-by: Anand Francis Joseph <[email protected]>

Removed hardcoded password

70713d3

Signed-off-by: Anand Francis Joseph <[email protected]>

Corrected core mode commands after testing

30f5f08

Signed-off-by: Anand Francis Joseph <[email protected]>

Removed sync section when automated sync policy is used

0cc95da

Signed-off-by: Anand Francis Joseph <[email protected]>

Fixed review comments from Kevin and Varsha

75cf183

Signed-off-by: Anand Francis Joseph <[email protected]>

anandf force-pushed the add_cli_documentation branch from b3281fd to 75cf183 Compare April 15, 2024 09:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: OpenShift argocd CLI client command reference documentation #650

doc: OpenShift argocd CLI client command reference documentation #650

anandf commented Jan 31, 2024

openshift-ci bot commented Jan 31, 2024

Srivaralakshmi left a comment

Srivaralakshmi commented Feb 9, 2024 •

edited

Loading

Srivaralakshmi commented Feb 9, 2024

anandf commented Feb 13, 2024

anandf commented Feb 13, 2024 •

edited

Loading

Srivaralakshmi Feb 19, 2024

anandf Feb 20, 2024

Srivaralakshmi Feb 19, 2024

anandf Feb 20, 2024

Srivaralakshmi Feb 20, 2024 •

edited

Loading

Srivaralakshmi Feb 27, 2024

anandf Feb 27, 2024

Srivaralakshmi Feb 27, 2024

Srivaralakshmi Feb 28, 2024 •

edited

Loading

Srivaralakshmi Feb 28, 2024 •

edited

Loading

Srivaralakshmi Feb 28, 2024 •

edited

Loading

Srivaralakshmi Mar 5, 2024 •

edited

Loading

Srivaralakshmi Mar 5, 2024

openshift-ci bot commented Apr 15, 2024 •

edited

Loading


		#### Core mode

		In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands. The commands would be run as user configured in the kubeconfig file.


		In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands. The commands would be run as user configured in the kubeconfig file.

		1. With the default context in kubeconfig file

doc: OpenShift argocd CLI client command reference documentation #650

Are you sure you want to change the base?

doc: OpenShift argocd CLI client command reference documentation #650

Conversation

anandf commented Jan 31, 2024

openshift-ci bot commented Jan 31, 2024

Srivaralakshmi left a comment

Choose a reason for hiding this comment

Srivaralakshmi commented Feb 9, 2024 • edited Loading

Srivaralakshmi commented Feb 9, 2024

anandf commented Feb 13, 2024

anandf commented Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Srivaralakshmi Feb 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Srivaralakshmi Feb 28, 2024 • edited Loading

Choose a reason for hiding this comment

Srivaralakshmi Feb 28, 2024 • edited Loading

Choose a reason for hiding this comment

Srivaralakshmi Feb 28, 2024 • edited Loading

Choose a reason for hiding this comment

Srivaralakshmi Mar 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-ci bot commented Apr 15, 2024 • edited Loading

Srivaralakshmi commented Feb 9, 2024 •

edited

Loading

anandf commented Feb 13, 2024 •

edited

Loading

Srivaralakshmi Feb 20, 2024 •

edited

Loading

Srivaralakshmi Feb 28, 2024 •

edited

Loading

Srivaralakshmi Feb 28, 2024 •

edited

Loading

Srivaralakshmi Feb 28, 2024 •

edited

Loading

Srivaralakshmi Mar 5, 2024 •

edited

Loading

openshift-ci bot commented Apr 15, 2024 •

edited

Loading