Skip to content

Commit

Permalink
update development.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
aali309 committed Oct 30, 2024
1 parent 17e355a commit 9903670
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions docs/developer-guide/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,13 @@ git switch -c MY_BRANCH

#### Building and testing locally

To run the operator locally on your machine (outside a container), invoke the following make target:
To run the operator locally against a k8s cluster on your machine first you need to fetch dependencies:
``` bash
go mod tidy
go mod vendor
```

Then invoke the following make target:

``` bash
make install run
Expand Down Expand Up @@ -125,8 +131,26 @@ 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
### Build and Verify ArgoCD Operator Docs

**Note**: Please note that you need to have `Python3` Installed as a prerequisite.

Expand Down

0 comments on commit 9903670

Please sign in to comment.