Skip to content

Commit

Permalink
Added tips warning and notes for commands and description for user guide
Browse files Browse the repository at this point in the history
Signed-off-by: Anand Francis Joseph <[email protected]>
  • Loading branch information
anandf committed Feb 19, 2024
1 parent 1567edf commit d3ffa79
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/OpenShift GitOps CLI User Guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# OpenShift GitOps CLI User Guide
<<<<<<< Updated upstream
=======
OpenShift GitOps `argocd` CLI enables users to manage OpenShift GitOps from a terminal. Using the CLI tool, users can manage ArgoCD resources (Application, ApplicationSets, AppProjects, User accounts, GPG keys etc) from a client terminal.

**Note:** Both the archives and the RPMs contain the `argocd` executable binary file.

**WARNING**
Red Hat OpenShift GitOps with the `argocd` CLI tool is a Technology Preview feature only.

**Tip:** This guide assumes you have a grounding in the tools that OpenShift GitOps is based on. Please read [about Red Hat OpenShift GitOps](https://docs.openshift.com/gitops/1.11/understanding_openshift_gitops/about-redhat-openshift-gitops.html) to learn about these tools.
>>>>>>> Stashed changes
## Installing OpenShift GitOps CLI (argocd)
Use the CLI tool to manage Red Hat OpenShift GitOps from a terminal. You can install the CLI tool on different platforms.
Expand Down Expand Up @@ -183,6 +194,10 @@ In the `core` mode (`--core` argument specified), the CLI talks directly to the
```
KUBECONFIG=~/.kube/config argocd --core --kube-context [context] [command or options] [arguments…​]
```
<<<<<<< Updated upstream
=======
**NOTE** If there are multiple ArgoCD instances, then set the default namespace of the current context to interact with the right ArgoCD instance.
>>>>>>> Stashed changes
### Global options
Global options are options applicable to all sub-commands of `argocd`.
Expand Down Expand Up @@ -577,4 +592,11 @@ compinit
4. 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 core mode as below
```
# argocd app sync --core openshift-gitops/app-spring-petclinic
```
<<<<<<< Updated upstream
```
=======
```
## References
https://argo-cd.readthedocs.io/en/stable/user-guide/commands/argocd/
>>>>>>> Stashed changes
4 changes: 4 additions & 0 deletions docs/cli/argocd_proj_add-destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Add project destination
```
argocd proj add-destination PROJECT SERVER/NAME NAMESPACE [flags]
```
<<<<<<< Updated upstream
=======
**WARNING** When using glob patterns like `*` in the argument, ensure that it is properly quoted '*' to avoid the underlying shell interpreting it as a shell wildcard
>>>>>>> Stashed changes
### Examples

Expand Down
22 changes: 22 additions & 0 deletions docs/cli/argocd_proj_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,46 @@ argocd proj create PROJECT [flags]
--orphaned-resources-warn Specifies if applications should have a warning condition when orphaned resources detected
--signature-keys strings GnuPG public key IDs for commit signature verification
--source-namespaces strings List of source namespaces for applications
<<<<<<< Updated upstream
-s, --src stringArray Permitted source repository URL
--upsert Allows to override a project with the same name even if supplied project spec is different from existing spec
```

### Options inherited from parent commands

=======

--upsert Allows to override a project with the same name even if supplied project spec is different from existing spec
```
>>>>>>> Stashed changes
| Option | Argument type | Description |
| ---------------- | ------ | ---- |
| --allow-cluster-resource | string Array| List of allowed cluster level resources |
| --allow-namespaced-resource | string Array| List of allowed namespaced resources |
| --deny-cluster-resource | string Array| List of denied cluster level resources |
| --deny-namespaced-resource | string Array| List of denied namespaced resources |
| --description | string | Project description |
<<<<<<< Updated upstream
=======
| -d, --dest |stringArray | Permitted destination server and namespace (e.g. https://192.168.99.100:8443,default)|
| -f, --file |string | Filename or URL to Kubernetes manifests for the project|
| -h, --help | |help for create|
>>>>>>> Stashed changes
| --orphaned-resources| Enables orphaned resources monitoring |
| --orphaned-resources-warn| Specifies if applications should have a warning condition when orphaned resources detected |
| --signature-keys | string s| GnuPG public key IDs for commit signature verification |
| --source-namespaces | string s| List of source namespaces for applications |
<<<<<<< Updated upstream
| --upsert| Allows to override a project with the same name even if supplied project spec is different from existing spec |
=======
| -s, --src | stringArray | Permitted source repository URL|
| --upsert| Allows to override a project with the same name even if supplied project spec is different from existing spec |
### Options inherited from parent commands
| Option | Argument type | Description |
| ---------------- | ------ | ---- |
>>>>>>> Stashed changes
| --auth-token | string | Authentication token |
| --client-crt | string | Client certificate file |
| --client-crt-key | string | Client certificate key file |
Expand Down

0 comments on commit d3ffa79

Please sign in to comment.