Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,20 @@
title: Contributing | KubeObj
description: Contributing
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: contributing-kubeobj
name: Contributing
parent: welcome
weight: 10
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: welcome
url: /docs/{{ .version }}/welcome/contributing/
url: /docs/v2025.10.31/welcome/contributing/
aliases:
- /docs/{{ .version }}/CONTRIBUTING/
- /docs/v2025.10.31/CONTRIBUTING/
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# Contribution Guidelines
Expand Down
38 changes: 21 additions & 17 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,51 @@
title: Welcome | KubeObj
description: Welcome to KubeObj
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: readme-kubeobj
name: Readme
parent: welcome
weight: -1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: welcome
url: /docs/{{ .version }}/welcome/
url: /docs/v2025.10.31/welcome/
aliases:
- /docs/{{ .version }}/
- /docs/{{ .version }}/README/
- /docs/v2025.10.31/
- /docs/v2025.10.31/README/
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# NooBaa

[NooBaa]() is an open-source, cloud-native data management and object storage platform. It enables unified data access, multi-cloud federation, and seamless scalability by abstracting underlying storage resources. NooBaa helps organizations manage, migrate, and protect data across on-premises and cloud environments efficiently.

## [Concepts](/docs/concepts/)
## [Concepts](/docs/v2025.10.31/concepts/)
Concept explains some significant aspect of NooBaa. This is where you can learn about what NooBaa does and how it does it.

- [NooBaa Overview](/docs/concepts/what-is-noobaa/overview/index.md) Provides an introduction to NooBaa and gives an overview of the features it provides.
- [NooBaa API](/docs/concepts/crds/backingstore/index.md) Introduces NooBaa CRDs.
- [NooBaa Overview](/docs/v2025.10.31/concepts/what-is-noobaa/overview/) Provides an introduction to NooBaa and gives an overview of the features it provides.
- [NooBaa API](/docs/v2025.10.31/concepts/crds/backingstore/) Introduces NooBaa CRDs.


## [Setup](/docs/setup/)
## [Setup](/docs/v2025.10.31/setup/)

Setup contains instructions for installing, uninstalling, and upgrading KubeStash.

- **Install NooBaa:** Provides instructions for installing NooBaa.
- [Install](/docs/setup/install/index.md) How to install KubeStash.
- [Install](/docs/v2025.10.31/setup/install/) How to install KubeStash.


## [Guides](/docs/guides/)
## [Guides](/docs/v2025.10.31/guides/)

Guides section shows how to perform different operations with NooBaa.

- [Cloud Native Operations](/docs/guides/cloud-native-operation/index.md): Describes how to manage cloud-native experience for object storage management.
- [On Prem With Scalability](/docs/guides/on-prem-with-scalability/index.md): Explains how to deploy and scale NooBaa on-premises.
- [Multi Cloud Federation](/docs/guides/multi-cloud-federation/index.md): Describes how to federate data across multiple clouds.
- [Unified Data Access](/docs/guides/unified-data-access/index.md): Guides on accessing data from various storage systems through a single endpoint.
- [Data Replication](/docs/guides/data-replication-policy/index.md): Provides instructions for setting up a highly available NooBaa deployment.
- [High Availability](/docs/guides/high-availability/index.md): Describes how we can achive highly available NooBaa deployment.
- [Cloud Native Operations](/docs/v2025.10.31/guides/cloud-native-operation/): Describes how to manage cloud-native experience for object storage management.
- [On Prem With Scalability](/docs/v2025.10.31/guides/on-prem-with-scalability/): Explains how to deploy and scale NooBaa on-premises.
- [Multi Cloud Federation](/docs/v2025.10.31/guides/multi-cloud-federation/): Describes how to federate data across multiple clouds.
- [Unified Data Access](/docs/v2025.10.31/guides/unified-data-access/): Guides on accessing data from various storage systems through a single endpoint.
- [Data Replication](/docs/v2025.10.31/guides/data-replication-policy/): Provides instructions for setting up a highly available NooBaa deployment.
- [High Availability](/docs/v2025.10.31/guides/high-availability/): Describes how we can achive highly available NooBaa deployment.

We're always looking for help improving our documentation, so please don't hesitate to [file an issue](https://github.com/kubeobj/) if you see some problem.
11 changes: 8 additions & 3 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@
title: KubeObj
description: KubeObj
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: welcome
name: Welcome
weight: 10
menu_name: docs_{{ .version }}
weight: 1
menu_name: docs_v2025.10.31
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

25 changes: 16 additions & 9 deletions docs/concepts/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
---
title: Readme
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: readme-concepts
name: Readme
parent: concepts-docs
parent: concepts
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
url: /docs/v2025.10.31/concepts/
aliases:
- /docs/v2025.10.31/concepts/README/
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# Concepts
Expand All @@ -16,12 +23,12 @@ Concepts help you to learn about the different parts of the NooBaa and the abstr
This concept section is divided into the following modules:

## What is NooBaa?
- [Overview](/docs/concepts/what-is-noobaa/overview/index.md) provides an introduction to NooBaa. It also gives an overview of the features it provides.
- [Overview](/docs/v2025.10.31/concepts/what-is-noobaa/overview/) provides an introduction to NooBaa. It also gives an overview of the features it provides.

## Declarative API

- [NooBaa](/docs/concepts/crds/noobaa/index.md): This is the central CRD for a NooBaa deployment. It represents the entire NooBaa system and orchestrates all its components. Administrators interact with this resource to install, configure, and manage the NooBaa platform within a Kubernetes cluster.
- [BackingStore](/docs/concepts/crds/backingstore/index.md): A `BackingStore` represents underlying storage resources that NooBaa can use to store data. These can be cloud-based storage services (like AWS S3, Azure Blob Storage, or Google Cloud Storage) or on-premises storage systems (like a PV pool). `BackingStore`s are used to create buckets and provide the physical storage layer.
- [NamespaceStore](/docs/concepts/crds/namespacestore/index.md): A `NamespaceStore` is a special type of `BackingStore` that represents an entire external bucket or a prefix within a bucket. Instead of using the external storage as a backing for NooBaa's own data services (like deduplication and compression), a `NamespaceStore` provides a direct, transparent connection to the external resource. This is useful for data federation and accessing existing data in place.
- [BucketClass](/docs/concepts/crds/bucketclass/index.md): A `BucketClass` defines policies for how data is placed and managed across one or more `BackingStore`s. It can specify data placement policies like mirroring or spreading data across different stores. When a user requests a new bucket, they can specify a `BucketClass` to control the behavior and characteristics of their bucket.
- [ObjectBucketClaim](/docs/concepts/crds/objectbucketclaim/index.md): An `ObjectBucketClaim` (OBC) is a Kubernetes-native way for a user or application to request a new object storage bucket, similar to how a `PersistentVolumeClaim` (PVC) requests block or file storage. When an OBC is created, the NooBaa operator provisions a corresponding `ObjectBucket` and makes the connection details available to the application via a `Secret` and a `ConfigMap`.
- [NooBaa](/docs/v2025.10.31/concepts/crds/noobaa/): This is the central CRD for a NooBaa deployment. It represents the entire NooBaa system and orchestrates all its components. Administrators interact with this resource to install, configure, and manage the NooBaa platform within a Kubernetes cluster.
- [BackingStore](/docs/v2025.10.31/concepts/crds/backingstore/): A `BackingStore` represents underlying storage resources that NooBaa can use to store data. These can be cloud-based storage services (like AWS S3, Azure Blob Storage, or Google Cloud Storage) or on-premises storage systems (like a PV pool). `BackingStore`s are used to create buckets and provide the physical storage layer.
- [NamespaceStore](/docs/v2025.10.31/concepts/crds/namespacestore/): A `NamespaceStore` is a special type of `BackingStore` that represents an entire external bucket or a prefix within a bucket. Instead of using the external storage as a backing for NooBaa's own data services (like deduplication and compression), a `NamespaceStore` provides a direct, transparent connection to the external resource. This is useful for data federation and accessing existing data in place.
- [BucketClass](/docs/v2025.10.31/concepts/crds/bucketclass/): A `BucketClass` defines policies for how data is placed and managed across one or more `BackingStore`s. It can specify data placement policies like mirroring or spreading data across different stores. When a user requests a new bucket, they can specify a `BucketClass` to control the behavior and characteristics of their bucket.
- [ObjectBucketClaim](/docs/v2025.10.31/concepts/crds/objectbucketclaim/): An `ObjectBucketClaim` (OBC) is a Kubernetes-native way for a user or application to request a new object storage bucket, similar to how a `PersistentVolumeClaim` (PVC) requests block or file storage. When an OBC is created, the NooBaa operator provisions a corresponding `ObjectBucket` and makes the connection details available to the application via a `Secret` and a `ConfigMap`.
12 changes: 8 additions & 4 deletions docs/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
---
title: Concepts
menu:
docs_{{ .version }}:
identifier: concepts-docs
docs_v2025.10.31:
identifier: concepts
name: Concepts
weight: 1
menu_name: docs_{{ .version }}
weight: 2
menu_name: docs_v2025.10.31
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

14 changes: 9 additions & 5 deletions docs/concepts/crds/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: Crds
menu:
docs_{{ .version }}:
identifier: crds-concepts
docs_v2025.10.31:
identifier: crds
name: Crds
parent: concepts-docs
weight: 1
menu_name: docs_{{ .version }}
parent: concepts
weight: 15
menu_name: docs_v2025.10.31
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

12 changes: 8 additions & 4 deletions docs/concepts/crds/backingstore/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-backingstore
name: Index
parent: backingstore-crds
name: BackingStore
parent: crds
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# BackingStore
Expand Down
16 changes: 10 additions & 6 deletions docs/concepts/crds/bucketclass/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
title: BucketClass
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-bucketclass
name: Index
parent: bucketclass-crds
weight: 1
menu_name: docs_{{ .version }}
name: BucketClass
parent: crds
weight: 2
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# BucketClass
Expand Down
14 changes: 9 additions & 5 deletions docs/concepts/crds/namespacestore/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
title: NamespaceStore
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-namespacestore
name: Index
parent: namespacestore-crds
name: NamespaceStore
parent: crds
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# NamespaceStore
Expand Down
14 changes: 9 additions & 5 deletions docs/concepts/crds/noobaa/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
title: NooBaa
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-noobaa
name: Index
parent: noobaa-crds
name: NooBaa
parent: crds
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# NooBaa
Expand Down
14 changes: 9 additions & 5 deletions docs/concepts/crds/objectbucket/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
title: ObjectBucket
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-objectbucket
name: Index
parent: objectbucket-crds
name: ObjectBucket
parent: crds
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# ObjectBucket
Expand Down
14 changes: 9 additions & 5 deletions docs/concepts/crds/objectbucketclaim/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
title: ObjectBucketClaim
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-objectbucketclaim
name: Index
parent: objectbucketclaim-crds
name: ObjectBucketClaim
parent: crds
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# ObjectBucketClaim
Expand Down
10 changes: 7 additions & 3 deletions docs/concepts/what-is-noobaa/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: What Is Noobaa
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: what-is-noobaa-concepts
name: What Is Noobaa
parent: concepts-docs
parent: concepts
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

14 changes: 9 additions & 5 deletions docs/concepts/what-is-noobaa/overview/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: Index
title: NooBaa
menu:
docs_{{ .version }}:
docs_v2025.10.31:
identifier: index-overview
name: Index
parent: overview-what-is-noobaa
name: NooBaa
parent: what-is-noobaa-concepts
weight: 1
menu_name: docs_{{ .version }}
menu_name: docs_v2025.10.31
section_menu_id: concepts
info:
cli: v0.20.0
installer: v2025.10.31
version: v2025.10.31
---

# NooBaa
Expand Down
22 changes: 22 additions & 0 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Table of Contents | Guides
description: Table of Contents | Guides
menu:
docs_v2025.10.31:
identifier: guides-readme
name: Readme
parent: guides
weight: -1
product_name: kubeobj
menu_name: docs_v2025.10.31
section_menu_id: guides
url: /docs/v2025.10.31/guides/
aliases:
- /docs/v2025.10.31/guides/README/
---

# Guides
Guides show how to perform different operations with KubeObj. We have divided guides section into the following sub-sections:



Loading
Loading