docs(crd): update community documentation (#1236)

Signed-off-by: Denis Karpelevich <[email protected]>

Author: dkarpele

README.md

@@ -75,7 +75,7 @@ The following things are on the roadmap until the `v1.0` release
 
 * [x] Extend Argo CD functionality to write back to Git
 
-* [ ] Provide web hook support to trigger update check for a given image
+* [x] Provide web hook support to trigger update check for a given image
 
 * [x] Use concurrency for updating multiple applications at once
 

cmd/webhook.go

@@ -28,7 +28,7 @@ func NewWebhookCommand() *cobra.Command {
 	var webhookCfg *WebhookConfig = &WebhookConfig{}
 	var kubeConfig string
 	var commitMessagePath string
-	var MaxConcurrentReconciles int
+	var MaxConcurrentUpdaters int
 	var webhookCmd = &cobra.Command{
 		Use:   "webhook",
 		Short: "Start webhook server to receive registry events",
@@ -63,7 +63,7 @@ Supported registries:
 				return err
 			}
 
-			err = runWebhook(ctx, cfg, webhookCfg, MaxConcurrentReconciles)
+			err = runWebhook(ctx, cfg, webhookCfg, MaxConcurrentUpdaters)
 			return err
 		},
 	}
@@ -73,7 +73,7 @@ Supported registries:
 	webhookCmd.Flags().StringVar(&kubeConfig, "kubeconfig", "", "full path to kubernetes client configuration, i.e. ~/.kube/config")
 	webhookCmd.Flags().StringVar(&cfg.RegistriesConf, "registries-conf-path", common.DefaultRegistriesConfPath, "path to registries configuration file")
 	webhookCmd.Flags().IntVar(&cfg.MaxConcurrentApps, "max-concurrent-apps", env.ParseNumFromEnv("MAX_CONCURRENT_APPS", 10, 1, 100), "maximum number of ArgoCD applications that can be updated concurrently (must be >= 1)")
-	webhookCmd.Flags().IntVar(&MaxConcurrentReconciles, "max-concurrent-reconciles", env.ParseNumFromEnv("MAX_CONCURRENT_RECONCILES", 1, 1, 10), "maximum number of concurrent Reconciles which can be run (must be >= 1)")
+	webhookCmd.Flags().IntVar(&MaxConcurrentUpdaters, "max-concurrent-updaters", env.ParseNumFromEnv("MAX_CONCURRENT_UPDATERS", 1, 1, 10), "maximum number of concurrent ImageUpdater CRs that can be processed (must be >= 1)")
 	webhookCmd.Flags().StringVar(&cfg.ArgocdNamespace, "argocd-namespace", "", "namespace where ArgoCD runs in (current namespace by default)")
 
 	webhookCmd.Flags().StringVar(&cfg.GitCommitUser, "git-commit-user", env.GetStringVal("GIT_COMMIT_USER", "argocd-image-updater"), "Username to use for Git commits")
@@ -95,7 +95,7 @@ Supported registries:
 }
 
 // runWebhook starts the webhook server
-func runWebhook(ctx context.Context, cfg *controller.ImageUpdaterConfig, webhookCfg *WebhookConfig, maxConcurrentReconciles int) error {
+func runWebhook(ctx context.Context, cfg *controller.ImageUpdaterConfig, webhookCfg *WebhookConfig, maxConcurrentUpdaters int) error {
 	webhookLogger := log.Log().WithFields(logrus.Fields{
 		"logger": "webhook-command",
 	})
@@ -117,7 +117,7 @@ func runWebhook(ctx context.Context, cfg *controller.ImageUpdaterConfig, webhook
 		Client:                  k8sClient,
 		Scheme:                  scheme,
 		Config:                  cfg,
-		MaxConcurrentReconciles: maxConcurrentReconciles,
+		MaxConcurrentReconciles: maxConcurrentUpdaters,
 	}
 
 	server := SetupWebhookServer(webhookCfg, reconciler)

cmd/webhook_test.go

@@ -31,7 +31,7 @@ func TestNewWebhookCommand(t *testing.T) {
 	asser.Equal("", controllerCommand.Flag("kubeconfig").Value.String())
 	asser.Equal(common.DefaultRegistriesConfPath, controllerCommand.Flag("registries-conf-path").Value.String())
 	asser.Equal(strconv.Itoa(env.ParseNumFromEnv("MAX_CONCURRENT_APPS", 10, 1, 100)), controllerCommand.Flag("max-concurrent-apps").Value.String())
-	asser.Equal(strconv.Itoa(env.ParseNumFromEnv("MAX_CONCURRENT_RECONCILES", 1, 1, 10)), controllerCommand.Flag("max-concurrent-reconciles").Value.String())
+	asser.Equal(strconv.Itoa(env.ParseNumFromEnv("MAX_CONCURRENT_UPDATERS", 1, 1, 10)), controllerCommand.Flag("max-concurrent-updaters").Value.String())
 	asser.Equal("", controllerCommand.Flag("argocd-namespace").Value.String())
 	asser.Equal(env.GetStringVal("GIT_COMMIT_USER", "argocd-image-updater"), controllerCommand.Flag("git-commit-user").Value.String())
 	asser.Equal(env.GetStringVal("GIT_COMMIT_EMAIL", "[email protected]"), controllerCommand.Flag("git-commit-email").Value.String())

docs/basics/authentication.md

@@ -5,9 +5,9 @@ to external systems in order to fulfill its duties.
 
 ## <a name="auth-kubernetes"></a>Authentication to Kubernetes
 
-If you are running Argo CD Image Updater as a Kubernetes workload in the
-`kubernetes` API access mode (which is the default), it uses the token of a
-ServiceAccount mounted to its pod to authenticate at the Kubernetes API.
+If you are running Argo CD Image Updater as a Kubernetes workload, it uses the
+token of a ServiceAccount mounted to its pod to authenticate at the Kubernetes
+API.
 
 The name of this ServiceAccount is `argocd-image-updater`, and it gets
 created through the installation manifests in the installation namespace.
@@ -22,24 +22,6 @@ installation is in a different namespace than `argocd`, you would have
 to adapt the RoleBinding to bind to the ServiceAccount in the correct
 namespace.
 
-## <a name="auth-argocd"></a>Authentication to Argo CD
-
-If you are using Argo CD Image Updater to connect to Argo CD via its API,
-you will need to create credentials in Argo CD and provide them to the
-Image Updater.
-
-This usually involves the following steps:
-
-1. Create a local user with `apiKey` capabilities in Argo CD
-1. Generate an authentication token for that user
-1. Create appropriate RBAC permissions for that user in Argo CD
-1. Configure Argo CD Image Updater to connect to the Argo CD API endpoint
-   instead of the Kubernetes API
-1. Configure Argo CD Image Updater to use the credentials created in steps 1
-   and 2 for authenticating at the Argo CD API
-
-A complete walk-through can be found in the installation guide.
-
 ## <a name="auth-registries"></a>Authentication to container registries
 
 If you are using private registries, or private repositories on public