Provisioning Cluster Resources

    +
    Provisioning cluster resources is managed at the collection or bucket level, depending upon the service affected. Common use cases are outlined here, more recherché use cases are covered in the API docs.

    The primary means for managing clusters is through the Couchbase Web UI which provides an easy to use interface for adding, removing, monitoring and modifying buckets. In some instances you may wish to have a programmatic interface. For example, if you wish to manage a cluster from a setup script, or if you are setting up buckets in test scaffolding.

    The Ruby SDK also comes with some convenience functionality for common Couchbase management requests.

    Management operations in the SDK may be performed through several interfaces depending on the object:

    • BucketManager — Couchbase::Management::BucketManager — see API docs.

    • UserManager — Couchbase::Management::UserManager — see API docs.

    • QueryIndexManager — Couchbase::Management::QueryIndexManager — see API docs.

    • AnalyticsIndexManager — Couchbase::Management::AnalyticsIndexManager — see API docs.

    • SearchIndexManager — Couchbase::Management::SearchIndexManager — see API docs.

    • CollectionManager — Couchbase::Management::CollectionManager — see API docs.

    • ViewIndexManager — Couchbase::Management::ViewIndexManager — see API docs.

    When using a Couchbase version earlier than 6.5, you must create a valid Bucket connection using cluster.Bucket(name) before you can use cluster level managers.

    Creating and Removing Buckets

    The BucketManager interface may be used to create and delete buckets from the Couchbase cluster. It is instantiated through the #create_bucket() method.

    Note that any property that is not explicitly set when building the BucketSettings will use the default value. In the case of the update, this is not necessarily the currently configured value, so you should be careful to set all properties to their correct expected values when updating an existing bucket configuration.

    See the API docs for a full list of settings options.

    The following example creates a new bucket, adding settings including making it flushable:

    bucket_name = "new_bucket"
    
    settings = Management::BucketSettings.new
    settings.name = bucket_name
    settings.ram_quota_mb = 100
    settings.flush_enabled = true
    measure("New bucket #{bucket_name.inspect} created") { cluster.buckets.create_bucket(settings) }

    We can retrieve information on various settings:

    settings = cluster.buckets.get_bucket(bucket_name)
    puts "Bucket #{bucket_name.inspect} settings:"
    puts " * healthy?           : #{settings.healthy?}"
    puts " * RAM quota          : #{settings.ram_quota_mb}"
    puts " * number of replicas : #{settings.num_replicas}"
    puts " * flush enabled:     : #{settings.flush_enabled}"
    puts " * max TTL            : #{settings.max_expiry}"
    puts " * compression mode   : #{settings.compression_mode}"
    puts " * replica indexes    : #{settings.replica_indexes}"
    puts " * eviction policy    : #{settings.eviction_policy}"
    
    measure("Bucket #{bucket_name.inspect} flushed") { cluster.buckets.flush_bucket(bucket_name) }

    As well as flushing the bucket.

    Flushing Buckets

    When a bucket is flushed, all content is removed. Because this operation is potentially dangerous it is disabled by default for each bucket. Bucket flushing may be useful in test environments where it becomes a simpler alternative to removing and creating a test bucket. You may enable bucket flushing on a per-bucket basis using the Couchbase Web Console or when creating a bucket.

    You can flush a bucket in the SDK by using the flush_bucket() method.

    flush_bucket(bucket_name, options = FlushBucketOptions.new)

    The flush_bucket() operation may fail if the bucket does not have flush enabled, in which case it will return an Error::BucketNotFlushable.

    Collection Management

    Developer Preview

    The CollectionManager interface may be used to create and delete scopes and collections from the Couchbase cluster. It is instantiated through the Bucket.collections() method. Refer to the CollectionManager API documentation for further details.

    options = Cluster::ClusterOptions.new
    options.authenticate("scope_admin", "password")
    cluster = Cluster.connect("couchbase://localhost", options)
    bucket = cluster.bucket("travel-sample")
    collections = bucket.collections

    Creating and Deleting Scopes and Collections

    You can create a scope:

    scopes = collections.get_all_scopes
    
    if scopes.any? { |scope| scope.name == "example-scope" }
    puts "Scope already exists"
    else
        collections.create_scope("example-scope")
    end

    You can then create a collection within that scope:

    collection = Management::CollectionSpec.new {|spec|
        spec.name = "example-collection"
        spec.scope_name = "example-scope" }
    
    collections.create_collection(collection)

    Finally, you can drop unneeded collections and scopes:

    collections.drop_collection(collection)
    
    [data-source-url=https://github.com/couchbase/docs-sdk-ruby/blob/1dd5c46791cb9d668a65a571f353536db6b25ce2/modules/howtos/examples/provisioning-resources-collections.rb#L74]
    collections.drop_scope("example-scope")

    Note that the most minimal permissions to create and drop a Scope or Collection is Manage Scopes along with Data Reader

    You can create users with the appropriate RBAC programmatically:

    user = Management::User.new {|user|
        user.username = "scope_admin"
        user.password = "password"
        user.display_name = "Manage Scopes [travel-sample:*]"
        user.roles = [
            Management::Role.new {|role|
                role.name = "scope_admin"
                role.bucket = "travel-sample"},
            Management::Role.new {|role|
                role.name = "data_reader"
                role.bucket = "travel-sample"}
        ]
    }
    users.upsert_user(user)

    Listing the Scopes and Collections available

    You can enumerate Scopes and Collections using the CollectionManager.get_all_scopes() method and the Scope.collections property.

    collections.get_all_scopes().each {|scope|
        puts "#{scope.name} :"
        scope.collections.each {|collection|
            puts "  * #{collection.name}"
        }
    }

    More examples

    There is a full example in the Ruby SDK repo on GitHub.

    Index Management

    In general,you will rarely need to work with Index Managers from the SDK. For those occasions when you do, please see the relevant API docs, linked below.

    View Management

    Views are stored in design documents. The SDK provides convenient methods to create, retrieve, and remove design documents. To set up views, you create design documents that contain one or more view definitions, and then insert the design documents into a bucket. Each view in a design document is represented by a name and a set of MapReduce functions. The mandatory map function describes how to select and transform the data from the bucket, and the optional reduce function describes how to aggregate the results.

    In the SDK, design documents are represented by the DesignDocument and View structs. All operations on design documents are performed on the ViewIndexManager instance:

    There is a full example in the Ruby SDK repo on GitHub.

    Further Reading & API Guides

    The API Guide contains info on the following Management APIs: