Skip to content

Commit d3ffa79

Browse files
committed
Added tips warning and notes for commands and description for user guide
Signed-off-by: Anand Francis Joseph <[email protected]>
1 parent 1567edf commit d3ffa79

File tree

3 files changed

+49
-1
lines changed

3 files changed

+49
-1
lines changed

docs/OpenShift GitOps CLI User Guide.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
11
# OpenShift GitOps CLI User Guide
2+
<<<<<<< Updated upstream
3+
=======
4+
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.
5+
6+
**Note:** Both the archives and the RPMs contain the `argocd` executable binary file.
7+
8+
**WARNING**
9+
Red Hat OpenShift GitOps with the `argocd` CLI tool is a Technology Preview feature only.
10+
11+
**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.
12+
>>>>>>> Stashed changes
213
314
## Installing OpenShift GitOps CLI (argocd)
415
Use the CLI tool to manage Red Hat OpenShift GitOps from a terminal. You can install the CLI tool on different platforms.
@@ -183,6 +194,10 @@ In the `core` mode (`--core` argument specified), the CLI talks directly to the
183194
```
184195
KUBECONFIG=~/.kube/config argocd --core --kube-context [context] [command or options] [arguments…​]
185196
```
197+
<<<<<<< Updated upstream
198+
=======
199+
**NOTE** If there are multiple ArgoCD instances, then set the default namespace of the current context to interact with the right ArgoCD instance.
200+
>>>>>>> Stashed changes
186201
187202
### Global options
188203
Global options are options applicable to all sub-commands of `argocd`.
@@ -577,4 +592,11 @@ compinit
577592
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
578593
```
579594
# argocd app sync --core openshift-gitops/app-spring-petclinic
580-
```
595+
<<<<<<< Updated upstream
596+
```
597+
=======
598+
```
599+
600+
## References
601+
https://argo-cd.readthedocs.io/en/stable/user-guide/commands/argocd/
602+
>>>>>>> Stashed changes

docs/cli/argocd_proj_add-destination.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Add project destination
77
```
88
argocd proj add-destination PROJECT SERVER/NAME NAMESPACE [flags]
99
```
10+
<<<<<<< Updated upstream
11+
=======
12+
**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
13+
>>>>>>> Stashed changes
1014
1115
### Examples
1216

docs/cli/argocd_proj_create.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,46 @@ argocd proj create PROJECT [flags]
3333
--orphaned-resources-warn Specifies if applications should have a warning condition when orphaned resources detected
3434
--signature-keys strings GnuPG public key IDs for commit signature verification
3535
--source-namespaces strings List of source namespaces for applications
36+
<<<<<<< Updated upstream
3637
-s, --src stringArray Permitted source repository URL
3738
--upsert Allows to override a project with the same name even if supplied project spec is different from existing spec
3839
```
3940

4041
### Options inherited from parent commands
4142

43+
=======
44+
45+
--upsert Allows to override a project with the same name even if supplied project spec is different from existing spec
46+
```
47+
>>>>>>> Stashed changes
4248
| Option | Argument type | Description |
4349
| ---------------- | ------ | ---- |
4450
| --allow-cluster-resource | string Array| List of allowed cluster level resources |
4551
| --allow-namespaced-resource | string Array| List of allowed namespaced resources |
4652
| --deny-cluster-resource | string Array| List of denied cluster level resources |
4753
| --deny-namespaced-resource | string Array| List of denied namespaced resources |
4854
| --description | string | Project description |
55+
<<<<<<< Updated upstream
56+
=======
57+
| -d, --dest |stringArray | Permitted destination server and namespace (e.g. https://192.168.99.100:8443,default)|
58+
| -f, --file |string | Filename or URL to Kubernetes manifests for the project|
59+
| -h, --help | |help for create|
60+
>>>>>>> Stashed changes
4961
| --orphaned-resources| Enables orphaned resources monitoring |
5062
| --orphaned-resources-warn| Specifies if applications should have a warning condition when orphaned resources detected |
5163
| --signature-keys | string s| GnuPG public key IDs for commit signature verification |
5264
| --source-namespaces | string s| List of source namespaces for applications |
65+
<<<<<<< Updated upstream
5366
| --upsert| Allows to override a project with the same name even if supplied project spec is different from existing spec |
67+
=======
68+
| -s, --src | stringArray | Permitted source repository URL|
69+
| --upsert| Allows to override a project with the same name even if supplied project spec is different from existing spec |
70+
71+
### Options inherited from parent commands
72+
73+
| Option | Argument type | Description |
74+
| ---------------- | ------ | ---- |
75+
>>>>>>> Stashed changes
5476
| --auth-token | string | Authentication token |
5577
| --client-crt | string | Client certificate file |
5678
| --client-crt-key | string | Client certificate key file |

0 commit comments

Comments
 (0)