Story (Required)

As an enduser trying to operate ArgoCD using CLI tool, I want documentation on how to install, configure and run the CLI commands.

Background (Required)

ArgoCD CLI is being productized and released as part of the OpenShift GitOps product starting from v1.12.0. This requires documentation to explain the end user on how to use the CLI commands and use them for managing ArgoCD artifacts via the CLI.

Out of scope

None

Approach (Required)

Documentation where we provide information on how an application should be created/synced should be updated to have a section explaining how it needs to be done via the CLI.

• 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-opensh[…]y-deploying-an-application-with-cluster-configurations.html

Installation and Getting started section should be provided for instructions on how customers can install the binary on their laptops.

Command Reference should be provided for the various commands.

Dependencies

The CPaaS builds and the RPM containing the binary is available.

Acceptance Criteria (Mandatory)

• Installation instructions are available.
• Command reference is available.
• Existing document sections where Argo resource management is explained via the UI, should also have a section for explaining the same steps via CLI.

INVEST Checklist

Dependencies identified

Blockers noted and expected delivery timelines set

Design is implementable

Acceptance criteria agreed upon

Story estimated

Legend

Unknown

Verified

Unsatisfied

Done Checklist

• Code is completed, reviewed, documented and checked in
• Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
• Continuous Delivery pipeline(s) is able to proceed with new code included
• Customer facing documentation, API docs etc. are produced/updated, reviewed and published
• Acceptance criteria are met