Custom Plugin - Not getting deployed/enabled

[saravanan-periyasamy03]

Team, We are trying to deploy the https://github.com/nokia/consumer-rate-limiting custom plugin to our k8's based open-source kong gateway integrated with Postgres DB. Step1, created ConfigMap and updated the plugin configuration in the Kong CR file. Since this plugin has a migrations job (new table creation), added the subdirectory in the plugin configuration in the CR file as below.

plugins:
  configMaps:
  - pluginName: consumer-rate-limiting
    name: kong-plugin-consumer-rate-limiting
    subdirectories:
    - name: kong-plugin-consumer-rate-limiting-migrations
      path: migrations

Also added the init.lua file in the migrations folder in the custom plugin. While applying the Kong kind(CR), pods are not coming up and throwing below error,

waiting for db
Error: /usr/local/share/lua/5.1/kong/cmd/start.lua:64: nginx: [warn] the "user" directive makes sense only if the master process runs with super-user privileges, ignored in /kong_prefix/nginx.conf:6
nginx: [error] init_by_lua error: attempt to compare string with number
stack traceback:
  [C]: in function 'sort'
  /usr/local/share/lua/5.1/kong/db/errors.lua:21: in function 'sorted_keys'
  /usr/local/share/lua/5.1/kong/db/errors.lua:222: in function 'schema_violation'
  /usr/local/share/lua/5.1/kong/db/migrations/state.lua:117: in function 'load_subsystems'
  /usr/local/share/lua/5.1/kong/db/migrations/state.lua:187: in function 'load'
  /usr/local/share/lua/5.1/kong/db/init.lua:432: in function 'schema_state'
  /usr/local/share/lua/5.1/kong/init.lua:474: in function 'init'
  init_by_lua:3: in main chunk
lua:3: in main chunk

Even though pre and post-migrations jobs are successful, new tables are not getting created.

[fffonion]

Hi @SaravananPeriyasamy03 , this feels to me something goes wrong with the migration file, is it possible to share
to share the init.lua file in the migrations folder?

[saravanan-periyasamy03]

HI @fffonion ,

Migrations folder got below three files,

postgres.lua

return {
  {
    name = "2017-09-20-165700_init_consumerratelimiting",
    up = [[
      CREATE TABLE IF NOT EXISTS consumerratelimiting_quotas (
        consumer_id text,
        route_id text,
        quota integer,
        PRIMARY KEY (consumer_id, route_id)
      );
      CREATE TABLE IF NOT EXISTS consumerratelimiting_call_count (
        consumer_id text,
        route_id text,
        period integer,
        call_count integer,
        PRIMARY KEY (consumer_id, route_id, period)
      );
    ]],
    teardown = [[
      DROP TABLE consumerratelimiting_quotas;
      DROP TABLE consumerratelimiting_call_count;
    ]]
  }
}

cassandra.lua

return {
    {
      name = "2017-09-20-165400_init_consumerratelimiting",
      up = [[
        CREATE TABLE IF NOT EXISTS consumerratelimiting_quotas (
          consumer_id text,
          route_id text,
          quota int,
          PRIMARY KEY (consumer_id, route_id)
        );
        CREATE TABLE IF NOT EXISTS consumerratelimiting_call_count (
          consumer_id text,
          route_id text,
          period int,
          call_count int,
          PRIMARY KEY (consumer_id, route_id, period)
        );
      ]],
      teardown = [[
        DROP TABLE consumerratelimiting_quotas;
        DROP TABLE consumerratelimiting_call_count;
      ]]
    }
  }

init.lua

return {
    "postgres"
  }

Please let me know what is wrong with the configuration

[fffonion]

Ah i see, i think it's because the plugin has been inactive in a while and the migration is in legacy format.
In init.lua you should have the migration name file name, like:

return {
    "000_init"
}

Then in 000_init.lua, you will have:

return {
  postgres = {
    up = [[
      CREATE TABLE IF NOT EXISTS consumerratelimiting_quotas (
        consumer_id text,
        route_id text,
        quota integer,
        PRIMARY KEY (consumer_id, route_id)
      );
      CREATE TABLE IF NOT EXISTS consumerratelimiting_call_count (
        consumer_id text,
        route_id text,
        period integer,
        call_count integer,
        PRIMARY KEY (consumer_id, route_id, period)
      );
    ]]
  },
  cassandra = {
    up = [[
        CREATE TABLE IF NOT EXISTS consumerratelimiting_quotas (
          consumer_id text,
          route_id text,
          quota int,
          PRIMARY KEY (consumer_id, route_id)
        );
        CREATE TABLE IF NOT EXISTS consumerratelimiting_call_count (
          consumer_id text,
          route_id text,
          period int,
          call_count int,
          PRIMARY KEY (consumer_id, route_id, period)
        );
      ]]
  }
}

Note that you don't need the teardown here, the name is kind of confusing: it's not meant for migration rollback, but
rather in a zero-downtime migration (executed in kong migrations finish) when you want to delete or alter some fields in older versions.

[fffonion]

Apart from the migration, I'm not sure if the plugin is compatible with latest Kong. I think opening an issue report to
that plugin repo will also be beneficial to other community users.