LinuxCommandLibrary

crane-config

Configure crane, an OCI registry client

TLDR

Get the configuration of an image

$ crane config [image_name]
copy

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

SYNOPSIS

crane-config [OPTIONS] command [ARGS...]

PARAMETERS

--help
    Displays the help message for the crane-config command.

get key
    Retrieves the value of a specified configuration key.

set key value
    Sets the value of a specified configuration key.

unset key
    Unsets the value of a specified configuration key, reverting to the default value.

view
    Displays the current configuration settings.

DESCRIPTION

The `crane-config` command is used to manage the configuration settings for the Crane application. Crane is a tool that simplifies the process of migrating Kubernetes resources between different clusters or namespaces. `crane-config` allows users to view the current configuration, modify parameters, and set defaults. This command is essential for customizing Crane's behavior to fit specific migration needs. Common tasks include specifying default image registries, setting resource limits, and configuring network policies. The `crane-config` tool ensures that migration operations are performed consistently and predictably across different environments, improving the overall reliability and efficiency of Kubernetes resource management. Modifying the default configuration without proper understanding can impact Crane's performance.

CAVEATS

Incorrectly modifying the configuration can lead to unexpected behavior and potential data loss during migrations. Always back up your configuration before making changes. It's recommended to consult the Crane documentation before modifying configuration parameters.

<B>EXAMPLES</B>

View Current Configuration:
crane-config view

Set Default Image Registry:
crane-config set default_image_registry my-registry.io

Get Value of Default Image Registry:
crane-config get default_image_registry

SEE ALSO

kubectl(1), helm(1)

Copied to clipboard