update scripts to use env variable, add sync gateway support

Author: ldoguin

src/couchbase-server/devcontainer-feature.json

@@ -3,6 +3,7 @@
     "id": "couchbase-server",
     "version": "1.0.0",
     "description": "Installs Couchbase Server along with needed dependencies.",
+    "documentationURL": "https://github.com/couchbase-starter-kit/devcontainer-features/tree/main/src/couchbase-server",
     "options": {
         "cbversion": {
             "type": "string",
@@ -22,7 +23,7 @@
         }
     ],
     "containerEnv": {
-        "PATH": "${PATH}:/opt/couchbase/bin:/opt/couchbase/bin/tools:/opt/couchbase/bin/install",
+        "PATH": "/opt/couchbase/bin:/opt/couchbase/bin/tools:/opt/couchbase/bin/install:${PATH}",
         "COUCHBASE_CONNECTION_STRING": "couchbase://localhost",
         "COUCHBASE_USERNAME": "Administrator",
         "COUCHBASE_PASSWORD": "password",

src/couchbase-server/install.sh

@@ -87,7 +87,6 @@ setup_couchbase() {
     cp $BASE_DIR/entrypoint.sh /entrypoint.sh
 
     # Add couchbase-shell config
-    cp $BASE_DIR/cbshconfig /opt/couchbase/cbshconfig
     cp $BASE_DIR/installCbshConfig.sh /opt/couchbase/installCbshConfig.sh
 }
 

src/couchbase-server/scripts/cbshconfig

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 # Log all subsequent commands to logfile. FD 3 is now the console
 # for things we want to show up in "docker logs".
@@ -9,7 +9,7 @@ CONFIG_DONE_FILE=/opt/couchbase/var/lib/couchbase/container-configured
 config_done() {
   touch ${CONFIG_DONE_FILE}
   echo "Couchbase Admin UI: http://localhost:8091" \
-     "\nLogin credentials: Administrator / password" | tee /dev/fd/3
+     "\nLogin credentials: $COUCHBASE_USERNAME / $COUCHBASE_PASSWORD" | tee /dev/fd/3
   echo "Stopping config-couchbase service"
   sv stop /etc/service/config-couchbase
 }
@@ -39,6 +39,19 @@ wait_for_uri() {
   echo "$uri ready, continuing"
 }
 
+wait_for_response() {
+  echo "Waiting for $expected response to be available..."
+  while true; do
+    status=$(curl http://127.0.0.1:8091/pools/default/buckets/$COUCHBASE_DEFAULT_BUCKET/scopes -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD | jq -c $*)
+    if [ "$status" = "null" ]; then
+      break
+    fi
+    echo "$expected reponse not up yet, waiting 2 seconds..."
+    sleep 2
+  done
+  echo "$expected reponse ready, continuing"
+}
+
 panic() {
   cat <<EOF 1>&3
 
@@ -50,6 +63,7 @@ EOF
   cat $LOGFILE 1>&3
   echo 1>&3
   kill -HUP 1
+  sv stop /etc/service/config-couchbase &
   exit
 }
 
@@ -82,36 +96,62 @@ curl_check http://127.0.0.1:8091/node/controller/setupServices -d services=kv%2C
 echo
 
 echo "Setting up credentials with curl:"
-curl_check http://127.0.0.1:8091/settings/web -d port=8091 -d username=Administrator -d password=password
+curl_check http://127.0.0.1:8091/settings/web -d port=8091 -d username=$COUCHBASE_USERNAME -d $COUCHBASE_PASSWORD=$COUCHBASE_PASSWORD
 echo
 
 echo "Enabling memory-optimized indexes with curl:"
-curl_check -u Administrator:password -X POST http://127.0.0.1:8091/settings/indexes -d 'storageMode=memory_optimized'
+curl_check -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD -X POST http://127.0.0.1:8091/settings/indexes -d 'storageMode=memory_optimized'
 echo
 
 echo "Loading travel-sample with curl:"
-curl_check -u Administrator:password -X POST http://127.0.0.1:8091/sampleBuckets/install -d '["travel-sample"]'
+curl_check -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD -X POST http://127.0.0.1:8091/sampleBuckets/install -d '["travel-sample"]'
 echo
 
-wait_for_uri 200 http://127.0.0.1:8091/pools/default/buckets/travel-sample -u Administrator:password
+wait_for_uri 200 http://127.0.0.1:8091/pools/default/buckets/travel-sample -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD
 
 echo "Creating hotels FTS index with curl:"
-curl_check -u Administrator:password -X PUT http://127.0.0.1:8094/api/index/hotels -H Content-Type:application/json -d @/opt/couchbase/create-index.json
+curl_check -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD -X PUT http://127.0.0.1:8094/api/index/hotels -H Content-Type:application/json -d @/opt/couchbase/create-index.json
 rm /opt/couchbase/create-index.json
 echo
 
 echo "Creating RBAC 'admin' user on travel-sample bucket"
 couchbase_cli_check user-manage --set \
-  --rbac-username admin --rbac-password password \
+  --rbac-username admin --rbac-password $COUCHBASE_PASSWORD \
   --roles 'bucket_full_access[travel-sample]' --auth-domain local \
-  -c 127.0.0.1 -u Administrator -p password
+  -c 127.0.0.1 -u $COUCHBASE_USERNAME -p $COUCHBASE_PASSWORD
 echo
 
-# Configure Couchbase Shell
-ls /home | xargs -i  mkdir  /home/{}/.cbsh
-ls /home | xargs -i  cp opt/couchbase/cbshconfig /home/{}/.cbsh/config
-mkdir /root/.cbsh
-cp /opt/couchbase/cbshconfig /root/.cbsh/config
+
+if [ -z "${COUCHBASE_DEFAULT_BUCKET}" ]; then
+  echo "COUCHBASE_DEFAULT_BUCKET not defined, skip Bucket creation" | tee /dev/fd/3
+else
+  echo "COUCHBASE_DEFAULT_BUCKET found, creating bucket $COUCHBASE_DEFAULT_BUCKET" | tee /dev/fd/3
+  curl_check -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD -X POST http://127.0.0.1:8091/pools/default/buckets/ -d name=$COUCHBASE_DEFAULT_BUCKET -d bucketType=couchbase  -d ramQuota=256
+  wait_for_uri 200 http://127.0.0.1:8091/pools/default/buckets/$COUCHBASE_DEFAULT_BUCKET -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD
+  if [ -z "${COUCHBASE_DEFAULT_SCOPE}" ]; then
+    echo "COUCHBASE_DEFAULT_SCOPE not defined, skip Scope creation" | tee /dev/fd/3
+  else
+    echo "COUCHBASE_DEFAULT_SCOPE found, creating scope $COUCHBASE_DEFAULT_SCOPE." | tee /dev/fd/3
+    if [ ${COUCHBASE_DEFAULT_SCOPE:0:1} == "_" ] || [ ${COUCHBASE_DEFAULT_SCOPE:0:1} == "%" ]; then 
+      echo "Skip because name starts with _ or %"| tee /dev/fd/3
+    else 
+      curl_check -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD -X POST http://127.0.0.1:8091/pools/default/buckets/$COUCHBASE_DEFAULT_BUCKET/scopes -d name=$COUCHBASE_DEFAULT_SCOPE
+      wait_for_response ".scopes | map(select(.name ==\"$COUCHBASE_DEFAULT_SCOPE\"))[0]"
+    fi
+    if [ -z "${COUCHBASE_DEFAULT_COLLECTION}" ]; then
+      echo "COUCHBASE_DEFAULT_COLLECTION not defined, skip Collection creation" | tee /dev/fd/3
+    else
+      echo "COUCHBASE_DEFAULT_COLLECTION found, creating scope $COUCHBASE_DEFAULT_COLLECTION." | tee /dev/fd/3
+    if [ ${COUCHBASE_DEFAULT_COLLECTION:0:1} == "_" ] || [ ${COUCHBASE_DEFAULT_COLLECTION:0:1} == "%" ]; then 
+        echo "Skip because name starts with _ or %"| tee /dev/fd/3
+      else 
+        curl_check -u $COUCHBASE_USERNAME:$COUCHBASE_PASSWORD -X POST http://127.0.0.1:8091/pools/default/buckets/$COUCHBASE_DEFAULT_BUCKET/scopes/$COUCHBASE_DEFAULT_SCOPE -d name=$COUCHBASE_DEFAULT_COLLECTION
+        wait_for_response ".scopes | map(select(.name ==\"$COUCHBASE_DEFAULT_SCOPE\"))[0].collections | map(select(.name == \"$COUCHBASE_DEFAULT_COLLECTION\"))[0]"
+      fi
+    fi
+  fi
+fi
+
 
 echo "Configuration completed!" | tee /dev/fd/3
 

src/couchbase-server/scripts/configure-node.sh

@@ -1,4 +1,27 @@
-#!/bin/sh
+#!/bin/bash
+
+cat << EOF > /opt/couchbase/cbshconfig
+
+version = 1
+
+[[cluster]]
+identifier = "local"
+connstr = "$COUCHBASE_CONNECTION_STRING"
+default-bucket = "$COUCHBASE_DEFAULT_BUCKET"
+default-scope = "$COUCHBASE_DEFAULT_SCOPE"
+default-collection = "$COUCHBASE_DEFAULT_COLLECTION"
+username = "$COUCHBASE_USERNAME"
+password = "$COUCHBASE_PASSWORD"
+data-timeout = "5s"
+connect-timeout = "1m 15s"
+search-timeout = "1m 15s"
+analytics-timeout = "1m 15s"
+management-timeout = "1m 15s"
+tls-enabled = false
+tls-accept-all-certs = false
+
+EOF
+
 
 # Configure Couchbase Shell for Root and any found users
 ls /home | xargs -i  mkdir  /home/{}/.cbsh

src/couchbase-server/scripts/installCbshConfig.sh

@@ -0,0 +1,12 @@
+
+# Couchbase Sync Gateway (couchbase-sg)
+
+Install Couchbase Sync Gateway
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/couchbase-starter-kit/devcontainer-features/couchbase-sg:1": {}
+}
+```

src/couchbase-sg/README.md

@@ -0,0 +1,24 @@
+{
+    "name": "Couchbase Sync Gateway",
+    "id": "couchbase-sg",
+    "version": "1.0.0",
+    "description": "Installs Couchbase Sync Gateway along with needed dependencies.",
+    "documentationURL": "https://github.com/couchbase-starter-kit/devcontainer-features/tree/main/src/couchbase-sg",
+    "options": {
+        "sgversion": {
+            "type": "string",
+            "proposals": [
+                "3.2.0"
+            ],
+            "default": "3.2.0",
+            "description": "Select or enter a version of Couchbase Sync Gateway"
+        }
+    },
+    "containerEnv": {
+        "PATH": "/opt/couchbase-sync-gateway/bin:${PATH}"
+    },
+    "privileged": true,
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/common-utils"
+    ]
+}

src/couchbase-sg/devcontainer-feature.json

@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+# Default: Exit on any failure.
+set -e
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+# Setup STDERR.
+err() {
+    echo "(!) $*" >&2
+}
+
+if [ "$(id -u)" -ne 0 ]; then
+    err 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+    exit 1
+fi
+
+# Determine the appropriate non-root user
+if [ "${USERNAME}" = "auto" ] || [ "${USERNAME}" = "automatic" ]; then
+    USERNAME=""
+    POSSIBLE_USERS=("vscode" "node" "codespace" "$(awk -v val=1000 -F ":" '$3==val{print $1}' /etc/passwd)")
+    for CURRENT_USER in "${POSSIBLE_USERS[@]}"; do
+        if id -u ${CURRENT_USER} > /dev/null 2>&1; then
+            USERNAME=${CURRENT_USER}
+            break
+        fi
+    done
+    if [ "${USERNAME}" = "" ]; then
+        USERNAME=root
+    fi
+elif [ "${USERNAME}" = "none" ] || ! id -u ${USERNAME} > /dev/null 2>&1; then
+    USERNAME=root
+fi
+
+apt_get_update()
+{
+    if [ "$(find /var/lib/apt/lists/* | wc -l)" = "0" ]; then
+        echo "Running apt-get update..."
+        apt-get update -y
+    fi
+}
+
+# Checks if packages are installed and installs them if not
+check_packages() {
+    if ! dpkg -s "$@" > /dev/null 2>&1; then
+        apt_get_update
+        apt-get -y install --no-install-recommends "$@"
+    fi
+}
+
+setup_sg() {
+    mkdir /opt/couchbase-sync-gateway/data
+    mkdir -p /etc/service/couchbase-sg/supervise
+    cp $BASE_DIR/scripts/run /etc/service/couchbase-sg/run
+    chown -R couchbase:couchbase /etc/service /etc/service/couchbase-sg/supervise
+    mkdir /etc/sync_gateway
+    cp $BASE_DIR/scripts/config.json /etc/sync_gateway/config.json
+    chown -R sync_gateway:sync_gateway /etc/sync_gateway
+    mkdir -p /var/log/sync_gateway
+    chown sync_gateway:sync_gateway /var/log/sync_gateway
+}
+
+install_sg() {
+    # Install dependencies
+    check_packages curl lsb-release systemctl wget
+    SG_VERSION=${SGVERSION:-"3.2.0"}
+    SGW_PACKAGE="http://packages.couchbase.com/releases/couchbase-sync-gateway/${SG_VERSION}/couchbase-sync-gateway-enterprise_${SG_VERSION}_@@ARCH@@.deb"
+    
+    SGW_PACKAGE=$(echo "${SGW_PACKAGE}" | sed -e "s/@@ARCH@@/$(uname -m)/") 
+    SGW_PACKAGE_FILENAME=$(echo "couchbase-sync-gateway-enterprise_${SG_VERSION}_@@ARCH@@.deb" | sed -e "s/@@ARCH@@/$(uname -m)/") 
+    wget "${SGW_PACKAGE}" 
+    apt install -y ./"${SGW_PACKAGE_FILENAME}" 
+    rm "${SGW_PACKAGE_FILENAME}" 
+    apt autoremove 
+    apt clean
+}
+
+export DEBIAN_FRONTEND=noninteractive
+
+export BASE_DIR=$PWD
+CLEANUP_COMMAND="rm -rf /var/lib/apt/lists/*  /var/tmp/*" # /tmp/*
+
+
+install_sg
+setup_sg
+
+# Clean up
+rm -f ./$SGW_PACKAGE 
+${CLEANUP_COMMAND} 
+
+echo "Done!"

src/couchbase-sg/install.sh

@@ -0,0 +1,39 @@
+{
+    "bootstrap": {
+      "server": "${COUCHBASE_CONNECTION_STRING}", 
+      "username": "${COUCHBASE_USERNAME}", 
+      "password": "${COUCHBASE_PASSWORD}",
+      "server_tls_skip_verify": true, 
+      "use_tls_server": false 
+    },
+	"logging": {
+	  "log_file_path": "/var/tmp/sglogs",
+    "redaction_level": "partial",
+	  "console": {
+      "log_level": "error",
+      "log_keys": ["*"]
+	  },
+	  "error": {
+      "enabled": true,
+      "rotation": {
+        "max_size": 20,
+        "max_age": 180
+      }
+	  },
+	  "warn": {
+      "enabled": true,
+      "rotation": {
+        "max_size": 20,
+        "max_age": 90
+      }
+	  },
+	  "info": {
+	  	"enabled": false
+	  },
+	  "debug": {
+		  "enabled": false
+	  }
+	}
+}
+
+