diff --git a/cmd/reporter/approveDeployment.go b/cmd/reporter/approveDeployment.go index 16699acf3..1ae2208c2 100644 --- a/cmd/reporter/approveDeployment.go +++ b/cmd/reporter/approveDeployment.go @@ -33,9 +33,10 @@ type ApprovalPayload struct { func newApproveDeploymentCmd(out io.Writer) *cobra.Command { o := new(approvalOptions) cmd := &cobra.Command{ - Use: "approval ARTIFACT-NAME-OR-PATH", - Short: "Approve deploying an artifact in Merkely. ", - Long: approveDeploymentDesc(), + Use: "approval ARTIFACT-NAME-OR-PATH", + Short: "Approve deploying an artifact in Merkely. ", + Long: approveDeploymentDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -98,8 +99,8 @@ func newApproveDeploymentCmd(out io.Writer) *cobra.Command { func approveDeploymentDesc() string { return ` - Approve a deployment of an artifact in Merkely. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + Approve a deployment of an artifact in Merkely. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ` } diff --git a/cmd/reporter/artifact.go b/cmd/reporter/artifact.go index 86111ab08..35c4e8831 100644 --- a/cmd/reporter/artifact.go +++ b/cmd/reporter/artifact.go @@ -30,9 +30,10 @@ type ArtifactPayload struct { func newArtifactCmd(out io.Writer) *cobra.Command { o := new(artifactOptions) cmd := &cobra.Command{ - Use: "artifact ARTIFACT-NAME-OR-PATH", - Short: "Report/Log an artifact to Merkely. ", - Long: artifactDesc(), + Use: "artifact ARTIFACT-NAME-OR-PATH", + Short: "Report/Log an artifact to Merkely. ", + Long: artifactDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -86,8 +87,8 @@ func newArtifactCmd(out io.Writer) *cobra.Command { func artifactDesc() string { return ` - Report an artifact to a pipeline in Merkely. - The artifact SHA256 fingerprint is calculated and reported - or,alternatively, can be provided directly. + Report an artifact to a pipeline in Merkely. + The artifact SHA256 fingerprint is calculated and reported + or,alternatively, can be provided directly. ` + GetCIDefaultsTemplates(supportedCIs, []string{"git-commit", "build-url", "commit-url"}) } diff --git a/cmd/reporter/control.go b/cmd/reporter/control.go index 75c2aae25..053fee7a5 100644 --- a/cmd/reporter/control.go +++ b/cmd/reporter/control.go @@ -10,9 +10,10 @@ const controlDesc = `Check if artifact is allowed to be deployed.` func newControlCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ - Use: "control", - Short: controlDesc, - Long: controlDesc, + Use: "control", + Short: controlDesc, + Long: controlDesc, + DisableAutoGenTag: true, } // Add subcommands diff --git a/cmd/reporter/controlDeployment.go b/cmd/reporter/controlDeployment.go index d47f58d57..93b39936c 100644 --- a/cmd/reporter/controlDeployment.go +++ b/cmd/reporter/controlDeployment.go @@ -19,9 +19,10 @@ type controlDeploymentOptions struct { func newControlDeploymentCmd(out io.Writer) *cobra.Command { o := new(controlDeploymentOptions) cmd := &cobra.Command{ - Use: "deployment ARTIFACT-NAME-OR-PATH", - Short: "Check if an artifact in Merkely has been approved for deployment.", - Long: controlDeploymentDesc(), + Use: "deployment ARTIFACT-NAME-OR-PATH", + Short: "Check if an artifact in Merkely has been approved for deployment.", + Long: controlDeploymentDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -76,6 +77,6 @@ func newControlDeploymentCmd(out io.Writer) *cobra.Command { func controlDeploymentDesc() string { return `Check if an artifact in Merkely has been approved for deployment. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ` } diff --git a/cmd/reporter/create.go b/cmd/reporter/create.go index bf90f11f9..7e3cd58d1 100644 --- a/cmd/reporter/create.go +++ b/cmd/reporter/create.go @@ -10,9 +10,10 @@ const createDesc = `Create objects in Merkely.` func newCreateCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ - Use: "create", - Short: createDesc, - Long: createDesc, + Use: "create", + Short: createDesc, + Long: createDesc, + DisableAutoGenTag: true, } // Add subcommands diff --git a/cmd/reporter/createEnvironment.go b/cmd/reporter/createEnvironment.go index e6e30a376..781dc1f0c 100644 --- a/cmd/reporter/createEnvironment.go +++ b/cmd/reporter/createEnvironment.go @@ -28,11 +28,12 @@ type CreateEnvironmentPayload struct { func newEnvironmentCmd(out io.Writer) *cobra.Command { payload := new(CreateEnvironmentPayload) cmd := &cobra.Command{ - Use: "environment", - Short: "Create a Merkely environment", - Long: createEnvDesc, - Example: createEnvExample, - Args: NoArgs, + Use: "environment", + Short: "Create a Merkely environment", + Long: createEnvDesc, + Example: createEnvExample, + DisableAutoGenTag: true, + Args: NoArgs, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { diff --git a/cmd/reporter/deployment.go b/cmd/reporter/deployment.go index 27108b3e2..194b76bfa 100644 --- a/cmd/reporter/deployment.go +++ b/cmd/reporter/deployment.go @@ -28,9 +28,10 @@ type DeploymentPayload struct { func newDeploymentCmd(out io.Writer) *cobra.Command { o := new(deploymentOptions) cmd := &cobra.Command{ - Use: "deployment ARTIFACT-NAME-OR-PATH", - Short: "Report/Log a deployment to Merkely. ", - Long: deploymentDesc(), + Use: "deployment ARTIFACT-NAME-OR-PATH", + Short: "Report/Log a deployment to Merkely. ", + Long: deploymentDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -82,8 +83,8 @@ func newDeploymentCmd(out io.Writer) *cobra.Command { func deploymentDesc() string { return ` - Report a deployment of an artifact to an environment in Merkely. - The artifact SHA256 fingerprint is calculated and reported - or,alternatively, can be provided directly. + Report a deployment of an artifact to an environment in Merkely. + The artifact SHA256 fingerprint is calculated and reported + or,alternatively, can be provided directly. ` + GetCIDefaultsTemplates(supportedCIs, []string{"build-url"}) } diff --git a/cmd/reporter/docs.go b/cmd/reporter/docs.go index 506b5dd3f..99a57ceea 100644 --- a/cmd/reporter/docs.go +++ b/cmd/reporter/docs.go @@ -26,11 +26,12 @@ func newDocsCmd(out io.Writer) *cobra.Command { o := &docsOptions{} cmd := &cobra.Command{ - Use: "docs", - Short: "generate documentation as markdown", - Long: docsDesc, - Hidden: true, - Args: NoArgs, + Use: "docs", + Short: "generate documentation as markdown", + Long: docsDesc, + Hidden: true, + Args: NoArgs, + DisableAutoGenTag: true, RunE: func(cmd *cobra.Command, args []string) error { o.topCmd = cmd.Root() return o.run(out) diff --git a/cmd/reporter/ecsEnv.go b/cmd/reporter/ecsEnv.go index 031388ea5..e9963b6be 100644 --- a/cmd/reporter/ecsEnv.go +++ b/cmd/reporter/ecsEnv.go @@ -11,8 +11,8 @@ import ( ) const ecsEnvDesc = ` -List the artifacts deployed in an AWS ECS cluster and their digests -and report them to Merkely. +List the artifacts deployed in an AWS ECS cluster and their digests +and report them to Merkely. ` const ecsEnvExample = ` @@ -29,10 +29,11 @@ type ecsEnvOptions struct { func newEcsEnvCmd(out io.Writer) *cobra.Command { o := new(ecsEnvOptions) cmd := &cobra.Command{ - Use: "ecs env-name", - Short: "Report images data from AWS ECS cluster to Merkely.", - Long: ecsEnvDesc, - Example: ecsEnvExample, + Use: "ecs env-name", + Short: "Report images data from AWS ECS cluster to Merkely.", + Long: ecsEnvDesc, + Example: ecsEnvExample, + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { if len(args) > 1 { return fmt.Errorf("only environment name argument is allowed") diff --git a/cmd/reporter/env.go b/cmd/reporter/env.go index fc4f659d8..4493251e3 100644 --- a/cmd/reporter/env.go +++ b/cmd/reporter/env.go @@ -13,10 +13,11 @@ This allows Merkely to determine Runtime compliance status of the environment. func newEnvCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ - Use: "env", - Short: "Report running artifacts in an environment to Merkely.", - Long: envDesc, - Aliases: []string{"environment"}, + Use: "env", + Short: "Report running artifacts in an environment to Merkely.", + Long: envDesc, + DisableAutoGenTag: true, + Aliases: []string{"environment"}, } // Add subcommands diff --git a/cmd/reporter/evidence.go b/cmd/reporter/evidence.go index a53ea5a00..ebb5c847b 100644 --- a/cmd/reporter/evidence.go +++ b/cmd/reporter/evidence.go @@ -29,9 +29,10 @@ type EvidencePayload struct { func newEvidenceCmd(out io.Writer) *cobra.Command { o := new(evidenceOptions) cmd := &cobra.Command{ - Use: "evidence ARTIFACT-NAME-OR-PATH", - Short: "Report/Log an evidence to an artifact in Merkely. ", - Long: evidenceDesc(), + Use: "evidence ARTIFACT-NAME-OR-PATH", + Short: "Report/Log an evidence to an artifact in Merkely. ", + Long: evidenceDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -87,7 +88,7 @@ func newEvidenceCmd(out io.Writer) *cobra.Command { func evidenceDesc() string { return ` - Report an evidence to an artifact in Merkely. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + Report an evidence to an artifact in Merkely. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ` + GetCIDefaultsTemplates(supportedCIs, []string{"build-url"}) } diff --git a/cmd/reporter/fingerprint.go b/cmd/reporter/fingerprint.go index d83e25b36..76d125efa 100644 --- a/cmd/reporter/fingerprint.go +++ b/cmd/reporter/fingerprint.go @@ -19,9 +19,10 @@ type fingerprintOptions struct { func newFingerprintCmd(out io.Writer) *cobra.Command { o := new(fingerprintOptions) cmd := &cobra.Command{ - Use: "fingerprint", - Short: "Print the SHA256 fingerprint of an artifact.", - Long: fingerprintDesc, + Use: "fingerprint", + Short: "Print the SHA256 fingerprint of an artifact.", + Long: fingerprintDesc, + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { if len(args) > 1 { return fmt.Errorf("only one argument (docker image name or file/dir path) is allowed") diff --git a/cmd/reporter/k8sEnv.go b/cmd/reporter/k8sEnv.go index a8135dae4..f6c93e846 100644 --- a/cmd/reporter/k8sEnv.go +++ b/cmd/reporter/k8sEnv.go @@ -14,15 +14,15 @@ import ( ) const k8sEnvDesc = ` -List the artifacts deployed in the k8s environment and their digests -and report them to Merkely. +List the artifacts deployed in the k8s environment and their digests +and report them to Merkely. ` const k8sEnvExample = ` * report what's running in an entire cluster using kubeconfig at $HOME/.kube/config: merkely report env k8s prod --api-token 1234 --owner exampleOrg --id prod-cluster -* report what's running in an entire cluster using kubeconfig at $HOME/.kube/config +* report what's running in an entire cluster using kubeconfig at $HOME/.kube/config (with global flags defined in environment or in a config file): merkely report env k8s prod @@ -57,11 +57,12 @@ func newK8sEnvCmd(out io.Writer) *cobra.Command { o := new(k8sEnvOptions) cmd := &cobra.Command{ - Use: "k8s [-n namespace | -x namespace]... [-k /path/to/kube/config] [-i infrastructure-identifier] env-name", - Short: "Report images data from specific namespace(s) or entire cluster to Merkely.", - Long: k8sEnvDesc, - Aliases: []string{"kubernetes"}, - Example: k8sEnvExample, + Use: "k8s [-n namespace | -x namespace]... [-k /path/to/kube/config] [-i infrastructure-identifier] env-name", + Short: "Report images data from specific namespace(s) or entire cluster to Merkely.", + Long: k8sEnvDesc, + Aliases: []string{"kubernetes"}, + Example: k8sEnvExample, + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { if len(args) > 1 { return fmt.Errorf("only environment name argument is allowed") diff --git a/cmd/reporter/pipeline.go b/cmd/reporter/pipeline.go index 100f2a6a4..b229f793f 100644 --- a/cmd/reporter/pipeline.go +++ b/cmd/reporter/pipeline.go @@ -13,7 +13,7 @@ import ( ) const pipelineDesc = ` -Create a Merkely pipeline by providing a JSON pipefile. +Create a Merkely pipeline by providing a JSON pipefile. The pipefile contains the pipeline metadata and compliance template. ` @@ -45,10 +45,11 @@ type Pipefile struct { func newPipelineCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ - Use: "pipeline", - Short: "Create a Merkely pipeline", - Long: pipelineDesc, - Example: pipelineExample, + Use: "pipeline", + Short: "Create a Merkely pipeline", + Long: pipelineDesc, + Example: pipelineExample, + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { if len(args) > 1 { return fmt.Errorf("only pipefile path argument is allowed") diff --git a/cmd/reporter/report.go b/cmd/reporter/report.go index 0c4a48c6c..cce65f217 100644 --- a/cmd/reporter/report.go +++ b/cmd/reporter/report.go @@ -12,10 +12,11 @@ Report compliance events back to Merkely. func newReportCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ - Use: "report", - Short: "Report compliance events to Merkely.", - Long: reportDesc, - Aliases: []string{"log"}, + Use: "report", + Short: "Report compliance events to Merkely.", + Long: reportDesc, + DisableAutoGenTag: true, + Aliases: []string{"log"}, //SuggestFor: []string{"reportenv", "env report", "envreport"}, } diff --git a/cmd/reporter/requestApproval.go b/cmd/reporter/requestApproval.go index 49ac99e9a..63cb6b925 100644 --- a/cmd/reporter/requestApproval.go +++ b/cmd/reporter/requestApproval.go @@ -12,9 +12,10 @@ import ( func newRequestApprovalCmd(out io.Writer) *cobra.Command { o := new(approvalOptions) cmd := &cobra.Command{ - Use: "request ARTIFACT-NAME-OR-PATH", - Short: "Request an approval for deploying an artifact in Merkely. ", - Long: requestApprovalDesc(), + Use: "request ARTIFACT-NAME-OR-PATH", + Short: "Request an approval for deploying an artifact in Merkely. ", + Long: requestApprovalDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -71,6 +72,6 @@ func newRequestApprovalCmd(out io.Writer) *cobra.Command { func requestApprovalDesc() string { return ` Request an approval of a deployment of an artifact in Merkely. The request should be reviewed in Merkely UI. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ` } diff --git a/cmd/reporter/root.go b/cmd/reporter/root.go index 7a4b1a70d..0271c19a1 100644 --- a/cmd/reporter/root.go +++ b/cmd/reporter/root.go @@ -22,7 +22,7 @@ Environment variables: | $MERKELY_HOST | set the Merkely host. | | $MERKELY_DRY_RUN | indicate whether or not Merkely CLI is running in Dry Run mode. | | $MERKELY_MAX_API_RETRIES | set the maximum number of API calling retries when the API host is not reachable. | -| $MERKELY_CONFIG_FILE | set the path to Merkely config file where you can set your options. | +| $MERKELY_CONFIG_FILE | set the path to Merkely config file where you can set your options. | ` const ( @@ -50,11 +50,12 @@ type GlobalOpts struct { func newRootCmd(out io.Writer, args []string) (*cobra.Command, error) { global = new(GlobalOpts) cmd := &cobra.Command{ - Use: "merkely", - Short: "The Merkely evidence reporting CLI.", - Long: globalUsage, - SilenceUsage: true, - TraverseChildren: true, + Use: "merkely", + Short: "The Merkely evidence reporting CLI.", + Long: globalUsage, + SilenceUsage: true, + TraverseChildren: true, + DisableAutoGenTag: true, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { // You can bind cobra and viper in a few locations, but PersistencePreRunE on the root command works well return initializeConfig(cmd) diff --git a/cmd/reporter/serverEnv.go b/cmd/reporter/serverEnv.go index a1510d612..0a9e907ab 100644 --- a/cmd/reporter/serverEnv.go +++ b/cmd/reporter/serverEnv.go @@ -11,8 +11,8 @@ import ( ) const serverEnvDesc = ` -List the artifacts deployed in a server environment and their digests -and report them to Merkely. +List the artifacts deployed in a server environment and their digests +and report them to Merkely. ` const serverEnvExample = ` @@ -28,11 +28,12 @@ type serverEnvOptions struct { func newServerEnvCmd(out io.Writer) *cobra.Command { o := new(serverEnvOptions) cmd := &cobra.Command{ - Use: "server [-p /path/of/artifacts/directory] [-i infrastructure-identifier] env-name", - Short: "Report directory artifacts data in the given list of paths to Merkely.", - Long: serverEnvDesc, - Aliases: []string{"directories"}, - Example: serverEnvExample, + Use: "server [-p /path/of/artifacts/directory] [-i infrastructure-identifier] env-name", + Short: "Report directory artifacts data in the given list of paths to Merkely.", + Long: serverEnvDesc, + Aliases: []string{"directories"}, + Example: serverEnvExample, + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { if len(args) > 1 { return fmt.Errorf("only environment name argument is allowed") diff --git a/cmd/reporter/testEvidence.go b/cmd/reporter/testEvidence.go index 9b8da60d7..12dd98c24 100644 --- a/cmd/reporter/testEvidence.go +++ b/cmd/reporter/testEvidence.go @@ -26,9 +26,10 @@ type testEvidenceOptions struct { func newTestEvidenceCmd(out io.Writer) *cobra.Command { o := new(testEvidenceOptions) cmd := &cobra.Command{ - Use: "test ARTIFACT-NAME-OR-PATH", - Short: "Report/Log a JUnit test evidence to an artifact in Merkely. ", - Long: testEvidenceDesc(), + Use: "test ARTIFACT-NAME-OR-PATH", + Short: "Report/Log a JUnit test evidence to an artifact in Merkely. ", + Long: testEvidenceDesc(), + DisableAutoGenTag: true, PreRunE: func(cmd *cobra.Command, args []string) error { err := RequireGlobalFlags(global, []string{"Owner", "ApiToken"}) if err != nil { @@ -87,8 +88,8 @@ func newTestEvidenceCmd(out io.Writer) *cobra.Command { func testEvidenceDesc() string { return ` - Report a JUnit test evidence to an artifact in Merkely. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + Report a JUnit test evidence to an artifact in Merkely. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ` + GetCIDefaultsTemplates(supportedCIs, []string{"build-url"}) } diff --git a/cmd/reporter/version.go b/cmd/reporter/version.go index 911ddc359..baf9a042e 100644 --- a/cmd/reporter/version.go +++ b/cmd/reporter/version.go @@ -22,10 +22,11 @@ version.BuildInfo{Version:"v0.0.1", GitCommit:"fe51cd1e31e6a202cba7dead9552a6d41 func newVersionCmd(out io.Writer) *cobra.Command { cmd := &cobra.Command{ - Use: "version", - Short: "Print the client version information", - Long: versionDesc, - Args: NoArgs, + Use: "version", + Short: "Print the client version information", + Long: versionDesc, + Args: NoArgs, + DisableAutoGenTag: true, RunE: func(cmd *cobra.Command, args []string) error { return runVersion(out) }, diff --git a/docs.merkely.com/content/client_reference/merkely.md b/docs.merkely.com/content/client_reference/merkely.md index 7d7d68d82..4314a8a20 100644 --- a/docs.merkely.com/content/client_reference/merkely.md +++ b/docs.merkely.com/content/client_reference/merkely.md @@ -18,7 +18,7 @@ Environment variables: | $MERKELY_HOST | set the Merkely host. | | $MERKELY_DRY_RUN | indicate whether or not Merkely CLI is running in Dry Run mode. | | $MERKELY_MAX_API_RETRIES | set the maximum number of API calling retries when the API host is not reachable. | -| $MERKELY_CONFIG_FILE | set the path to Merkely config file where you can set your options. | +| $MERKELY_CONFIG_FILE | set the path to Merkely config file where you can set your options. | ### Options @@ -42,4 +42,3 @@ Environment variables: * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. * [merkely version](/client_reference/merkely_version/) - Print the client version information -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_control.md b/docs.merkely.com/content/client_reference/merkely_control.md index 67391fb2f..63baac5a0 100644 --- a/docs.merkely.com/content/client_reference/merkely_control.md +++ b/docs.merkely.com/content/client_reference/merkely_control.md @@ -33,4 +33,3 @@ Check if artifact is allowed to be deployed. * [merkely](/client_reference/merkely/) - The Merkely evidence reporting CLI. * [merkely control deployment](/client_reference/merkely_control_deployment/) - Check if an artifact in Merkely has been approved for deployment. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_control_deployment.md b/docs.merkely.com/content/client_reference/merkely_control_deployment.md index 0852175e8..400d23afc 100644 --- a/docs.merkely.com/content/client_reference/merkely_control_deployment.md +++ b/docs.merkely.com/content/client_reference/merkely_control_deployment.md @@ -9,7 +9,7 @@ Check if an artifact in Merkely has been approved for deployment. ### Synopsis Check if an artifact in Merkely has been approved for deployment. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ``` @@ -41,4 +41,3 @@ merkely control deployment ARTIFACT-NAME-OR-PATH [flags] * [merkely control](/client_reference/merkely_control/) - Check if artifact is allowed to be deployed. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_create.md b/docs.merkely.com/content/client_reference/merkely_create.md index c8b7d8d38..a875700ae 100644 --- a/docs.merkely.com/content/client_reference/merkely_create.md +++ b/docs.merkely.com/content/client_reference/merkely_create.md @@ -34,4 +34,3 @@ Create objects in Merkely. * [merkely create environment](/client_reference/merkely_create_environment/) - Create a Merkely environment * [merkely create pipeline](/client_reference/merkely_create_pipeline/) - Create a Merkely pipeline -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_create_environment.md b/docs.merkely.com/content/client_reference/merkely_create_environment.md index b5553efe6..93c53a694 100644 --- a/docs.merkely.com/content/client_reference/merkely_create_environment.md +++ b/docs.merkely.com/content/client_reference/merkely_create_environment.md @@ -50,4 +50,3 @@ merkely create environment --api-token 1234 --owner test --name newEnv --type K8 * [merkely create](/client_reference/merkely_create/) - Create objects in Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_create_pipeline.md b/docs.merkely.com/content/client_reference/merkely_create_pipeline.md index e1a781733..5d05e9f52 100644 --- a/docs.merkely.com/content/client_reference/merkely_create_pipeline.md +++ b/docs.merkely.com/content/client_reference/merkely_create_pipeline.md @@ -9,7 +9,7 @@ Create a Merkely pipeline ### Synopsis -Create a Merkely pipeline by providing a JSON pipefile. +Create a Merkely pipeline by providing a JSON pipefile. The pipefile contains the pipeline metadata and compliance template. @@ -61,4 +61,3 @@ merkely create pipeline --api-token 1234 /path/to/pipefile.json * [merkely create](/client_reference/merkely_create/) - Create objects in Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_fingerprint.md b/docs.merkely.com/content/client_reference/merkely_fingerprint.md index 89cf3e8f2..4e808602a 100644 --- a/docs.merkely.com/content/client_reference/merkely_fingerprint.md +++ b/docs.merkely.com/content/client_reference/merkely_fingerprint.md @@ -40,4 +40,3 @@ merkely fingerprint [flags] * [merkely](/client_reference/merkely/) - The Merkely evidence reporting CLI. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report.md b/docs.merkely.com/content/client_reference/merkely_report.md index 7975babf5..8b7f2a863 100644 --- a/docs.merkely.com/content/client_reference/merkely_report.md +++ b/docs.merkely.com/content/client_reference/merkely_report.md @@ -41,4 +41,3 @@ Report compliance events back to Merkely. * [merkely report request](/client_reference/merkely_report_request/) - Request an approval for deploying an artifact in Merkely. * [merkely report test](/client_reference/merkely_report_test/) - Report/Log a JUnit test evidence to an artifact in Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_approval.md b/docs.merkely.com/content/client_reference/merkely_report_approval.md index 6962cf23d..7fdee5dd2 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_approval.md +++ b/docs.merkely.com/content/client_reference/merkely_report_approval.md @@ -9,8 +9,8 @@ Approve deploying an artifact in Merkely. ### Synopsis - Approve a deployment of an artifact in Merkely. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + Approve a deployment of an artifact in Merkely. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ``` @@ -47,4 +47,3 @@ merkely report approval ARTIFACT-NAME-OR-PATH [flags] * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_artifact.md b/docs.merkely.com/content/client_reference/merkely_report_artifact.md index f36de82f9..90f883ec5 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_artifact.md +++ b/docs.merkely.com/content/client_reference/merkely_report_artifact.md @@ -9,9 +9,9 @@ Report/Log an artifact to Merkely. ### Synopsis - Report an artifact to a pipeline in Merkely. - The artifact SHA256 fingerprint is calculated and reported - or,alternatively, can be provided directly. + Report an artifact to a pipeline in Merkely. + The artifact SHA256 fingerprint is calculated and reported + or,alternatively, can be provided directly. The following flags are defaulted as follows in the CI list below: @@ -66,4 +66,3 @@ merkely report artifact ARTIFACT-NAME-OR-PATH [flags] * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_deployment.md b/docs.merkely.com/content/client_reference/merkely_report_deployment.md index 086bdc13c..26b899b36 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_deployment.md +++ b/docs.merkely.com/content/client_reference/merkely_report_deployment.md @@ -9,9 +9,9 @@ Report/Log a deployment to Merkely. ### Synopsis - Report a deployment of an artifact to an environment in Merkely. - The artifact SHA256 fingerprint is calculated and reported - or,alternatively, can be provided directly. + Report a deployment of an artifact to an environment in Merkely. + The artifact SHA256 fingerprint is calculated and reported + or,alternatively, can be provided directly. The following flags are defaulted as follows in the CI list below: @@ -60,4 +60,3 @@ merkely report deployment ARTIFACT-NAME-OR-PATH [flags] * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_env.md b/docs.merkely.com/content/client_reference/merkely_report_env.md index 58e27fc72..756ab65c5 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_env.md +++ b/docs.merkely.com/content/client_reference/merkely_report_env.md @@ -38,4 +38,3 @@ This allows Merkely to determine Runtime compliance status of the environment. * [merkely report env k8s](/client_reference/merkely_report_env_k8s/) - Report images data from specific namespace(s) or entire cluster to Merkely. * [merkely report env server](/client_reference/merkely_report_env_server/) - Report directory artifacts data in the given list of paths to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_env_ecs.md b/docs.merkely.com/content/client_reference/merkely_report_env_ecs.md index 88f0e3956..b63a5b49c 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_env_ecs.md +++ b/docs.merkely.com/content/client_reference/merkely_report_env_ecs.md @@ -9,8 +9,8 @@ Report images data from AWS ECS cluster to Merkely. ### Synopsis -List the artifacts deployed in an AWS ECS cluster and their digests -and report them to Merkely. +List the artifacts deployed in an AWS ECS cluster and their digests +and report them to Merkely. ``` @@ -51,4 +51,3 @@ merkely report env ecs prod --api-token 1234 --owner exampleOrg * [merkely report env](/client_reference/merkely_report_env/) - Report running artifacts in an environment to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_env_k8s.md b/docs.merkely.com/content/client_reference/merkely_report_env_k8s.md index dcbe47c77..04f0528af 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_env_k8s.md +++ b/docs.merkely.com/content/client_reference/merkely_report_env_k8s.md @@ -9,8 +9,8 @@ Report images data from specific namespace(s) or entire cluster to Merkely. ### Synopsis -List the artifacts deployed in the k8s environment and their digests -and report them to Merkely. +List the artifacts deployed in the k8s environment and their digests +and report them to Merkely. ``` @@ -24,7 +24,7 @@ merkely report env k8s [-n namespace | -x namespace]... [-k /path/to/kube/config * report what's running in an entire cluster using kubeconfig at $HOME/.kube/config: merkely report env k8s prod --api-token 1234 --owner exampleOrg --id prod-cluster -* report what's running in an entire cluster using kubeconfig at $HOME/.kube/config +* report what's running in an entire cluster using kubeconfig at $HOME/.kube/config (with global flags defined in environment or in a config file): merkely report env k8s prod @@ -65,4 +65,3 @@ merkely report env k8s prod -k /path/to/kube/config * [merkely report env](/client_reference/merkely_report_env/) - Report running artifacts in an environment to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_env_server.md b/docs.merkely.com/content/client_reference/merkely_report_env_server.md index 09e4684fa..d2cd3f934 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_env_server.md +++ b/docs.merkely.com/content/client_reference/merkely_report_env_server.md @@ -9,8 +9,8 @@ Report directory artifacts data in the given list of paths to Merkely. ### Synopsis -List the artifacts deployed in a server environment and their digests -and report them to Merkely. +List the artifacts deployed in a server environment and their digests +and report them to Merkely. ``` @@ -50,4 +50,3 @@ merkely report env server prod --api-token 1234 --owner exampleOrg --id prod-ser * [merkely report env](/client_reference/merkely_report_env/) - Report running artifacts in an environment to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_evidence.md b/docs.merkely.com/content/client_reference/merkely_report_evidence.md index 07adbebf8..1d0020cd6 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_evidence.md +++ b/docs.merkely.com/content/client_reference/merkely_report_evidence.md @@ -9,8 +9,8 @@ Report/Log an evidence to an artifact in Merkely. ### Synopsis - Report an evidence to an artifact in Merkely. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + Report an evidence to an artifact in Merkely. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. The following flags are defaulted as follows in the CI list below: @@ -60,4 +60,3 @@ merkely report evidence ARTIFACT-NAME-OR-PATH [flags] * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_request.md b/docs.merkely.com/content/client_reference/merkely_report_request.md index 89e8fe093..4e09903ca 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_request.md +++ b/docs.merkely.com/content/client_reference/merkely_report_request.md @@ -10,7 +10,7 @@ Request an approval for deploying an artifact in Merkely. Request an approval of a deployment of an artifact in Merkely. The request should be reviewed in Merkely UI. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. ``` @@ -47,4 +47,3 @@ merkely report request ARTIFACT-NAME-OR-PATH [flags] * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_report_test.md b/docs.merkely.com/content/client_reference/merkely_report_test.md index cfccb0fcc..786e2d41b 100644 --- a/docs.merkely.com/content/client_reference/merkely_report_test.md +++ b/docs.merkely.com/content/client_reference/merkely_report_test.md @@ -9,8 +9,8 @@ Report/Log a JUnit test evidence to an artifact in Merkely. ### Synopsis - Report a JUnit test evidence to an artifact in Merkely. - The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. + Report a JUnit test evidence to an artifact in Merkely. + The artifact SHA256 fingerprint is calculated or alternatively it can be provided directly. The following flags are defaulted as follows in the CI list below: @@ -60,4 +60,3 @@ merkely report test ARTIFACT-NAME-OR-PATH [flags] * [merkely report](/client_reference/merkely_report/) - Report compliance events to Merkely. -###### Auto generated by spf13/cobra on 24-Nov-2021 diff --git a/docs.merkely.com/content/client_reference/merkely_version.md b/docs.merkely.com/content/client_reference/merkely_version.md index 16bea98cf..c6a63a5f7 100644 --- a/docs.merkely.com/content/client_reference/merkely_version.md +++ b/docs.merkely.com/content/client_reference/merkely_version.md @@ -46,4 +46,3 @@ merkely version [flags] * [merkely](/client_reference/merkely/) - The Merkely evidence reporting CLI. -###### Auto generated by spf13/cobra on 24-Nov-2021