implement sync

executor doesn't go in the pkg dir, fix test

delete old file

typos

pedantry

small stuff

remove unnecessary step

all the. small things.

options and timeout

parallel syncs

simplify

nest sync action under app

parallel action groups

comment as documented

docstrings

break things up for readability

instantiate API client once per plugin run

update readme

simplify

go 1.19

distroless, smaller binary

Author: crenshaw-dev

.gitignore

@@ -1 +1 @@
-nohup.out
+.idea

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Get started
+
+Here you will have everything you need to get started developing and testing the plugin.
+
+## Prerequisites
+
+Have these tools installed:
+
+- make
+- docker
+- kind
+- kubectl
+- The `argo` ad `argocd` CLIs
+
+## Set up the test environment
+
+This command will install a kind cluster and Argo components. 
+
+```shell
+make setup
+```
+
+## Build the plugin as a container image
+
+```shell
+make build
+```
+
+## Install the plugin
+
+Run `make apply` to install the plugin.
+
+## Run a test workflow
+
+Run `make submit` to apply a workflow that runs the plugin.
+
+To see that the workflow has synced the app, connect to the Argo CD server by going to https://localhost:8080 in your browser.
+
+## Cleanup
+
+To delete the test cluster, run the following:
+
+```shell
+make clean
+```

Dockerfile

@@ -0,0 +1,17 @@
+# syntax=docker/dockerfile:1
+
+FROM golang:1.19-alpine AS build
+WORKDIR /app
+COPY go.mod ./
+COPY go.sum ./
+RUN go mod download
+RUN apk add build-base
+COPY cmd ./cmd
+COPY internal ./internal
+RUN CGO_ENABLED=0 GOOS=linux go build -ldflags "-w" -o plugin cmd/argocd-plugin/main.go
+
+FROM gcr.io/distroless/static
+USER 1000
+COPY --from=build /app/plugin /
+
+CMD [ "/plugin" ]

Makefile

@@ -1,18 +1,28 @@
 .DEFAULT_GOAL := apply
 
+.PHONY: setup
+setup:
+	bash ./scripts/setup_cluster.sh
+
 .PHONY: build
 build:
-	@scripts/build_plugin.sh
+	go mod tidy
+	docker build --load -t urielc12/argocd-plugin:local -f ./Dockerfile .
+	kind load docker-image urielc12/argocd-plugin:local --name argo-workflows-plugin-argocd
 
-apply: 
-	@kubectl apply -n argo -f deployments/argocd-executor-plugin-configmap.yaml
-	@kubectl apply -n argo -f examples/rbac.yaml
+.PHONY: manifests
+manifests:
+	argo executor-plugin build ./manifests
 
-submit: 
-	@argo submit -n argo examples/argocd-example-wf.yaml
+.PHONY: apply
+apply: manifests
+	kubectl apply -n argo -f deployments/argocd-executor-plugin-configmap.yaml
+	kubectl apply -n argo -f examples/rbac.yaml
 
-setup:
-	@scripts/create_cluster.sh
+.PHONY: submit
+submit:
+	argo submit -n argo examples/argocd-example-wf.yaml --serviceaccount workflow
 
+.PHONY: clean
 clean:
-	@scripts/delete_cluster.sh
+	bash scripts/delete_cluster.sh

README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <h1 align="center">Argocd Executor Plugin</h1>
-  <p align="center">An <a href="https://github.com/argoproj/argo-workflows/blob/master/docs/executor_plugins.md">Executor Plugin</a> for <a href="https://argoproj.github.io/argo-workflows/">Argo Workflows</a> that lets you interact with ArgoCD servers </br>
+  <p align="center">An <a href="https://github.com/argoproj/argo-workflows/blob/master/docs/executor_plugins.md">Executor Plugin</a> for <a href="https://argoproj.github.io/argo-workflows/">Argo Workflows</a> that lets you interact with Argo CD servers <br>
   <b>In Active Development</b></p>
 </div>
 
@@ -17,34 +17,32 @@ spec:
     - name: main
       plugin:
         argocd:
-          serverUrl: https://my-argocd-instance.com/
           actions:
-            - sync:
-                project: guestbook
-                apps:
-                  - guestbook
-                  - guestbook-backend
+            - - sync:
+                  apps:
+                    - name: guestbook
+                    - name: guestbook-backend
 ```
 
-</br>
-
 ## Getting Started
 
-Head to the [scripts](scripts/README.md) directory to find out how to get the project up and running on your local machine for development and testing purposes.
+Head to the [scripts](CONTRIBUTING.md) directory to find out how to get the project up and running on your local machine for development and testing purposes.
 
 ### Prerequisites
 
-You will need to have a working [Argo Workflows](https://argoproj.github.io/argo-workflows/) and [ArgoCD](https://argo-cd.readthedocs.io/en/stable/) instances to be able to deploy the plugin and use it.
+You will need to have a working [Argo Workflows](https://argoproj.github.io/argo-workflows/) and [Argo CD](https://argo-cd.readthedocs.io/en/stable/) instances to be able to deploy the plugin and use it.
 
 ### Installing
 
-Read how to install the plugin in your Argo Workflows instance [here](out/README.md).
+```shell
+kubectl apply -n argo -f https://raw.githubusercontent.com/UrielCohen456/argocd-executor-plugin/main/deployments/argocd-executor-plugin-configmap.yaml
+```
 
-</br>
+You will have to run the workflow using a service account with appropriate permissions. See [examples/rbac.yaml](examples/rbac.yaml) for an example.
 
 ## Contributing
 
-Currently I am developing this on my own as my interest in workflow plugins is growing. <br>
+Currently, I am developing this on my own as my interest in workflow plugins is growing. <br>
 However, you are free to send me a message or create pull request or an issue if you have anything to suggest. <br>
 To get started check the scripts directory for setting up the dev environment.
 
@@ -60,11 +58,11 @@ The goals of this plugin is to enable native usage of argocd actions inside work
 - [x] Figure out how to get access to kubernetes resources from inside the pod
 - [x] Figure out how to get access to argocd binary (Build image that has it)
 - [x] Figure out how to get current namespace (not supported in client library in python)
-- [x] Add argocd installation to the create_cluster.sh script
-- [x] Add a few different applications to argocd in the create_cluster.sh script (More complexity over time)
+- [x] Add argocd installation to the setup_cluster.sh script
+- [x] Add a few different applications to argocd in the setup_cluster.sh script (More complexity over time)
 - [x] Translate python server that works so far to go
-- [ ] Github actions pipeline to automatically build and test
-- [ ] Find way to get arguments from template
+- [ ] GitHub actions pipeline to automatically build and test
+- [x] Find way to get arguments from template
 - [ ] Build a simple json schema to validate inside the plugin
-- [ ] Build classes to be able to seperate concerns and test
+- [ ] Build classes to be able to separate concerns and test
 - [ ] Build unit tests and integration tests

build/.dockerignore

@@ -1,26 +1,25 @@
 package main
 
 import (
+	"fmt"
 	"net/http"
 
-	"k8s.io/client-go/kubernetes"
-	"k8s.io/client-go/rest"
+	"github.com/argoproj/argo-cd/v2/pkg/apiclient"
 
-	"github.com/UrielCohen456/argo-workflows-argocd-executor-plugin/common"
-	"github.com/UrielCohen456/argo-workflows-argocd-executor-plugin/pkg/plugin"
+	"github.com/UrielCohen456/argo-workflows-argocd-executor-plugin/internal"
 )
 
 func main() {
-	config, err := rest.InClusterConfig()
+	client, err := apiclient.NewClient(&apiclient.ClientOptions{
+		// TODO: make this configurable by passing a root CA.
+		Insecure: true,
+	})
 	if err != nil {
-		panic(err.Error())
+		panic(fmt.Sprintf("failed to initialize Argo CD API client: %s", err))
 	}
-
-	client, err := kubernetes.NewForConfig(config)
+	http.HandleFunc("/api/v1/template.execute", argocd.ArgocdPlugin(argocd.NewApiExecutor(client)))
+	err = http.ListenAndServe(":3000", nil)
 	if err != nil {
 		panic(err.Error())
 	}
-
-	http.HandleFunc("/api/v1/template.execute", plugin.ArgocdPlugin(nil, client, common.Namespace()))
-	http.ListenAndServe(":3000", nil)
 }

build/Dockerfile

@@ -13,9 +13,19 @@ spec:
     - name: main
       plugin:
         argocd:
-          serverUrl: argocd-server.argocd.svc.cluster.local
+          # `actions` is a nested list. Items of inner arrays run in parallel. Top-level arrays run in sequence.
+          # In this example, each inner array has only one item. The syncs run in sequence.
           actions:
-            - sync:
-                project: default
-                apps:
-                  - guestbook
+            # TODO: support other action types, e.g. `cluster` and `repository`.
+            - - app:
+                  sync:
+                    apps:
+                      - name: guestbook
+                    options:
+                      - ServerSideApply=true
+                timeout: 10s
+            # Uncomment this to test a failed sync.
+#            - - app:
+#                  sync:
+#                    apps:
+#                      - name: not-real