Create update-manifests.sh script to support manifest generation for personal images (#477)

Tweaks to README and getting_started.md

CONTRIBUTING.md

@@ -38,6 +38,18 @@ NOTE: The make command can take a while, and we recommend building the specific
 * `make codegen` - Builds protobuf and swagger files
 * `make argocd-util` - Make the administrator's utility, used for certain tasks such as import/export
 
+## Generating ArgoCD manifests for a specific image repository/tag
+
+During development, the `update-manifests.sh` script, can be used to conveniently regenerate the
+ArgoCD installation manifests with a customized image namespace and tag. This enables developers
+to easily apply manifests which are using the images that they pushed into their personal container
+repository.
+
+```
+$ IMAGE_NAMESPACE=jessesuen IMAGE_TAG=latest ./hack/update-manifests.sh
+$ kubectl apply -n argocd -f ./manifests/install.yaml
+```
+
 ## Running locally
 
 You need to have access to kubernetes cluster (including [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or [docker edge](https://docs.docker.com/docker-for-mac/install/) ) in order to run Argo CD on your laptop:

Makefile

@@ -81,8 +81,7 @@ argocd-util: clean-debug
 .PHONY: install-manifest
 install-manifest:
 	if [ "${IMAGE_NAMESPACE}" = "" ] ; then echo "IMAGE_NAMESPACE must be set to build install manifest" ; exit 1 ; fi
-	echo "# This is an auto-generated file. DO NOT EDIT" > manifests/install.yaml
-	cat manifests/components/*.yaml | sed 's@\( image: argoproj/\(.*\):latest\)@ image: '"${IMAGE_NAMESPACE}"'/\2:'"${IMAGE_TAG}"'@g' >> manifests/install.yaml
+	./hack/update-manifests.sh
 
 .PHONY: server
 server: clean-debug

README.md

@@ -3,7 +3,7 @@
 
 ## What is Argo CD?
 
-Argo CD is a declarative, continuous delivery for Kubernetes.
+Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.
 
 ![Argo CD UI](docs/argocd-ui.gif)
 
@@ -55,13 +55,15 @@ For additional details, see [architecture overview](docs/architecture.md).
 * SSO Integration (OIDC, OAuth2, LDAP, SAML 2.0, GitLab, Microsoft, LinkedIn)
 * Webhook Integration (GitHub, BitBucket, GitLab)
 * PreSync, Sync, PostSync hooks to support complex application rollouts (e.g.blue/green & canary upgrades)
+* Audit trails for application events and API calls
 * Parameter overrides for overriding ksonnet/helm parameters in git
 
 ## Development Status
 * Argo CD is being used in production to deploy SaaS services at Intuit
 
 ## Roadmap
-* Audit trails for application events and API calls
+* Auto-sync toggle to directly apply git state changes to live state
 * Service account/access key management for CI pipelines
-* Revamped UI
+* Support for additional config management tools (Kustomize?)
+* Revamped UI, and feature parity with CLI
 * Customizable application actions

docs/getting_started.md

@@ -16,12 +16,20 @@ This will create a new namespace, `argocd`, where ArgoCD services and applicatio
 NOTE:
 * On GKE with RBAC enabled, you may need to grant your account the ability to create new cluster roles
 ```
-$ kubectl create clusterrolebinding YOURNAME-cluster-admin-binding --clusterrole=cluster-admin --user=YOUREMAIL@gmail.com
+kubectl create clusterrolebinding YOURNAME-cluster-admin-binding --clusterrole=cluster-admin --user=YOUREMAIL@gmail.com
 ```
 
 ## 2. Download ArgoCD CLI
 
 Download the latest ArgoCD version:
+
+On Mac:
+```
+brew install argoproj/tap/argocd
+```
+
+On Linux:
+
 ```
 curl -sSL -o /usr/local/bin/argocd https://github.com/argoproj/argo-cd/releases/download/v0.7.0/argocd-darwin-amd64
 chmod +x /usr/local/bin/argocd

hack/update-manifests.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+IMAGE_NAMESPACE=${IMAGE_NAMESPACE:='argoproj'}
+IMAGE_TAG=${IMAGE_TAG:='latest'}
+
+for i in "$(ls manifests/components/*.yaml)"; do
+    sed -i '' 's@\( image: \(.*\)/\(argocd-.*\):.*\)@ image: '"${IMAGE_NAMESPACE}"'/\3:'"${IMAGE_TAG}"'@g' $i
+done
+
+echo "# This is an auto-generated file. DO NOT EDIT" > manifests/install.yaml
+cat manifests/components/*.yaml >> manifests/install.yaml

manifests/components/03d_application-controller-deployment.yaml

@@ -14,6 +14,6 @@ spec:
     spec:
       containers:
       - command: [/argocd-application-controller, --repo-server, 'argocd-repo-server:8081']
-        image: argoproj/argocd-application-controller:latest
+        image: argoproj/argocd-application-controller:v0.7.0
         name: application-controller
       serviceAccountName: application-controller

manifests/components/04d_argocd-server-deployment.yaml

@@ -15,20 +15,20 @@ spec:
       serviceAccountName: argocd-server
       initContainers:
       - name: copyutil
-        image: argoproj/argocd-server:latest
+        image: argoproj/argocd-server:v0.7.0
         command: [cp, /argocd-util, /shared]
         volumeMounts:
         - mountPath: /shared
           name: static-files
       - name: ui
-        image: argoproj/argocd-ui:latest
+        image: argoproj/argocd-ui:v0.7.0
         command: [cp, -r, /app, /shared]
         volumeMounts:
         - mountPath: /shared
           name: static-files
       containers:
       - name: argocd-server
-        image: argoproj/argocd-server:latest
+        image: argoproj/argocd-server:v0.7.0
         command: [/argocd-server, --staticassets, /shared/app, --repo-server, 'argocd-repo-server:8081']
         volumeMounts:
         - mountPath: /shared

manifests/components/05a_argocd-repo-server-deployment.yaml

@@ -14,7 +14,7 @@ spec:
     spec:
       containers:
       - name: argocd-repo-server
-        image: argoproj/argocd-repo-server:latest
+        image: argoproj/argocd-repo-server:v0.7.0
         command: [/argocd-repo-server]
         ports:
           - containerPort: 8081