feat: add examples to --help output for admin.go file (argoproj#16030)

* add examples to admin.go Signed-off-by: Harshvir Potpose <[email protected]> * Update argocd_admin.md Signed-off-by: Harshvir Potpose <[email protected]> --------- Signed-off-by: Harshvir Potpose <[email protected]> Signed-off-by: Harshvir Potpose <[email protected]>
pasha-codefresh · Nov 2, 2023 · 481cf81 · 481cf81
1 parent 8796307
commit 481cf81
Show file tree

Hide file tree

Showing 2 changed files with 167 additions and 0 deletions.
diff --git a/cmd/argocd/commands/admin/admin.go b/cmd/argocd/commands/admin/admin.go
@@ -48,6 +48,87 @@ func NewAdminCommand(clientOpts *argocdclient.ClientOptions) *cobra.Command {
 		Run: func(c *cobra.Command, args []string) {
 			c.HelpFunc()(c, args)
 		},
+		Example: `# List all clusters
+$ argocd admin cluster list
+
+# Add a new cluster
+$ argocd admin cluster add my-cluster --name my-cluster --in-cluster-context
+
+# Remove a cluster
+argocd admin cluster remove my-cluster
+
+# List all projects
+$ argocd admin project list
+
+# Create a new project
+$argocd admin project create my-project --src-namespace my-source-namespace --dest-namespace my-dest-namespace
+
+# Update a project
+$ argocd admin project update my-project --src-namespace my-updated-source-namespace --dest-namespace my-updated-dest-namespace
+
+# Delete a project
+$ argocd admin project delete my-project
+
+# List all settings
+$ argocd admin settings list
+
+# Get the current settings
+$ argocd admin settings get
+
+# Update settings
+$ argocd admin settings update --repository.resync --value 15
+
+# List all applications
+$ argocd admin app list
+
+# Get application details
+$ argocd admin app get my-app
+
+# Sync an application
+$ argocd admin app sync my-app
+
+# Pause an application
+$ argocd admin app pause my-app
+
+# Resume an application
+$ argocd admin app resume my-app
+
+# List all repositories
+$ argocd admin repo list
+
+# Add a repository
+$ argocd admin repo add https://github.com/argoproj/my-repo.git
+
+# Remove a repository
+$ argocd admin repo remove https://github.com/argoproj/my-repo.git
+
+# Import an application from a YAML file
+$ argocd admin app import -f my-app.yaml
+
+# Export an application to a YAML file
+$ argocd admin app export my-app -o my-exported-app.yaml
+
+# Access the Argo CD web UI
+$ argocd admin dashboard
+
+# List notifications
+$ argocd admin notification list
+
+# Get notification details
+$ argocd admin notification get my-notification
+
+# Create a new notification
+$ argocd admin notification create my-notification -f notification-config.yaml
+
+# Update a notification
+$ argocd admin notification update my-notification -f updated-notification-config.yaml
+
+# Delete a notification
+$ argocd admin notification delete my-notification
+
+# Reset the initial admin password
+$ argocd admin initial-password reset
+`,
 	}
 
 	command.AddCommand(NewClusterCommand(clientOpts, pathOpts))

diff --git a/docs/user-guide/commands/argocd_admin.md b/docs/user-guide/commands/argocd_admin.md
@@ -8,6 +8,92 @@ Contains a set of commands useful for Argo CD administrators and requires direct
 argocd admin [flags]
 ```
 
+### Examples
+
+```
+# List all clusters
+$ argocd admin cluster list
+
+# Add a new cluster
+$ argocd admin cluster add my-cluster --name my-cluster --in-cluster-context
+
+# Remove a cluster
+argocd admin cluster remove my-cluster
+
+# List all projects
+$ argocd admin project list
+
+# Create a new project
+$argocd admin project create my-project --src-namespace my-source-namespace --dest-namespace my-dest-namespace
+
+# Update a project
+$ argocd admin project update my-project --src-namespace my-updated-source-namespace --dest-namespace my-updated-dest-namespace
+
+# Delete a project
+$ argocd admin project delete my-project
+
+# List all settings
+$ argocd admin settings list
+
+# Get the current settings
+$ argocd admin settings get
+
+# Update settings
+$ argocd admin settings update --repository.resync --value 15
+
+# List all applications
+$ argocd admin app list
+
+# Get application details
+$ argocd admin app get my-app
+
+# Sync an application
+$ argocd admin app sync my-app
+
+# Pause an application
+$ argocd admin app pause my-app
+
+# Resume an application
+$ argocd admin app resume my-app
+
+# List all repositories
+$ argocd admin repo list
+
+# Add a repository
+$ argocd admin repo add https://github.com/argoproj/my-repo.git
+
+# Remove a repository
+$ argocd admin repo remove https://github.com/argoproj/my-repo.git
+
+# Import an application from a YAML file
+$ argocd admin app import -f my-app.yaml
+
+# Export an application to a YAML file
+$ argocd admin app export my-app -o my-exported-app.yaml
+
+# Access the Argo CD web UI
+$ argocd admin dashboard
+
+# List notifications
+$ argocd admin notification list
+
+# Get notification details
+$ argocd admin notification get my-notification
+
+# Create a new notification
+$ argocd admin notification create my-notification -f notification-config.yaml
+
+# Update a notification
+$ argocd admin notification update my-notification -f updated-notification-config.yaml
+
+# Delete a notification
+$ argocd admin notification delete my-notification
+
+# Reset the initial admin password
+$ argocd admin initial-password reset
+
+```
+
 ### Options
 
 ```