このページは、まだ日本語ではご利用いただけません。翻訳中です。
旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。
deck file patch
Apply patches on top of a decK file.
The input file is read, the patches are applied, and if successful, written
to the output file. The patches can be specified by a --selector
and one or more
--value
tags, or via patch files.
When using --selector
and --values
, the items are selected by the selector
,
which is a JSONPath query. From the array of nodes found, only the objects are updated.
The values
are applied on each of the JSONObjects returned by the selector
.
The value must be a valid JSON snippet, so use single/double quotes appropriately. If the value is empty, the field is removed from the object.
Examples of valid values:
# set field "read_timeout" to a numeric value of 10000
--selector="$..services[*]" --value="read_timeout:10000"
# set field "_comment" to a string value
--selector="$..services[*]" --value='_comment:"comment injected by patching"'
# set field "_ignore" to an array of strings
--selector="$..services[*]" --value='_ignore:["ignore1","ignore2"]'
# remove fields "_ignore" and "_comment" from the object
--selector="$..services[*]" --value='_ignore:' --value='_comment:'
# append entries to the methods array of all route objects
--selector="$..routes[*].methods" --value='["OPTIONS"]'
Patch files have the following format (JSON or YAML) and can contain multiple patches that are applied in order:
{ "_format_version": "1.0",
"patches": [
{ "selectors": [
"$..services[*]"
],
"values": {
"read_timeout": 10000,
"_comment": "comment injected by patching"
},
"remove": [ "_ignore" ]
}
]
}
If the values
object instead is an array, then any arrays returned by the selectors
will get the values
appended to them.
Syntax
deck file patch [command-specific flags] [global flags] [...patch-files]
Examples
# update the read-timeout on all services
cat kong.yml | deck file patch --selector="$..services[*]" --value="read_timeout:10000"
Flags
--format
- Output format: yaml or json. (Default:
"yaml"
) -
-h
,--help
- Help for patch.
-
-o
,--output-file
- Output file to write to. Use
-
to write to stdout. (Default:"-"
) --selector
- json-pointer identifying the element to patch. Repeat for multiple selectors.
Warning: The JSONPath implementation has a known issue related to recursive descent with expressions. Expressions following a recursive descent do not work as expected, however, a workaround is available by preceding the expression with a wildcard selection. For example,
$..plugins[?(@.regex_priority>100)]
must be expressed as$..plugins[*][?(@.regex_priority>100)]
. See the go-apiops library documentation for details on this issue.
-
-s
,--state
- decK file to process. Use
-
to read from stdin. (Default:"-"
) --value
- A value to set in the selected entry in
<key:value>
format. Can be specified multiple times.
Global flags
--analytics
- Share anonymized data to help improve decK.
Use
--analytics=false
to disable this. (Default:true
) --ca-cert
- Custom CA certificate (raw contents) to use to verify Kong’s Admin TLS certificate.
This value can also be set using DECK_CA_CERT environment variable.
This takes precedence over
--ca-cert-file
flag. --ca-cert-file
- Path to a custom CA certificate to use to verify Kong’s Admin TLS certificate. This value can also be set using DECK_CA_CERT_FILE environment variable.
--config
- Config file (default is $HOME/.deck.yaml).
--headers
- HTTP headers (key:value) to inject in all requests to Kong’s Admin API. This flag can be specified multiple times to inject multiple headers.
--kong-addr
- HTTP address of Kong’s Admin API.
This value can also be set using the environment variable DECK_KONG_ADDR
environment variable. (Default:
"http://localhost:8001"
) --kong-cookie-jar-path
- Absolute path to a cookie-jar file in the Netscape cookie format for auth with Admin Server. You may also need to pass in as header the User-Agent that was used to create the cookie-jar.
--konnect-addr
- Address of the Konnect endpoint. (Default:
"https://us.api.konghq.com"
) --konnect-token
- Token associated with your Konnect account. This takes precedence over the
--konnect-token-file
flag. --konnect-token-file
- File containing the token associated with your Konnect account.
--konnect-control-plane-name
- Konnect control plane name.
--no-color
- Disable colorized output (Default:
false
) --skip-workspace-crud
- Skip API calls related to Workspaces (Kong Gateway Enterprise only). (Default:
false
) --timeout
- Set a request timeout for the client to connect with Kong (in seconds). (Default:
10
) --tls-client-cert
- PEM-encoded TLS client certificate to use for authentication with Kong’s Admin API. This value can also be set using DECK_TLS_CLIENT_CERT environment variable. Must be used in conjunction with tls-client-key
--tls-client-cert-file
- Path to the file containing TLS client certificate to use for authentication with Kong’s Admin API. This value can also be set using DECK_TLS_CLIENT_CERT_FILE environment variable. Must be used in conjunction with tls-client-key-file
--tls-client-key
- PEM-encoded private key for the corresponding client certificate . This value can also be set using DECK_TLS_CLIENT_KEY environment variable. Must be used in conjunction with tls-client-cert
--tls-client-key-file
- Path to file containing the private key for the corresponding client certificate. This value can also be set using DECK_TLS_CLIENT_KEY_FILE environment variable. Must be used in conjunction with tls-client-cert-file
--tls-server-name
- Name to use to verify the hostname in Kong’s Admin TLS certificate. This value can also be set using DECK_TLS_SERVER_NAME environment variable.
--tls-skip-verify
- Disable verification of Kong’s Admin TLS certificate.
This value can also be set using DECK_TLS_SKIP_VERIFY environment variable. (Default:
false
) --verbose
- Enable verbose logging levels
Setting this value to 2 outputs all HTTP requests/responses
between decK and Kong. (Default:
0
)
See also
File subcommands:
- deck file add-plugins - Add plugins to objects in a decK file
- deck file add-tags - Add tags to objects in a decK file
- deck file convert - Convert files from one format into another format
- deck file lint - Validate a file against a ruleset
- deck file list-tags - List current tags from objects in a decK file
- deck file merge - Merge multiple decK files into one
- deck file namespace - Apply a namespace to routes in a decK file by prefixing the path.
- deck file openapi2kong - Convert OpenAPI specifications to Kong’s decK format
- deck file patch - Apply patches on top of a decK file
- deck file remove-tags - Remove tags from objects in a decK file
- deck file render - Combines multiple complete configuration files and renders them as one Kong declarative config file.
- deck file validate - Locally validates the state file for basic structure or relationship errors.