Documentation

Recent changes

Migrating config from KrakenD 1.x or 0.x

The KrakenD 2.0 release is a major version that simplifies the configuration of v1.x and standardizes field names that were using different criteria to declare the attributes.

This migration allows you to:

  • Migrate from KrakenD 0.x to 2.x
  • Migrate from KrakenD 1.0 to 2.x
  • Migrate from KrakenD 1.2 to 2.x
  • Migrate from KrakenD 1.3 to 2.x
  • Migrate from KrakenD 1.4 to 2.x

Migrating to KrakenD 2.0 and above

  • Use git or similar DVCS to track the changes. Compare the differences at the end.
  • Download the configuration migration tool and execute it passing the path to your KrakenD project
  • Review the changes the migration tool did to your config and start the config with the new version

If you have custom go plugins, recompile them. KrakenD has now a command krakend check-plugin to test them.

Special attention to short words
The migration script replaces words used by KrakenD in the past and are no longer supported that might collide with wording you use in your endpoints. Words like whitelist or blacklist will be replaced by allow and deny. Make sure to check the changes in the configuration and ensure that the migration tool didn’t change any endpoint definition using those names.

Changes from 1.x to 2.x

There is nothing else you need to do other than using the migration tool, but below we explain what are those changes.

The migration tool will take care of what is described below for you, and is actually quite simple. For the most part, what it does is to rename configurations and namespaces.

Renamed namespaces

The most visible change is that all non-core components (this is everything outside of Lura) were declared inside an extra_config section, using a looong namespace. That namespace contained what it could look like an URL (e.g: github.com/devopsfaith/krakend-jose/validator) and was generating frequent missunderstanding year after year. Now all nampespaces have been categorized and simplified to a description of its functionality (e.g.: auth/validator).

For the full list of renamed namespaces see the source code of the migration tool.

Consistent attribute naming

Another relevant change is that some attributes have been renamed now to have a consistent naming accross all configurations. Prior to 2.0 some attributes name used hyphenation (hyphen-ation), while others used snake case (snake_case) or camel case (camelCase). Now we use snake_case everywhere if possible.

Removed deprecated elements

The final change is that all functionalities and attributes that were marked as deprecated on 1.4 have been removed.

  • whitelist is removed, and only allow is recognized now
  • blacklist is removed, and only deny is recognized now
  • krakend-etc is no longer included in the binary
  • krakend-consul, the integration of consul for the JWT revoker, is no longer included in the binary.

Summing up, see the before and after of the following snippet which has 3 of the changes mentioned above.

KrakenD 1:

{
    "endpoint": "/foo",
    "extra_config": {
        "github.com/devopsfaith/krakend-jose/validator" {
            "alg": "RS256",
            "jwk-url": "https://url/to/jwks.json"
        }
    },
    "backend": [
        {
            "url_pattern": "/foo",
            "whitelist": ["field1", "field2"]
        }
    ]
}

KrakenD 2: Differences highlighted

{
    "endpoint": "/foo",
    "extra_config": {
        "auth/validator": {
            "alg": "RS256",
            "jwk_url": "https://url/to/jwks.json"
        }
    },
    "backend": [
        {
            "url_pattern": "/foo",
            "allow": ["field1", "field2"]
        }
    ]
}

Unresolved issues?

The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.

We use cookies to understand how you use our site and to improve your overall experience. By continuing to use our site, you accept our Privacy Policy. More information