Skip to content

Commit ba84d17

Browse files
authored
Merge pull request #2 from crenshaw-dev/docs
docs
2 parents b1cad20 + 5acb3c6 commit ba84d17

File tree

6 files changed

+11
-37
lines changed

6 files changed

+11
-37
lines changed

.github/workflows/build.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ jobs:
3333
with:
3434
context: .
3535
push: ${{ github.event_name == 'push' }}
36-
tags: crenshaw-dev/argocd-executor-plugin:latest
36+
tags: crenshawdotdev/argocd-executor-plugin:latest
3737
- name: Install cosign
3838
uses: sigstore/cosign-installer@main
3939
with:
4040
cosign-release: 'v1.13.0'
4141
if: ${{ github.event_name == 'push' }}
4242
- name: Sign latest image
4343
run: |
44-
cosign sign --key env://COSIGN_PRIVATE_KEY crenshaw-dev/argocd-executor-plugin:latest
44+
cosign sign --key env://COSIGN_PRIVATE_KEY crenshawdotdev/argocd-executor-plugin:latest
4545
# Displays the public key to share.
4646
cosign public-key --key env://COSIGN_PRIVATE_KEY
4747
env:

Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ setup:
77
.PHONY: build
88
build:
99
go mod tidy
10-
docker build --load -t crenshaw-dev/argocd-executor-plugin:latest -f ./Dockerfile .
11-
kind load docker-image crenshaw-dev/argocd-executor-plugin:latest --name argo-workflows-plugin-argocd
10+
docker build --load -t crenshawdotdev/argocd-executor-plugin:latest -f ./Dockerfile .
11+
kind load docker-image crenshawdotdev/argocd-executor-plugin:latest --name argo-workflows-plugin-argocd
1212

1313
.PHONY: manifests
1414
manifests:

README.md

+4-30
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<div align="center">
2-
<h1 align="center">Argocd Executor Plugin</h1>
3-
<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>
4-
<b>In Active Development</b></p>
2+
<h1 align="center">Argo CD Executor Plugin</h1>
3+
<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.</p>
54
</div>
65

76
## Example Usage
@@ -26,43 +25,18 @@ spec:
2625
2726
## Getting Started
2827
29-
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.
30-
3128
### Prerequisites
3229
3330
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.
3431
3532
### Installing
3633
3734
```shell
38-
kubectl apply -n argo -f https://raw.githubusercontent.com/UrielCohen456/argocd-executor-plugin/main/deployments/argocd-executor-plugin-configmap.yaml
35+
kubectl apply -n argo -f https://raw.githubusercontent.com/crenshaw-dev/argocd-executor-plugin/main/manifests/argocd-executor-plugin-configmap.yaml
3936
```
4037

4138
You will have to run the workflow using a service account with appropriate permissions. See [examples/rbac.yaml](examples/rbac.yaml) for an example.
4239

4340
## Contributing
4441

45-
Currently, I am developing this on my own as my interest in workflow plugins is growing. <br>
46-
However, you are free to send me a message or create pull request or an issue if you have anything to suggest. <br>
47-
To get started check the scripts directory for setting up the dev environment.
48-
49-
### Goals
50-
51-
The goals of this plugin is to enable native usage of argocd actions inside workflows for these purposes:
52-
53-
1. CI/CD + Testing - Steps that require a sync to an app and various e2e testing modules
54-
2. Resource automation - Steps that require you to generate new resources and delete resources
55-
56-
### TODO:
57-
58-
- [x] Figure out how to get access to kubernetes resources from inside the pod
59-
- [x] Figure out how to get access to argocd binary (Build image that has it)
60-
- [x] Figure out how to get current namespace (not supported in client library in python)
61-
- [x] Add argocd installation to the setup_cluster.sh script
62-
- [x] Add a few different applications to argocd in the setup_cluster.sh script (More complexity over time)
63-
- [x] Translate python server that works so far to go
64-
- [ ] GitHub actions pipeline to automatically build and test
65-
- [x] Find way to get arguments from template
66-
- [ ] Build a simple json schema to validate inside the plugin
67-
- [ ] Build classes to be able to separate concerns and test
68-
- [ ] Build unit tests and integration tests
42+
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.

manifests/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# argocd
33

44
* Needs: >= v3.3
5-
* Image: crenshaw-dev/argocd-executor-plugin:latest
5+
* Image: crenshawdotdev/argocd-executor-plugin:latest
66

77
This is an Argo CD plugin that allows you to interact with an argocd instance of your choice.
88
For examples visit https://github.com/UrielCohen456/argo-workflows-argocd-executor-plugin/examples

manifests/argocd-executor-plugin-configmap.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ data:
1111
name: argocd-sync-token
1212
- name: ARGOCD_SERVER
1313
value: argocd-server.argocd.svc.cluster.local
14-
image: crenshaw-dev/argocd-executor-plugin:latest
14+
image: crenshawdotdev/argocd-executor-plugin:latest
1515
imagePullPolicy: Never
1616
name: argocd
1717
ports:

manifests/plugin.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ spec:
1111
sidecar:
1212
container:
1313
name: argocd
14-
image: crenshaw-dev/argocd-executor-plugin:latest
14+
image: crenshawdotdev/argocd-executor-plugin:latest
1515
imagePullPolicy: Never
1616
env:
1717
- name: ARGOCD_AUTH_TOKEN

0 commit comments

Comments
 (0)