From 3fd65b0f3df42eed586263e18b4f5217fec3b0f5 Mon Sep 17 00:00:00 2001 From: Jonathan Berkhahn Date: Wed, 4 Nov 2020 14:45:50 -0800 Subject: [PATCH 1/5] add warning message to ansible-operator and helm-operator executables --- cmd/ansible-operator/main.go | 3 ++- cmd/helm-operator/main.go | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/cmd/ansible-operator/main.go b/cmd/ansible-operator/main.go index 12f79ce780..befe8f3720 100644 --- a/cmd/ansible-operator/main.go +++ b/cmd/ansible-operator/main.go @@ -26,7 +26,8 @@ import ( func main() { root := cobra.Command{ - Use: "ansible-operator", + Short: "**NOTE** This executable is for use by operator-sdk and is not intended to be used manually", + Use: "ansible-operator", } root.AddCommand(run.NewCmd()) diff --git a/cmd/helm-operator/main.go b/cmd/helm-operator/main.go index c223adcea3..76d60f36a0 100644 --- a/cmd/helm-operator/main.go +++ b/cmd/helm-operator/main.go @@ -26,7 +26,8 @@ import ( func main() { root := cobra.Command{ - Use: "helm-operator", + Short: "**NOTE** This executable is for use by operator-sdk and is not intended to be used manually", + Use: "helm-operator", } root.AddCommand(run.NewCmd()) From b919e0fbde561ea29f6c3c6d9ac7e33b7e458eac Mon Sep 17 00:00:00 2001 From: Jonathan Berkhahn Date: Thu, 5 Nov 2020 11:15:37 -0800 Subject: [PATCH 2/5] Update cmd/helm-operator/main.go Co-authored-by: Eric Stroczynski --- cmd/helm-operator/main.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/cmd/helm-operator/main.go b/cmd/helm-operator/main.go index 76d60f36a0..15f7aaaa15 100644 --- a/cmd/helm-operator/main.go +++ b/cmd/helm-operator/main.go @@ -26,7 +26,11 @@ import ( func main() { root := cobra.Command{ - Short: "**NOTE** This executable is for use by operator-sdk and is not intended to be used manually", + Short: "Reconcile an Helm operator project using helm", + Long: `This binary runs a Helm operator that reconciles Kubernetes resources +managed by the helm program. It can be run either directly or from a Helm operator +project's image entrypoint +`, Use: "helm-operator", } From bec529507ee734b51d7fcbde7ece1a58d4f7aaa1 Mon Sep 17 00:00:00 2001 From: Jonathan Berkhahn Date: Thu, 5 Nov 2020 11:15:44 -0800 Subject: [PATCH 3/5] Update cmd/ansible-operator/main.go Co-authored-by: Eric Stroczynski --- cmd/ansible-operator/main.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/cmd/ansible-operator/main.go b/cmd/ansible-operator/main.go index befe8f3720..d7c88ca02c 100644 --- a/cmd/ansible-operator/main.go +++ b/cmd/ansible-operator/main.go @@ -26,7 +26,11 @@ import ( func main() { root := cobra.Command{ - Short: "**NOTE** This executable is for use by operator-sdk and is not intended to be used manually", + Short: "Reconcile an Ansible operator project using ansible-runner", + Long: `This binary runs an Ansible operator that reconciles Kubernetes resources +managed by the ansible-runner program. It can be run either directly or from an Ansible +operator project's image entrypoint +`, Use: "ansible-operator", } From 5b2027e54db1d3cc900462b5375a378144851156 Mon Sep 17 00:00:00 2001 From: Jonathan Berkhahn Date: Thu, 5 Nov 2020 11:37:56 -0800 Subject: [PATCH 4/5] fix formatting --- cmd/ansible-operator/main.go | 4 ++-- cmd/helm-operator/main.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/ansible-operator/main.go b/cmd/ansible-operator/main.go index d7c88ca02c..567e8925be 100644 --- a/cmd/ansible-operator/main.go +++ b/cmd/ansible-operator/main.go @@ -27,11 +27,11 @@ import ( func main() { root := cobra.Command{ Short: "Reconcile an Ansible operator project using ansible-runner", - Long: `This binary runs an Ansible operator that reconciles Kubernetes resources + Long: `This binary runs an Ansible operator that reconciles Kubernetes resources managed by the ansible-runner program. It can be run either directly or from an Ansible operator project's image entrypoint `, - Use: "ansible-operator", + Use: "ansible-operator", } root.AddCommand(run.NewCmd()) diff --git a/cmd/helm-operator/main.go b/cmd/helm-operator/main.go index 15f7aaaa15..795ee80797 100644 --- a/cmd/helm-operator/main.go +++ b/cmd/helm-operator/main.go @@ -27,11 +27,11 @@ import ( func main() { root := cobra.Command{ Short: "Reconcile an Helm operator project using helm", - Long: `This binary runs a Helm operator that reconciles Kubernetes resources + Long: `This binary runs a Helm operator that reconciles Kubernetes resources managed by the helm program. It can be run either directly or from a Helm operator project's image entrypoint `, - Use: "helm-operator", + Use: "helm-operator", } root.AddCommand(run.NewCmd()) From 21ff2751dab80b84ec01d80523f312428ce96c94 Mon Sep 17 00:00:00 2001 From: Jonathan Berkhahn Date: Thu, 5 Nov 2020 13:29:09 -0800 Subject: [PATCH 5/5] add changelog fragment for ansible-operator and helm-operator help text --- changelog/fragments/ansible-helm-help-text.yaml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 changelog/fragments/ansible-helm-help-text.yaml diff --git a/changelog/fragments/ansible-helm-help-text.yaml b/changelog/fragments/ansible-helm-help-text.yaml new file mode 100644 index 0000000000..4376918c0e --- /dev/null +++ b/changelog/fragments/ansible-helm-help-text.yaml @@ -0,0 +1,5 @@ +entries: + - description: > + Improved `ansible-operator` and `helm-operator` help text + kind: change + breaking: false