New to KubeDB? Please start here.

Branch Elasticsearch into Another Namespace

Same-cluster branching creates an independent Elasticsearch deployment from a point-in-time snapshot within the same Kubernetes cluster. Place the branch in another namespace to prepare development, testing, or data analysis environments using existing data.

The branch accepts independent reads and writes without changing the source. Source changes are not continuously replicated; scheduled refreshes can replace branch data with fresh source snapshots.

Before You Begin

  • Read the branching overview.
  • Complete Courier setup, including KubeDB and the Branch CRD. Use branching-capable Courier, provisioner, and database images.
  • Ensure ElasticsearchVersion xpack-8.18.8 is available in your installed catalog.
  • Use Ceph RBD storage with copy-on-write cloning, compatible VolumeSnapshot and VolumeGroupSnapshot classes, and the corresponding CSI APIs, controllers, and driver support.
  • Review the snapshot requirements. Your account must be able to create databases and Branches, read auth Secrets, inspect snapshots and Jobs, and open pod shells.
  • Allow capacity for three source and three target database pods, each requesting 2Gi of memory, plus operators and action Jobs.

The source uses demo; the target uses dev. Replace ceph-rbd consistently if your Ceph StorageClass has another name. Reserve the tutorial names and create namespaces if they do not already exist:

kubectl create namespace demo
kubectl create namespace dev

Deploy the source database

Save the following as elasticsearch-source.yaml. It creates a three-node combined cluster:

apiVersion: kubedb.com/v1
kind: Elasticsearch
metadata:
  name: elasticsearch-source
  namespace: demo
spec:
  version: xpack-8.18.8
  replicas: 3
  enableSSL: false
  podTemplate:
    spec:
      containers:
      - name: elasticsearch
        resources:
          requests:
            cpu: 500m
            memory: 2Gi
          limits:
            memory: 2Gi
  storageType: Durable
  storage:
    storageClassName: ceph-rbd
    accessModes:
    - ReadWriteOnce
    resources:
      requests:
        storage: 2Gi
  deletionPolicy: WipeOut
kubectl -n demo apply -f elasticsearch-source.yaml
kubectl -n demo wait elasticsearch/elasticsearch-source --for=jsonpath='{.status.phase}'=Ready --timeout=30m

HTTP authentication remains enabled. enableSSL: false uses HTTP for the client API; Elasticsearch transport traffic has its own encryption configuration.

Seed and inspect the source data

Discover the auth Secret referenced by elasticsearch-source:

kubectl -n demo get elasticsearch elasticsearch-source -o jsonpath='{.spec.authSecret.name}{"\n"}'
elasticsearch-source-auth

Use the returned name below if it differs. Read its password:

kubectl -n demo get secret elasticsearch-source-auth -o jsonpath='{.data.password}' | base64 -d

Enter this password when the client prompts.

From your terminal, open a pod shell:

kubectl -n demo exec -it elasticsearch-source-0 -c elasticsearch -- bash

Run the following curl commands inside the pod shell. --user elastic prompts for the decoded password on each request. Requests use the database Service.

Create five customers. Expected results below omit connection banners and are formatted for readability.

curl --silent --show-error --fail-with-body --user elastic \
  -X PUT "http://elasticsearch-source.demo.svc:9200/customers" \
  -H 'Content-Type: application/json' \
  --data '{"mappings":{"properties":{"id":{"type":"integer"}}}}'
curl --silent --show-error --fail-with-body --user elastic \
  -X PUT "http://elasticsearch-source.demo.svc:9200/customers/_doc/1" \
  -H 'Content-Type: application/json' \
  --data '{"id":1,"full_name":"Customer 1","email":"[email protected]"}'
curl --silent --show-error --fail-with-body --user elastic \
  -X PUT "http://elasticsearch-source.demo.svc:9200/customers/_doc/2" \
  -H 'Content-Type: application/json' \
  --data '{"id":2,"full_name":"Customer 2","email":"[email protected]"}'
curl --silent --show-error --fail-with-body --user elastic \
  -X PUT "http://elasticsearch-source.demo.svc:9200/customers/_doc/3" \
  -H 'Content-Type: application/json' \
  --data '{"id":3,"full_name":"Customer 3","email":"[email protected]"}'
curl --silent --show-error --fail-with-body --user elastic \
  -X PUT "http://elasticsearch-source.demo.svc:9200/customers/_doc/4" \
  -H 'Content-Type: application/json' \
  --data '{"id":4,"full_name":"Customer 4","email":"[email protected]"}'
curl --silent --show-error --fail-with-body --user elastic \
  -X PUT "http://elasticsearch-source.demo.svc:9200/customers/_doc/5" \
  -H 'Content-Type: application/json' \
  --data '{"id":5,"full_name":"Customer 5","email":"[email protected]"}'

Refresh makes the documents searchable; flush commits pending index changes before the example storage snapshot:

curl --silent --show-error --fail-with-body --user elastic \
  -X POST "http://elasticsearch-source.demo.svc:9200/_refresh"
curl --silent --show-error --fail-with-body --user elastic \
  -X POST "http://elasticsearch-source.demo.svc:9200/_flush"
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-source.demo.svc:9200/customers/_count?filter_path=count&pretty"
{
  "count": 5
}
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-source.demo.svc:9200/customers/_search?size=5&sort=id:asc&filter_path=hits.hits._source&pretty"
{
  "hits": {
    "hits": [
      {"_source": {"id": 1, "full_name": "Customer 1", "email": "[email protected]"}},
      {"_source": {"id": 2, "full_name": "Customer 2", "email": "[email protected]"}},
      {"_source": {"id": 3, "full_name": "Customer 3", "email": "[email protected]"}},
      {"_source": {"id": 4, "full_name": "Customer 4", "email": "[email protected]"}},
      {"_source": {"id": 5, "full_name": "Customer 5", "email": "[email protected]"}}
    ]
  }
}

Run exit to return to your terminal.

Create the Branch

Save the following as elasticsearch-dev.yaml:

apiVersion: courier.kubedb.com/v1alpha1
kind: Branch
metadata:
  name: elasticsearch-dev
  namespace: demo
spec:
  source:
    databaseRef:
      apiGroup: kubedb.com
      kind: Elasticsearch
      name: elasticsearch-source
    namespace: demo
  target:
    namespace: dev
    name: elasticsearch-dev
    storageClassName: ceph-rbd
    resources:
      requests:
        cpu: 500m
        memory: 2Gi
      limits:
        memory: 2Gi
  deletionPolicy: Delete
kubectl -n demo apply -f elasticsearch-dev.yaml
kubectl -n demo wait branch/elasticsearch-dev --for=condition=Ready --timeout=60m
kubectl -n demo get branch elasticsearch-dev

Courier creates elasticsearch/elasticsearch-dev and its cloned PVCs in dev; KubeDB provisions the target database.

Verify the copied data

Discover the auth Secret referenced by elasticsearch-dev:

kubectl -n dev get elasticsearch elasticsearch-dev -o jsonpath='{.spec.authSecret.name}{"\n"}'
elasticsearch-dev-auth

Use the returned name below if it differs. Read its password:

kubectl -n dev get secret elasticsearch-dev-auth -o jsonpath='{.data.password}' | base64 -d

Enter this password when the client prompts.

From your terminal, open a pod shell:

kubectl -n dev exec -it elasticsearch-dev-0 -c elasticsearch -- bash

Run the following curl commands inside the pod shell. --user elastic prompts for the decoded password on each request. Requests use the database Service.

curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/customers/_count?filter_path=count&pretty"
{
  "count": 5
}
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/customers/_search?size=5&sort=id:asc&filter_path=hits.hits._source&pretty"
{
  "hits": {
    "hits": [
      {"_source": {"id": 1, "full_name": "Customer 1", "email": "[email protected]"}},
      {"_source": {"id": 2, "full_name": "Customer 2", "email": "[email protected]"}},
      {"_source": {"id": 3, "full_name": "Customer 3", "email": "[email protected]"}},
      {"_source": {"id": 4, "full_name": "Customer 4", "email": "[email protected]"}},
      {"_source": {"id": 5, "full_name": "Customer 5", "email": "[email protected]"}}
    ]
  }
}

Run exit to return to your terminal.

Inspect target resources

kubectl -n dev get pods,pvc -l app.kubernetes.io/instance=elasticsearch-dev

Discover the auth Secret referenced by elasticsearch-dev:

kubectl -n dev get elasticsearch elasticsearch-dev -o jsonpath='{.spec.authSecret.name}{"\n"}'
elasticsearch-dev-auth

Use the returned name below if it differs. Read its password:

kubectl -n dev get secret elasticsearch-dev-auth -o jsonpath='{.data.password}' | base64 -d

Enter this password when the client prompts.

From your terminal, open a pod shell:

kubectl -n dev exec -it elasticsearch-dev-0 -c elasticsearch -- bash

Run the following curl commands inside the pod shell. --user elastic prompts for the decoded password on each request. Requests use the database Service.

curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/_cluster/health?pretty"

Expect three nodes and an operational cluster. Its cluster_name and node endpoints belong to the branch.

Run exit to return to your terminal.

Verify independent writes

Change the branch

Discover the auth Secret referenced by elasticsearch-dev:

kubectl -n dev get elasticsearch elasticsearch-dev -o jsonpath='{.spec.authSecret.name}{"\n"}'
elasticsearch-dev-auth

Use the returned name below if it differs. Read its password:

kubectl -n dev get secret elasticsearch-dev-auth -o jsonpath='{.data.password}' | base64 -d

Enter this password when the client prompts.

From your terminal, open a pod shell:

kubectl -n dev exec -it elasticsearch-dev-0 -c elasticsearch -- bash

Run the following curl commands inside the pod shell. --user elastic prompts for the decoded password on each request. Requests use the database Service.

curl --silent --show-error --fail-with-body --user elastic \
  -X POST "http://elasticsearch-dev.dev.svc:9200/customers/_update/5?refresh=true" \
  -H 'Content-Type: application/json' \
  --data '{"doc":{"full_name":"Branch-only Customer 5"}}'
curl --silent --show-error --fail-with-body --user elastic \
  -X POST "http://elasticsearch-dev.dev.svc:9200/_flush"
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/customers/_count?filter_path=count&pretty"
{
  "count": 5
}
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/customers/_search?size=5&sort=id:asc&filter_path=hits.hits._source&pretty"
{
  "hits": {
    "hits": [
      {"_source": {"id": 1, "full_name": "Customer 1", "email": "[email protected]"}},
      {"_source": {"id": 2, "full_name": "Customer 2", "email": "[email protected]"}},
      {"_source": {"id": 3, "full_name": "Customer 3", "email": "[email protected]"}},
      {"_source": {"id": 4, "full_name": "Customer 4", "email": "[email protected]"}},
      {"_source": {"id": 5, "full_name": "Branch-only Customer 5", "email": "[email protected]"}}
    ]
  }
}

Run exit to return to your terminal.

Change and inspect the source

Discover the auth Secret referenced by elasticsearch-source:

kubectl -n demo get elasticsearch elasticsearch-source -o jsonpath='{.spec.authSecret.name}{"\n"}'
elasticsearch-source-auth

Use the returned name below if it differs. Read its password:

kubectl -n demo get secret elasticsearch-source-auth -o jsonpath='{.data.password}' | base64 -d

Enter this password when the client prompts.

From your terminal, open a pod shell:

kubectl -n demo exec -it elasticsearch-source-0 -c elasticsearch -- bash

Run the following curl commands inside the pod shell. --user elastic prompts for the decoded password on each request. Requests use the database Service.

curl --silent --show-error --fail-with-body --user elastic \
  -X POST "http://elasticsearch-source.demo.svc:9200/customers/_update/1?refresh=true" \
  -H 'Content-Type: application/json' \
  --data '{"doc":{"full_name":"Updated Customer 1"}}'
curl --silent --show-error --fail-with-body --user elastic \
  -X POST "http://elasticsearch-source.demo.svc:9200/_flush"
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-source.demo.svc:9200/customers/_count?filter_path=count&pretty"
{
  "count": 5
}
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-source.demo.svc:9200/customers/_search?size=5&sort=id:asc&filter_path=hits.hits._source&pretty"
{
  "hits": {
    "hits": [
      {"_source": {"id": 1, "full_name": "Updated Customer 1", "email": "[email protected]"}},
      {"_source": {"id": 2, "full_name": "Customer 2", "email": "[email protected]"}},
      {"_source": {"id": 3, "full_name": "Customer 3", "email": "[email protected]"}},
      {"_source": {"id": 4, "full_name": "Customer 4", "email": "[email protected]"}},
      {"_source": {"id": 5, "full_name": "Customer 5", "email": "[email protected]"}}
    ]
  }
}

Run exit to return to your terminal.

The source retains the original customer 5; the branch edit did not reach it.

Check the branch again

Discover the auth Secret referenced by elasticsearch-dev:

kubectl -n dev get elasticsearch elasticsearch-dev -o jsonpath='{.spec.authSecret.name}{"\n"}'
elasticsearch-dev-auth

Use the returned name below if it differs. Read its password:

kubectl -n dev get secret elasticsearch-dev-auth -o jsonpath='{.data.password}' | base64 -d

Enter this password when the client prompts.

From your terminal, open a pod shell:

kubectl -n dev exec -it elasticsearch-dev-0 -c elasticsearch -- bash

Run the following curl commands inside the pod shell. --user elastic prompts for the decoded password on each request. Requests use the database Service.

curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/customers/_count?filter_path=count&pretty"
{
  "count": 5
}
curl --silent --show-error --fail-with-body --user elastic \
  -X GET "http://elasticsearch-dev.dev.svc:9200/customers/_search?size=5&sort=id:asc&filter_path=hits.hits._source&pretty"
{
  "hits": {
    "hits": [
      {"_source": {"id": 1, "full_name": "Customer 1", "email": "[email protected]"}},
      {"_source": {"id": 2, "full_name": "Customer 2", "email": "[email protected]"}},
      {"_source": {"id": 3, "full_name": "Customer 3", "email": "[email protected]"}},
      {"_source": {"id": 4, "full_name": "Customer 4", "email": "[email protected]"}},
      {"_source": {"id": 5, "full_name": "Branch-only Customer 5", "email": "[email protected]"}}
    ]
  }
}

Run exit to return to your terminal.

The branch retains its own customer 5 and the original customer 1. The source update did not reach it.

Cleanup

Delete the Branch on the source cluster first. Let Courier remove its target and snapshots before deleting the source:

kubectl -n demo delete branch elasticsearch-dev --wait=true --timeout=30m
kubectl -n demo delete elasticsearch elasticsearch-source --wait=true --timeout=30m

Keep Courier, CSI, the shared backend, and OCM when used available until cleanup completes. These commands leave the namespaces in place.

Next Steps