refactoring: updated examples/kv to latest cartridge

Author: vasiliy-t

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Bump operator-sdk version (and other dependencies)
 - Refactor project structure, all helm charts are collected in one place
 - Update crds api version from `apiextensions.k8s.io/v1beta1` to `apiextensions.k8s.io/v1`
+- Updated kv example to the most recent cartridge version
 
 ### Fixed
 

README.md

@@ -20,7 +20,7 @@ ReplicasetTemplate.
 * [Resource ownership](#resource-ownership)
 * [Documentation](#documentation)
 * [Deploying the Tarantool operator on minikube](#deploying-the-tarantool-operator-on-minikube)
-* [Example: key-value storage](#example-key-value-storage)
+* [Example: key-value storage](#example-application-key-value-storage)
   * [Application topology](#application-topology)
   * [Running the application](#running-the-application)
   * [Scaling the application](#scaling-the-application)

examples/kv/.cartridge.yml

@@ -0,0 +1,9 @@
+---
+# Here you can specify default parameters for local running, such as:
+
+# cfg: path-to-cfg-file
+# log-dir: path-to-log-dir
+# run-dir: path-to-run-dir
+# data-dir: path-to-data-dir
+
+stateboard: false # If no arguments are supplied, --stateboard flag is true

examples/kv/.gitignore

@@ -0,0 +1,22 @@
+.rocks
+.swo
+.swp
+CMakeCache.txt
+CMakeFiles
+cmake_install.cmake
+*.dylib
+*.idea
+__pycache__
+*pyc
+.cache
+.pytest_cache
+.vagrant
+.DS_Store
+*.xlog
+*.snap
+*.rpm
+*.deb
+*.tar.gz
+node_modules
+/tmp/*
+!/tmp/.keep

examples/kv/.luacheckrc

@@ -0,0 +1,4 @@
+include_files = {'**/*.lua', '*.luacheckrc', '*.rockspec'}
+exclude_files = {'.rocks/', 'tmp/'}
+max_line_length = 120
+redefined = false

examples/kv/.luacov

@@ -0,0 +1,6 @@
+
+statsfile = 'tmp/luacov.stats.out'
+reportfile = 'tmp/luacov.report.out'
+exclude = {
+	'/test/',
+}

examples/kv/Dockerfile

@@ -0,0 +1,13 @@
+# Simple Dockerfile
+# Used by "pack" command as a base for build image
+# when --use-docker option is specified
+#
+# Image based on centos:7 is expected to be used
+FROM centos:7
+
+# Here you can install some packages required
+#   for your application build
+#
+# RUN set -x \
+#    && curl -sL https://rpm.nodesource.com/setup_10.x | bash - \
+#    && yum -y install nodejs

examples/kv/Dockerfile.build.cartridge

@@ -0,0 +1,16 @@
+# Simple Dockerfile
+# Used by "pack docker" command as a base for runtime image
+#
+# Image based on centos:7 is expected to be used
+FROM centos:7
+
+# Here you can install some packages required
+#   for your application in runtime
+#
+#
+# For example, if you need to install some python packages,
+#   you can do it this way:
+#
+# COPY requirements.txt /tmp
+# RUN yum install -y python3-pip
+# RUN pip3 install -r /tmp/requirements.txt

examples/kv/Dockerfile.cartridge

@@ -0,0 +1,39 @@
+local cli_admin = require('cartridge-cli-extensions.admin')
+
+-- register admin function probe to use it with "cartridge admin"
+local function init()
+    cli_admin.init()
+
+    local probe = {
+        usage = 'Probe instance',
+        args = {
+            uri = {
+                type = 'string',
+                usage = 'Instance URI',
+            },
+        },
+        call = function(opts)
+            opts = opts or {}
+
+            if opts.uri == nil then
+                return nil, "Please, pass instance URI via --uri flag"
+            end
+
+            local cartridge_admin = require('cartridge.admin')
+            local ok, err = cartridge_admin.probe_server(opts.uri)
+
+            if not ok then
+                return nil, err.err
+            end
+
+            return {
+                string.format('Probe %q: OK', opts.uri),
+            }
+        end,
+    }
+
+    local ok, err = cli_admin.register('probe', probe.usage, probe.args, probe.call)
+    assert(ok, err)
+end
+
+return {init = init}

examples/kv/Makefile

@@ -0,0 +1,130 @@
+local cartridge = require('cartridge')
+local router_api = require('app.router.api')
+
+local function handle_create(req)
+    local status, body = pcall(function() return req:json() end)
+
+    if type(body) == 'string' then
+        local resp = req:render{json = { info = msg }}
+        resp.status = 500
+        return resp
+    end
+
+    if body['key'] == nil then
+        local resp = req:render{json = { info = msg }}
+        resp.status = 400
+        return resp
+    end
+
+    if body['value'] == nil then
+        local resp = req:render{json = { info = msg }}
+        resp.status = 400
+        return resp
+    end
+
+    local data, err = router_api.create(body['key'], body['value'])
+    if err ~= nil then
+        local resp = req:render({json = {error = err}})
+        resp.status = 500
+        return resp
+    end
+
+    local resp = req:render({json = data})
+    resp.status = 201
+
+    return resp
+end
+
+local function handle_get(req)
+    local key = req:stash('key')
+    local data, err = router_api.get(key)
+
+    if err ~= nil then
+        local resp = req:render{json = { info = "Key doesn't exist", msg = err and err.msg }}
+        resp.status = 400
+        return resp
+    end
+
+    return req:render({json = data['value']})
+end
+
+local function handle_update(req)
+    local key = req:stash('key')
+    local status, value = pcall(function() return req:json() end)
+
+    if value == nil or type(value) == 'string' then
+        local resp = req:render{json = { info = msg }}
+        resp.status = 500
+        return resp
+    end
+
+    local data, err = router_api.update(key, value)
+    if err ~= nil then
+        local resp = req:render({json = {error = err}})
+        resp.status = 500
+        return resp
+    end
+
+    local resp = req:render({json = data})
+    resp.status = 201
+
+    return resp
+end
+
+local function handle_delete(req)
+    local key = req:stash('key')
+
+    local data, err = router_api.delete(key)
+
+    if err ~= nil then
+        local resp = req:render{json = { info = "Key doesn't exist", msg = err and err.msg }}
+        resp.status = 400
+        return resp
+    end
+
+    local resp = req:render{json = { info = "Successfully deleted" }}
+    resp.status = 200
+    return resp
+end
+
+local function init(opts) -- luacheck: no unused args
+    local httpd = cartridge.service_get('httpd')
+    if httpd ~= nil then
+        httpd:route({ path = '/kv/', method = 'POST', public = true }, handle_create)
+        httpd:route({ path = '/kv/:key', method = 'GET', public = true }, handle_get)
+        httpd:route({ path = '/kv/:key', method = 'DELETE', public = true }, handle_delete)
+        httpd:route({ path = '/kv/:key', method = 'PUT  ', public = true }, handle_update)
+    end
+
+    rawset(_G, 'app', {router = {api = router_api}})
+    for name, _ in pairs(router_api) do
+        box.schema.func.create('app.router.api.' .. name, { setuid = true, if_not_exists = true })
+        box.schema.user.grant('admin', 'execute', 'function', 'app.router.api.' .. name, { if_not_exists = true })
+    end
+
+    return true
+end
+
+local function stop()
+    return true
+end
+
+local function validate_config(conf_new, conf_old) -- luacheck: no unused args
+    return true
+end
+
+local function apply_config(conf, opts) -- luacheck: no unused args
+    -- if opts.is_master then
+    -- end
+
+    return true
+end
+
+return {
+    role_name = 'app.roles.router',
+    init = init,
+    stop = stop,
+    validate_config = validate_config,
+    apply_config = apply_config,
+    dependencies = {'cartridge.roles.vshard-router'},
+}

examples/kv/app/admin.lua

@@ -0,0 +1,53 @@
+local cartridge = require('cartridge')
+local storage_api = require('app.storage.api')
+
+local function init(opts) -- luacheck: no unused args
+    if opts.is_master then
+        local kv_store = box.schema.space.create(
+            'kv_store',
+            { if_not_exists = true }
+        )
+
+        kv_store:format({
+            { name = 'key',   type = 'string' },
+            { name = 'value', type = '*' },
+        })
+
+        kv_store:create_index('primary',
+            { type = 'hash', parts = {1, 'string'}, if_not_exists = true }
+        )
+
+    end
+
+    rawset(_G, 'app', {storage = {api = storage_api}})
+    for name, func in pairs(storage_api) do
+        box.schema.func.create('app.storage.api.' .. name, { setuid = true, if_not_exists = true })
+        box.schema.user.grant('admin', 'execute', 'function', 'app.storage.api.' .. name, { if_not_exists = true })
+    end
+
+    return true
+end
+
+local function stop()
+    return true
+end
+
+local function validate_config(conf_new, conf_old) -- luacheck: no unused args
+    return true
+end
+
+local function apply_config(conf, opts) -- luacheck: no unused args
+    -- if opts.is_master then
+    -- end
+
+    return true
+end
+
+return {
+    role_name = 'app.roles.storage',
+    init = init,
+    stop = stop,
+    validate_config = validate_config,
+    apply_config = apply_config,
+    dependencies = {'cartridge.roles.vshard-storage'},
+}

examples/kv/app/roles/router.lua

@@ -0,0 +1,32 @@
+local vshard = require('vshard')
+
+local function create(key, value)
+    local bucket_id = vshard.router.bucket_id(key)
+    local data, err = vshard.router.callrw(bucket_id, 'app.storage.api.insert', { key, value })
+    return data, err
+end
+
+local function get(key)
+    local bucket_id = vshard.router.bucket_id(key)
+    local data, err = vshard.router.callro(bucket_id, 'app.storage.api.get', { key })
+    return data, err
+end
+
+local function update(key, value)
+    local bucket_id = vshard.router.bucket_id(key)
+    local data, err = vshard.router.callro(bucket_id, 'app.storage.api.update', { key, value })
+    return data, err
+end
+
+local function delete(key)
+    local bucket_id = vshard.router.bucket_id(key)
+    local data, err = vshard.router.callrw(bucket_id, 'app.storage.api.delete', { key })
+    return data, err
+end
+
+return {
+    create = create,
+    get = get,
+    update = update,
+    delete = delete,
+}