Customizing kn

You can customize your kn CLI setup by creating a config.yaml configuration file. You can provide this configuration by using the --config flag, otherwise the configuration is picked up from a default location. The default configuration location conforms to the XDG Base Directory Specification, and is different for Unix systems and Windows systems.

  • If the XDG_CONFIG_HOME environment variable is set, the default configuration location that kn looks for is $XDG_CONFIG_HOME/kn.
  • If the XDG_CONFIG_HOME environment variable is not set, kn looks for the configuration in the home directory of the user at $HOME/.config/kn/config.yaml.
  • For Windows systems, the default kn configuration location is %APPDATA%\kn.

Example configuration file

  1. plugins:
  2.   path-lookup: true
  3.   directory: ~/.config/kn/plugins
  4. eventing:
  5.   sink-mappings:
  6.   - prefix: svc
  7.     group: core
  8.     version: v1
  9.     resource: services

Where

  • path-lookup specifies whether kn should look for plugins in the PATH environment variable. This is a boolean configuration option. The default value is false.
  • directory specifies the directory where kn will look for plugins. The default path depends on the operating system, as described above. This can be any directory that is visible to the user.
  • sink-mappings defines the Kubernetes Addressable resource that is used when you use the --sink flag with a kn CLI command.
    • prefix: The prefix you want to use to describe your sink. Service, svc, channel, and broker are predefined prefixes in kn.
    • group: The API group of the Kubernetes resource.
    • version: The version of the Kubernetes resource.
    • resource: The plural name of the Kubernetes resource type. For example, services or brokers.