Deploio Guides

Appearance

Create a Key Value Store for your Ruby on Rails application ​

INFO

Are you using Sidekiq? Or ActionCable with Redis? Deploio offers a managed Redis-compatible key-value store. This guide describes how you can set it up. You can see the different tiers and pricing here.

Create the Key Value Store ​

TIP

Before you create resources, ensure that the project you want to create the resources in is selected by running nctl auth set-project {project_name}.

Create the key value store with the create kvs command:

bash
nctl create kvs {KVS_NAME}

This creates a key-value store owned by the currently active project. The key-value store supports the Redis 7 API.

INFO

Due to license changes and the associated uncertainty about the future development of Redis, Deploio will switch away from Redis to a compatible alternative as a replacement soon.

Set the Environment Variable ​

Retrieve the connection details for your store:

bash
$ nctl get kvs {KVS_NAME}
PROJECT       NAME         FQDN                                              TLS     MEMORY SIZE
my-project    {KVS_NAME}   {KVS_NAME}.keyvaluestore.nineapis.ch      true    1Gi

$ nctl get kvs {KVS_NAME} --print-token
...password...

Set the REDIS_URL environment variable on your application. Note the rediss:// protocol (double s) — TLS is enabled on all KVS instances:

bash
nctl update app {APP_NAME} \
  --env="REDIS_URL=rediss://:{PASSWORD}@{PUBLIC FQDN};REDISCLI_AUTH={PASSWORD}"

Configure Rails ​

Add the redis gem to your Gemfile if it's not already present:

ruby
gem "redis"

Deploio KVS instances use self-signed TLS certificates. You need to disable certificate verification in every Redis connection by passing ssl_params.

Sidekiq ​

If you're using Sidekiq, configure it to use REDIS_URL. Create or update config/initializers/sidekiq.rb:

ruby
Sidekiq.configure_server do |config|
  config.redis = { url: ENV["REDIS_URL"], ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE } }
end

Sidekiq.configure_client do |config|
  config.redis = { url: ENV["REDIS_URL"], ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE } }
end

Then add a worker for Sidekiq as described in the Background Jobs guide:

bash
nctl update app {APP_NAME} \
  --worker-job-command="bundle exec sidekiq -C config/sidekiq.yml" \
  --worker-job-name "sidekiq" \
  --worker-job-size micro

ActionCable ​

To use ActionCable with Redis, update config/cable.yml:

yaml
production:
  adapter: redis
  url: <%= ENV["REDIS_URL"] %>
  ssl_params:
    verify_mode: <%= OpenSSL::SSL::VERIFY_NONE %>

Cache Store ​

To use Redis as the Rails cache store, add the following to config/environments/production.rb:

ruby
config.cache_store = :redis_cache_store, { url: ENV["REDIS_URL"], ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE } }

Verify the Connection ​

You can verify that your application can reach the key-value store by running a quick check via nctl exec:

bash
nctl exec app {APP_NAME} -- bundle exec rails runner \
  "r = Redis.new(url: ENV['REDIS_URL'], ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE }); r.set('ping', 'pong'); puts r.get('ping')"

If the connection is working, this prints pong.

You can read more about KVS configuration in the technical reference.

Next Steps ​

Do you need object storage for your application? Proceed to the next step.