Update README.md (#167)

This commit is contained in:
Chris O'Haver 2019-05-14 12:09:59 -04:00 committed by GitHub
parent f1dac88b86
commit 517138abe4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -24,16 +24,16 @@ Plugin "baz" is unsupported by this migration tool in <version>.
`Deprecated(fromCoreDNSVersion, toCoreDNSVersion, corefileStr string) ([]Notice, error)` `Deprecated(fromCoreDNSVersion, toCoreDNSVersion, corefileStr string) ([]Notice, error)`
Deprecated returns a list of deprecation notices affecting the given Corefile. Notices are returned for Deprecated returns a list of deprecation notices affecting the given Corefile. Notices are returned for
any deprecated, removed, or ignored plugins/directives present in the Corefile. Notices are also returned for any deprecated, removed, or ignored plugins/options present in the Corefile. Notices are also returned for
any new default plugins that would be added in a migration. Notices any new default plugins that would be added in a migration. Notices
`Migrate(fromCoreDNSVersion, toCoreDNSVersion, corefileStr string, deprecations bool) (string, error)` `Migrate(fromCoreDNSVersion, toCoreDNSVersion, corefileStr string, deprecations bool) (string, error)`
Migrate returns a migrated version of the Corefile, or an error if it cannot. It will: Migrate returns a migrated version of the Corefile, or an error if it cannot. It will:
* replace/convert any plugins/directives that have replacements (e.g. _proxy_ -> _forward_) * replace/convert any plugins/options that have replacements (e.g. _proxy_ -> _forward_)
* return an error if replacable plugins/directives cannot be converted (e.g. proxy _options_ not available in _forward_) * return an error if replacable plugins/options cannot be converted (e.g. proxy _options_ not available in _forward_)
* remove plugins/directives that do not have replacements (e.g. kubernetes `upstream`) * remove plugins/options that do not have replacements (e.g. kubernetes `upstream`)
* add in any new default plugins where applicable if they are not already present (e.g. adding _loop_ plugin when it was added). * add in any new default plugins where applicable if they are not already present (e.g. adding _loop_ plugin when it was added).
This will have to be case by case, and could potentially get complicated. This will have to be case by case, and could potentially get complicated.
* If deprecations is true, deprecated plugins/options will be migrated as soon as they are deprecated. * If deprecations is true, deprecated plugins/options will be migrated as soon as they are deprecated.