Search:

Manual

Membase Manual 1.7

Additional Resources

Community Forums

Chapters

1 Introduction to Membase

2 Membase Key Concepts

3 Getting Started with Membase Server

4 Membase Administration

5 Membase Architecture

6 Developing with Membase

7 Developing Membase Clients

B Release Notes

Membase Manual 1.7
		Next

Membase Manual 1.7

Copyright © 2010-2013 Couchbase, Inc. Contact copyright@couchbase.com.

For documentation license information, see Documentation License. For all license information, see Licenses.

Abstract

This manual documents the Membase Server 1.7.x series, including installation, administration, and associated tools.

Last document update: 20 May 2013 22:19; Document built: 20 May 2013 22:19.

Documentation Availability and Formats. This documentation is available for download: HTML Zip, PDF, EPUB . For other documentation from Couchbase, see Couchbase Documentation Library

Contact: editors@couchbase.com or couchbase.com

Table of Contents

1. New Features in Membase Server 1.7

1. Clustering
1. Improved Monitoring and Statistics
1. Replication and Rebalancing
1. Management and Software Upgrades
1. Client Interface
1.1. New Features in Membase Server 1.7.1

1. Introduction to Membase

1. Memcached Compatibility
1. Guiding design principles: Simple, Fast, Elastic
1. Simple
1. Fast
1. Elastic
1.1. What is a NoSQL database?

2. Membase Key Concepts

2. Dynamic Scalability

2. Membase Cluster Manager

2.1. Administration

2.2. Memory Quotas

2.2. Managing Disk and Memory for Nodes in the Cluster
2.2. Server Quotas
2.2. Bucket Quotas

2.3. Membase Data Buckets

2.4. Capabilities of Membase-type Data Buckets

2.5. Multitenancy with Membase

3. Getting Started with Membase Server

3.1. Preparation

3.1. Supported Platforms
3.1. Hardware Requirements
3.1. Storage Requirements
3.1. Web Browser (for administration)
3.1. Network Ports

3.2. Installing Membase Server

3.2.1. Red Hat Linux Installation
3.2.2. Ubuntu Linux Installation
3.2.3. Microsoft Windows Installation
3.2.4. Mac OS X Installation

3.3. Upgrading to Membase 1.7

3.3.1. Upgrading to Membase Server 1.7.x

3.4. Setting up Membase Server

3.5. Testing Membase Server

3.6. Next Steps

4. Membase Administration

4.1. Membase Administration Web Console

4.1.1. Cluster Overview
4.1.2. Web Console Statistics
4.1.3. Manage Data Buckets
4.1.4. Server Nodes
4.1.5. Membase Server States
4.1.6. Settings
4.1.7. Log
4.1.8. Update Notifications
4.1.9. Warnings and Alerts

4.2. Membase Command-line Interface

4.2.1. membase Tool
4.2.2. mbstats Tool
4.2.3. mbflushctl Tool
4.2.4. tap.py Tool
4.2.5. mbvbucketctl Tool
4.2.6. mbvbuckettool Tool
4.2.7. mbdbmaint Tool
4.2.8. mbcollect_info Tool

4.3. Membase Management REST API

4.3. JSON Responses
4.3. HTTP Basic Access Authentication
4.3. Versatile Server Nodes
4.3.1. Key Concepts

4.4. Monitoring Membase

4.4.1. Membase Statistics

4.5. Membase Best Practices

4.5. Cluster Design Considerations
4.5.1. Sizing Guidelines
4.5.2. Ongoing Monitoring and Maintenance
4.5.3. Adding and Removing Nodes
4.5.4. Membase Behind a 2nd Firewall
4.5.5. Using Membase in the Cloud

4.6. Membase for Memcached Users

4.7. Backup and Restore with Membase

4.7.1. Backup
4.7.2. Restore in 1.7.0
4.7.3. Restore in 1.7.1 and higher

4.8. Troubleshooting

4.8. General Tips
4.8.1. Responding to Specific Errors
4.8.2. Log File Entries
4.8.3. Linux Logs
4.8.4. Windows Logs
4.8.5. Common Errors

4.9. Deployment Strategies

4.9. Using Membase Embedded Proxy
4.9. Standalone Proxy
4.9. Using s vBucket aware Client

4.10. Uninstalling Membase

4.10. Uninstalling Membase Uninstalling on a RedHat Linux System
4.10. Uninstalling on an Ubuntu Linux System
4.10. Uninstalling on a Windows System

5. Membase Architecture

5. Cluster Design

5. Persistence Design

5. Component Overview

5.1. Growing Data Sets Beyond Memory

5.1. Design
5.1. Consequences of Memory faster than Disk
5.1.1. DGM Implementation Details

5.2. Membase APIs

5.2.1. memcached protocol

5.3. Additional Protocol Operations

5.3. TAP Protocol
5.3. Other Extensions
5.3.1. getl extended operations

5.4. vBuckets

5.4. Membase Key-vBucket-Server Mapping Illustrated
5.4. vBuckets in a world of OTC memcached clients
5.4. Deployment Option 1 - Using Membase Embedded Proxy
5.4. Deployment Option 2 - Standalone Proxy
5.4. Deployment Option 3 - "vBucket aware" client

5.5. Failover with Membase

5.5. When and how should I use failover?
5.5.1. Automatic Failover
5.5.2. Automated failover considerations
5.5.3. Monitored failover

5.6. Membase Buckets

6. Developing with Membase

6.1. Use Cases

6.1. Session store
6.1. Social gaming
6.1. Ad, offer and content targeting
6.1. Real-time logging and alerting

6.2. Best practices

6.2.1. What should I store in an object
6.2.2. Objects that refer to other objects
6.2.3. Locking
6.2.4. Data partitioning with buckets

7. Developing Membase Clients

7.1. REST/JSON

7.1.1. Parsing the JSON
7.1.2. Encoding the vbucketId into each request
7.1.3. Client Libraries and Rebalancing
7.1.4. Fast Forward Map
7.1.5. Redundancy & Availability

7.2. libvbucket libjvbucket SASL Authentication Example

7.2. List Mechanisms
7.2. Authentication request

B. Release Notes

B.1. Release Notes for Membase Server 1.7.2 GA (28 October 2011)
B.2. Release Notes for Membase Server 1.7.1.1 GA (06 June 2011)
B.3. Release Notes for Membase Server 1.7.1 GA (06 June 2011)
B.4. Release Notes for Membase Server 1.7.0 GA (06 June 2011)

C. Licenses

C.1. Documentation License
C.2. Couchbase, Inc. Community Edition License Agreement
C.3. Couchbase, Inc. Enterprise License Agreement: Free Edition

List of Figures

2.1. Membase Cluster: Dynamic Scalability
2.2. Multitenancy
3.1. Windows Installation Welcome Screen
3.2. Windows Installation Location Screen
3.3. Windows Installation Ready Screen
3.4. Windows Installation Progress Screen
3.5. Windows Installation Completion Screen
3.6. Membase Server on Mac OS X Menubar Item
3.7. Membase Server on Mac OS X Update Notification
3.8. Membase Server Setup
3.9. Membase Server Setup Step 1 (New Cluster)
3.10. Membase Server Setup Step 1 (Existing Cluster)
3.11. Membase Server Setup Step 2
3.12. Membase Server Setup Step 3
3.13. Membase Server Setup Step 4
3.14. Membase Server Setup Completed
4.1. Membase Web Console - Cluster Overview
4.2. Membase Web Console - Data Buckets Overview
4.3. Membase Web Console - Create Bucket
4.4. Membase Web Console - Bucket Information
4.5. Membase Web Console - Summary Statistics
4.6. Membase Web Console - vBucket Resources statistics
4.7. Membase Web Console - Disk Queue Statistics
4.8. Membase Web Console - TAP Queue Statistics
4.9. Membase Web Console - Memcached Statistics
4.10. Membase Web Console - Server Nodes
4.11. Membase Web Console- Data Bucket/Server view
4.12. Membase Web Console - Server specific view
4.13. Down Status
4.14. Pend Status
4.15. Web Console Log Viewer
4.16. Available Update Notifications
4.17. Available Update Notifications
4.18. Warning Notification
4.19. REPLACE
4.20. Deployment Strategy: Using the Embedded Proxy
4.21. Deployment Strategy: Standalone Proxy
4.22. Deployment Strategy: Using a vBucket Aware Client
5.1. Bucket Configuration
5.2. Background Fetch Workflow
5.3. Membase Buckets

List of Tables

2.1. Bucket Types
2.2. Membase Bucket Capabilities
3.1. Network Ports used by Membase Server
4.1. Membase Command-line Tools
4.2. membase Tool Commands
4.3. Standard membase Options
4.4. Supported Request Headers
4.5. HTTP Status Codes
4.6. Controller Functions
4.7. Node Attributes
4.8. Cluster Joining Arguments
4.9. Additional Arguments
4.10. Stats
4.11. Input Variables
4.12. Constants
4.13. Variables
4.14. Input Variables
4.15. Constants
4.16. Variable Calculations
4.17. Responses to Specific Errors

		Next
		Preface

Copyright (c) 2010-2013Couchbase, Inc.