LinuxCommandLibrary

crane-validate

Validate CloudEvents data against schema

TLDR

Validate an image

$ crane validate
copy

Skip downloading/digesting layers
$ crane validate --fast
copy

Name of remote image to validate
$ crane validate --remote [image_name]
copy

Path to tarball to validate
$ crane validate --tarball [path/to/tarball]
copy

Display help
$ crane validate [[-h|--help]]
copy

SYNOPSIS

crane validate manifest_file [flags]

PARAMETERS

manifest_file
    Path to the Crane manifest file to validate. Can be a local file or a URL.

--help
    Displays help information about the validate command.

--version
    Shows the Crane version information.

DESCRIPTION

The `crane validate` command is a crucial tool for ensuring the correctness and validity of your Crane manifests before deploying them. It checks if the provided manifest adheres to the expected schema, identifying potential errors and inconsistencies. This proactive validation helps prevent deployment failures and unexpected behavior in your applications. The command supports both local files and remote URLs as input. A successful validation confirms that the manifest is well-formed and structurally correct. However, successful validation doesn't guarantee that the manifest's logic is flawless, but it's a vital first step. This command is primarily used by developers, operators, and automation pipelines to enforce manifest quality and reliability during continuous integration and continuous deployment (CI/CD) processes. By incorporating `crane validate` into these workflows, teams can catch errors early in the development lifecycle, saving time and resources.

CAVEATS

Validation only confirms the structure and schema adherence. It does not guarantee the logical correctness of the manifest's configuration.

EXIT CODES

The `crane validate` command returns an exit code of 0 upon successful validation. A non-zero exit code indicates a validation failure, signaling that errors were found in the manifest.

SEE ALSO

crane(1), kubectl(1)

Copied to clipboard