From b6a8163dd9457dcdb6664b21f54c40789c9474af Mon Sep 17 00:00:00 2001
From: Stefan Prodan <stefan.prodan@gmail.com>
Date: Wed, 17 Mar 2021 17:30:02 +0200
Subject: [PATCH] Add create image policy examples

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
---
 cmd/flux/create_image_policy.go          | 14 +++++++++++++-
 cmd/flux/create_image_repository.go      |  2 +-
 docs/cmd/flux_create_image_policy.md     | 19 ++++++++++++++++++-
 docs/cmd/flux_create_image_repository.md |  2 +-
 4 files changed, 33 insertions(+), 4 deletions(-)

diff --git a/cmd/flux/create_image_policy.go b/cmd/flux/create_image_policy.go
index fdb1b42d..5899b1e3 100644
--- a/cmd/flux/create_image_policy.go
+++ b/cmd/flux/create_image_policy.go
@@ -32,7 +32,7 @@ import (
 )
 
 var createImagePolicyCmd = &cobra.Command{
-	Use:   "policy <name>",
+	Use:   "policy [name]",
 	Short: "Create or update an ImagePolicy object",
 	Long: `The create image policy command generates an ImagePolicy resource.
 An ImagePolicy object calculates a "latest image" given an image
@@ -40,6 +40,18 @@ repository and a policy, e.g., semver.
 
 The image that sorts highest according to the policy is recorded in
 the status of the object.`,
+	Example: `  # Create an ImagePolicy to select the latest stable release
+  flux create image policy podinfo \
+    --image-ref=podinfo \
+    --select-semver=">=1.0.0"
+
+  # Create an ImagePolicy to select the latest main branch build tagged as "${GIT_BRANCH}-${GIT_SHA:0:7}-$(date +%s)"
+  flux create image policy podinfo \
+    --image-ref=podinfo \
+    --select-numeric=asc \
+	--filter-regex='^main-[a-f0-9]+-(?P<ts>[0-9]+)' \
+	--filter-extract='$ts'
+`,
 	RunE: createImagePolicyRun}
 
 type imagePolicyFlags struct {
diff --git a/cmd/flux/create_image_repository.go b/cmd/flux/create_image_repository.go
index a853610d..2ef652fc 100644
--- a/cmd/flux/create_image_repository.go
+++ b/cmd/flux/create_image_repository.go
@@ -30,7 +30,7 @@ import (
 )
 
 var createImageRepositoryCmd = &cobra.Command{
-	Use:   "repository <name>",
+	Use:   "repository [name]",
 	Short: "Create or update an ImageRepository object",
 	Long: `The create image repository command generates an ImageRepository resource.
 An ImageRepository object specifies an image repository to scan.`,
diff --git a/docs/cmd/flux_create_image_policy.md b/docs/cmd/flux_create_image_policy.md
index 6790ca78..6546913f 100644
--- a/docs/cmd/flux_create_image_policy.md
+++ b/docs/cmd/flux_create_image_policy.md
@@ -12,7 +12,24 @@ The image that sorts highest according to the policy is recorded in
 the status of the object.
 
 ```
-flux create image policy <name> [flags]
+flux create image policy [name] [flags]
+```
+
+### Examples
+
+```
+  # Create an ImagePolicy to select the latest stable release
+  flux create image policy podinfo \
+    --image-ref=podinfo \
+    --select-semver=">=1.0.0"
+
+  # Create an ImagePolicy to select the latest main branch build tagged as "${GIT_BRANCH}-${GIT_SHA:0:7}-$(date +%s)"
+  flux create image policy podinfo \
+    --image-ref=podinfo \
+    --select-numeric=asc \
+	--filter-regex='^main-[a-f0-9]+-(?P<ts>[0-9]+)' \
+	--filter-extract='$ts'
+
 ```
 
 ### Options
diff --git a/docs/cmd/flux_create_image_repository.md b/docs/cmd/flux_create_image_repository.md
index 11dfc13f..e8c4cfd1 100644
--- a/docs/cmd/flux_create_image_repository.md
+++ b/docs/cmd/flux_create_image_repository.md
@@ -8,7 +8,7 @@ The create image repository command generates an ImageRepository resource.
 An ImageRepository object specifies an image repository to scan.
 
 ```
-flux create image repository <name> [flags]
+flux create image repository [name] [flags]
 ```
 
 ### Examples