From 14517e2c41bec4be7b1cb101d80b3093cc5cb79f Mon Sep 17 00:00:00 2001 From: Adam Cornett <88156657+acornett21@users.noreply.github.com> Date: Fri, 6 May 2022 06:26:34 -0700 Subject: [PATCH] updating a few of the help texts based on a few issues that partners have had with the check container cmd (#604) Signed-off-by: Adam D. Cornett --- cmd/check.go | 4 +++- cmd/check_container.go | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/cmd/check.go b/cmd/check.go index 9442982f..502e2568 100644 --- a/cmd/check.go +++ b/cmd/check.go @@ -22,7 +22,9 @@ func init() { checkCmd.PersistentFlags().BoolP("list-checks", "l", false, "lists all the checks run for a given check") - checkCmd.PersistentFlags().StringP("docker-config", "d", "", "path to docker config.json file (env: PFLT_DOCKERCONFIG)") + checkCmd.PersistentFlags().StringP("docker-config", "d", "", "Path to docker config.json file. This value is optional for publicly accessible images.\n"+ + "However, it is strongly encouraged for public Docker Hub images,\n"+ + "due to the rate limit imposed for unauthenticated requests. (env: PFLT_DOCKERCONFIG)") viper.BindPFlag("dockerConfig", checkCmd.PersistentFlags().Lookup("docker-config")) rootCmd.AddCommand(checkCmd) diff --git a/cmd/check_container.go b/cmd/check_container.go index 04b80bb4..4efe7785 100644 --- a/cmd/check_container.go +++ b/cmd/check_container.go @@ -248,13 +248,15 @@ func init() { checkContainerCmd.Flags().String("pyxis-api-token", "", "API token for Pyxis authentication (env: PFLT_PYXIS_API_TOKEN)") viper.BindPFlag("pyxis_api_token", checkContainerCmd.Flags().Lookup("pyxis-api-token")) - checkContainerCmd.Flags().String("pyxis-host", "", fmt.Sprintf("Host to use for Pyxis submissions.\nThis will override Pyxis Env.\nOnly set this if you know what you are doing.\nIf you do set it, it should include just the host, and the URI path.\n(env: PFLT_PYXIS_HOST)")) + checkContainerCmd.Flags().String("pyxis-host", "", fmt.Sprintf("Host to use for Pyxis submissions. This will override Pyxis Env. Only set this if you know what you are doing.\n"+ + "If you do set it, it should include just the host, and the URI path. (env: PFLT_PYXIS_HOST)")) viper.BindPFlag("pyxis_host", checkContainerCmd.Flags().Lookup("pyxis-host")) checkContainerCmd.Flags().String("pyxis-env", certification.DefaultPyxisEnv, "Env to use for Pyxis submissions.") viper.BindPFlag("pyxis_env", checkContainerCmd.Flags().Lookup("pyxis-env")) - checkContainerCmd.Flags().String("certification-project-id", "", fmt.Sprintf("Certification Project ID from connect.redhat.com.\nShould be supplied without the ospid- prefix.\n(env: PFLT_CERTIFICATION_PROJECT_ID)")) + checkContainerCmd.Flags().String("certification-project-id", "", fmt.Sprintf("Certification Project ID from connect.redhat.com/projects/{certification-project-id}/overview\n"+ + "URL paramater. This value may differ from the PID on the overview page. (env: PFLT_CERTIFICATION_PROJECT_ID)")) viper.BindPFlag("certification_project_id", checkContainerCmd.Flags().Lookup("certification-project-id")) checkCmd.AddCommand(checkContainerCmd)