docs: update development.md on how to run operator locally against a …

…k8s cluster (#1586) * update development.md file Signed-off-by: Atif Ali <[email protected]> * resolved issues Signed-off-by: Atif Ali <[email protected]> --------- Signed-off-by: Atif Ali <[email protected]>
argoproj-labs · Nov 6, 2024 · 3ff4b47 · 3ff4b47
1 parent 56bb5db
commit 3ff4b47
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/developer-guide/development.md b/docs/developer-guide/development.md
@@ -125,6 +125,24 @@ Specify the bundle image to include using the `BUNDLE_IMG` variable
 make catalog-build BUNDLE_IMG=quay.io/my-org/argocd-operator-bundle:latest CATALOG_IMG=quay.io/my-org/argocd-operator-index:latest
 make catalog-push CATALOG_IMG=quay.io/my-org/argocd-operator-index:latest
 ```
+For more infomation see [build operator images to test on a cluster.](https://argocd-operator.readthedocs.io/en/latest/developer-guide/development/#building-the-operator-images-to-test-on-a-cluster)
+
+Once the operator is installed, you would need to configure an ArgoCD instance that the operator would manage. The sample instance configuration is below:
+``` yaml
+apiVersion: argoproj.io/v1alpha1
+kind: ArgoCD
+metadata:
+  name: example-argocd
+  labels:
+    example: basic
+spec: {}
+```
+Store your ArgoCD configuration in a yaml file and execute below command to configure the ArgoCD instance.
+
+``` bash
+kubectl apply -f <path_to_yaml_file>
+```
+For configuring specific properties based on the use case, you can look at the entire list of the configurable properties [here.](https://argocd-operator.readthedocs.io/en/latest/reference/argocd/)
 
 ### Build and Verify Argo CD Operator Docs