mirror of https://github.com/knative/docs.git
update configure-kn.md to include channel-type-mappings and add comments to sample yaml (#5591)
* update configure-kn.md to include channel-type-mappings and add comments to sample yaml * Update docs/client/configure-kn.md --------- Co-authored-by: David Simansky <dsimansk@redhat.com>
This commit is contained in:
parent
a52897a7e7
commit
70708b04cd
|
@ -9,15 +9,36 @@ You can customize your `kn` CLI setup by creating a `config.yaml` configuration
|
|||
## Example configuration file
|
||||
|
||||
```yaml
|
||||
# Plugins related configuration
|
||||
plugins:
|
||||
# Whether to lookup configuration in the execution path (default: true). This option is deprecated and will be removed in a future version where path lookup will be enabled unconditionally
|
||||
path-lookup: true
|
||||
# Directory from where plugins with the prefix "kn-" are looked up. (default: "$base_dir/plugins"
|
||||
# where "$base_dir" is the directory where this configuration file is stored)
|
||||
directory: ~/.config/kn/plugins
|
||||
# Eventing related configuration
|
||||
eventing:
|
||||
# List of sink mappings that allow custom prefixes wherever a sink
|
||||
# specification is used (like for the --sink option of a broker)
|
||||
sink-mappings:
|
||||
# Prefix as used in the command (e.g. "--sink svc:myservice")
|
||||
- prefix: svc
|
||||
# Api group of the mapped resource
|
||||
group: core
|
||||
# Api version of the mapped resource
|
||||
version: v1
|
||||
# Resource name (lowercased plural form of the 'kind')
|
||||
resource: services
|
||||
# Channel mappings that you can use in --channel options
|
||||
channel-type-mappings:
|
||||
# Alias that can be used as a type for a channel option (e.g. "kn create channel mychannel --type Kafka")
|
||||
- alias: Kafka
|
||||
# Api group of the mapped resource
|
||||
group: messaging.knative.dev
|
||||
# Api version of the mapped resource
|
||||
version: v1beta1
|
||||
# Kind of the resource
|
||||
kind: KafkaChannel
|
||||
```
|
||||
|
||||
Where
|
||||
|
@ -30,3 +51,8 @@ Where
|
|||
- `group`: The API group of the Kubernetes resource.
|
||||
- `version`: The version of the Kubernetes resource.
|
||||
- `resource`: The lowercased, plural name of the Kubernetes resource type. For example, `services` or `brokers`.
|
||||
- `channel-type-mappings` can be used to define aliases for custom channel types that can be used wherever a channel type is required (as in `kn channel create --type`). This configuration section defines an array of entries with the following fields:
|
||||
- `alias`: The name that can be used as the type
|
||||
- `group`: The APIGroup of the channel CRD.
|
||||
- `version`: The version of the channel CRD.
|
||||
- `kind`: Kind of the channel CRD (e.g. `KafkaChannel`)
|
Loading…
Reference in New Issue