gitops-operator icon indicating copy to clipboard operation
gitops-operator copied to clipboard

doc: OpenShift argocd CLI client command reference documentation

Open anandf opened this issue 1 year ago • 6 comments

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:

anandf avatar Jan 31 '24 11:01 anandf

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

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

openshift-ci[bot] avatar Jan 31 '24 11:01 openshift-ci[bot]

@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

Srivaralakshmi avatar Feb 09 '24 14:02 Srivaralakshmi

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

Srivaralakshmi avatar Feb 09 '24 14:02 Srivaralakshmi

@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 avatar Feb 13 '24 12:02 anandf

@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

anandf avatar Feb 13 '24 12:02 anandf

@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 75cf183dfac45a2b6fcc1a932f6a2ad659cd9422 link true /test v4.14-ci-index-gitops-operator-bundle
ci/prow/v4.14-images 75cf183dfac45a2b6fcc1a932f6a2ad659cd9422 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/test-infra repository. I understand the commands that are listed here.

openshift-ci[bot] avatar Apr 15 '24 09:04 openshift-ci[bot]