Getting started with Ruby SDK

This section describes how to set up and install the Ruby SDK and how to deploy a feature flag.

Step 1 - Setting up

The following are prerequisites for installing the Ruby SDK:

  1. Create a CloudBees Rollout account. See Signup Page to create an account.

  2. Create an application in the CloudBees Rollout dashboard.

    • The first time you log into your account, click the Create New App button to create a new app.

      Create New App button

  3. Get your environment key.

    • Get the key from App Settings > Environment > Key.

Step 2 - Installing the Ruby SDK

Add the CloudBees Rollout Ruby library to your application by running the following commands:

# Add the SDK to your application
$ gem install rox-rollout

Add the following lines of code to your application:

# Import SDK
require 'rox/server/rox_server'

# Create Roxflags in the Flags container class
class Flags
  attr_accessor :enableTutorial, :titleColors
  def initialize
    # Define the feature flags
    @enableTutorial = Rox::Server::RoxFlag.new(false)
    @titleColors = Rox::Server::RoxVariant.new('red', ['red', 'blue', 'green'])
  end
end

flags = Flags.new

# Register the flags container
Rox::Server::RoxServer.register('', flags)

# Setup the environment key
Rox::Server::RoxServer.setup("<ROLLOUT-ENV-KEY>").join

# Boolean flag example
puts "enableTutorial is #{flags.enableTutorial.enabled? ? "enabled" : "disabled"}"

# Multivariate flag example
puts "titleColors is #{flags.titleColors.value}"

Container class registration and environment key setup

  • You cannot call Rox.setup() twice in the same runtime.

Run your application

Running the application

The flag name is automatically added to the CloudBees Rollout dashboard after running the application.

Step 3 - Deploying a feature flag

Finding your flags in the CloudBees Rollout dashboard

After creating feature flags and running your feature code, you can find your flags in the CloudBees Rollout dashboard.

To find your flags in the dashboard:

  1. Find your application in the CloudBees Rollout dashboard. To switch between apps, click on the app name in the top-left corner of the screen and select the app you want from the pulldown.

  2. Click on Flags on the left side of the navigation panel.

  3. Confirm that your flag is listed in the flag view.

Configuring deployment rules

  1. Go to the CloudBees Rollout dashboard.

  2. Click on Experiments on the left panel.

  3. Click the Create Experiment button to create a new experiment.

  4. In the New Experiment window:

    • Find the Flag name from the menu, choose it.

    • Click the Set Audience button to continue. The Experiment Details view appears.

  5. Select either True, False, Split or Scheduled. Split allows you to select the percentage of the target group that you want to deploy. Scheduled allows you to schedule a deployment date.

    Audience

  6. Click Update Audience.

  • You cannot delete the default condition.

  • You can click the Reset link to go back to the state from before you started making changes. Reset only appears when you’ve made saved modifications.

See Audience for more detailed information.