Cluster Setup

Cluster Setup

Only Full Administrators can set up a cluster by defining file locations and hostnames.

Cluster Setup with Couchbase Web Console

The default location of the Couchbase Web Console is http://<hostname>:8091

  1. Open the Couchbase Web Console.

    Click Setup to begin the initial configuration.

    Step 1 of 5: Configure Server

  2. Set up the disk storage and Data service.

    The Configure Disk Storage option specifies the location of the persistent storage used by the Couchbase Server Data service. The setting affects only this node and sets the directory where all the data is stored on disk. It also sets the location where the indexes created by views are stored:

    • If you are not indexing data with views, you can accept the default setting. Otherwise for the best performance we recommend specifying separate physical storage for the data and index paths.
  3. Provide a node IP or hostname under Configure Server Hostname.
  4. Choose which services to include on the first node. At a minimum, the Data service is required. In production, only one service per node should be deployed.
  5. The Configure Server Memory section sets the amount of physical RAM that will be allocated by the Couchbase Server for storage, both for the Data and the Index service. The same amount of memory is allocated to each node in the cluster that runs the particular service. Since the same setting applies to the whole cluster, specify a value that all nodes of each service type can support.

    Alternatively, if joining an existing cluster, select the radio button Join a cluster now and then provide the IP address or hostname of an existing node and administrative credentials for that existing cluster. Select the services to install on this node.

  6. Click Next.

    Step 2 of 5: Sample Buckets

    The Sample Buckets panel appears where you can select the sample data buckets you want to load.

  7. Click the names of sample buckets to load to the Couchbase Server. These data sets demonstrate Couchbase Server's features and help you understand and develop views and N1QL Queries.

    If you decide to install sample data, the installer creates one Couchbase bucket for each set of sample data you choose.

    After you create sample data buckets, the Create Default Bucket panel appears where you can create a new default data bucket.

    Step 3 of 5: Create Default Bucket (optional)

  8. At this step you can set up a default bucket for Couchbase Server. You can change most bucket settings later, a major exception is the bucket name which in this case is fixed to default. See Bucket setup for more information.

    If you wish to set up the default bucket then accept all defaults in this panel.

    Couchbase Server will create a new data bucket named default; you can use this test bucket to learn more about Couchbase Server and in test environments. It is worth noting that the default bucket is unauthenticated, which is not recommended for production purposes due to possible security risks. You can instead choose to skip the creation of the default bucket and create your own buckets at a later stage.

    To create a default bucket as part of the setup click Next, otherwise to skip this step click Skip.

    Step 4 of 5: Notifications

  9. In the Notifications screen, select Enable software update notifications.

    Couchbase Web Console communicates with Couchbase Server nodes and confirms the version numbers of each node.

    As long as you have Internet access this information will be sent anonymously to Couchbase corporate, which uses this information only to provide you with updates and information to help improve Couchbase Server and related products. When you provide an email address, it is added to the Couchbase community mailing list for news and update information about Couchbase and related products. You can unsubscribe from the mailing list at any time using the Unsubscribe link provided in each newsletter.

    Couchbase Web Console communicates the following information:
    • The current version. When a new version of Couchbase Server exists, you get information about where you can download the new version.
    • Information about the size and configuration of your Couchbase cluster to Couchbase corporate. This information helps prioritize the development efforts.
  10. Read the terms and conditions and then select I agree to the terms and conditions associated with this product and click Next.

    Step 5 of 5: Configure Server

  11. The screen Configure this Server is the last configuration step. Enter a cluster administrator's username and password. Your username can have up to 24 characters, and your password must have 6 to 24 characters. Use these credentials each time you add a new server into the cluster. These are the same credentials you use for Couchbase Server REST API.
  12. After you finish this setup, you see the Couchbase Web Console with the Cluster Overview page. Couchbase Server is now running and ready to use.

Settings Configuration with CLI or REST API

Configure other settings, such as the port and RAM, using CLI or REST API.

Command-line tools
The command-line tools included with your Couchbase Server installation includes couchbase-cli tool, which allows access to the core functionality of the Couchbase Server by providing a wrapper to the REST API.
REST API
Couchbase Server can be configured and controlled using REST, on which both the command-line tools and Web interface to Couchbase Server are based.