Skip to content

Klio v0.0.x Tech Preview #7082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
josh-heyer wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Klio v0.0.x Tech Preview #7082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cc6dd84
klio product definition
josh-heyer Jan 5, 2026
fc0631a
klio 0.0.10 import
josh-heyer Jan 5, 2026
9a5449e
add 'caution' admonition (maps to warning)
josh-heyer Jan 19, 2026
3237749
klio 0.0.11 import
josh-heyer Jan 19, 2026
3bd07db
Address Stephen's concerns
josh-heyer Jan 21, 2026
c41e60b
zsh compatibility
josh-heyer Jan 22, 2026
3cb62e2
fix typo (it->is)
josh-heyer Jan 29, 2026
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
2 changes: 2 additions & 0 deletions gatsby-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ const sourceToPluginConfig = {
name: "jdbc_connector",
path: "product_docs/docs/jdbc_connector",
},
klio: { name: "klio", path: "product_docs/docs/klio" },
language_pack: {
name: "language_pack",
path: "product_docs/docs/language_pack",
Expand Down Expand Up @@ -430,6 +431,7 @@ module.exports = {
seealso: "note",
hint: "tip",
interactive: "interactive",
caution: "warning",
},
},
],
Expand Down
42 changes: 42 additions & 0 deletions product_docs/docs/klio/0/_helm_chart_values.mdx
View file
Open in desktop

Large diffs are not rendered by default.

249 changes: 249 additions & 0 deletions product_docs/docs/klio/0/api/_klio_api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

103 changes: 103 additions & 0 deletions product_docs/docs/klio/0/api/_klio_catalog_api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Packages

- [kliocatalog.enterprisedb.io/v1alpha1](#kliocatalogenterprisedbiov1alpha1)

## kliocatalog.enterprisedb.io/v1alpha1

Package v1alpha1 the Klio Catalog API

### Resource Types

- [KlioBackup](#kliobackup)
- [KlioBackupList](#kliobackuplist)

#### KlioBackup

KlioBackup is the Schema for a Klio Backup API.

*Appears in:*

- [KlioBackupList](#kliobackuplist)

| Field | Description | Required | Default | Validation |
| ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | -------- | ------- | ------------------- |
| `apiVersion` *string* | `kliocatalog.enterprisedb.io/v1alpha1` | True | | |
| `kind` *string* | `KlioBackup` | True | | |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | True | | |
| `spec` *[KlioBackupSpec](#kliobackupspec)* | | True | | |
| `status` *[KlioBackupStatus](#kliobackupstatus)* | | | | Optional: {} <br /> |

#### KlioBackupList

KlioBackupList contains a list of KlioBackup.

| Field | Description | Required | Default | Validation |
| -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -------- | ------- | ---------- |
| `apiVersion` *string* | `kliocatalog.enterprisedb.io/v1alpha1` | True | | |
| `kind` *string* | `KlioBackupList` | True | | |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | True | | |
| `items` *[KlioBackup](#kliobackup) array* | | True | | |

#### KlioBackupSpec

KlioBackupSpec defines the desired state of a KlioBackup.

*Appears in:*

- [KlioBackup](#kliobackup)

| Field | Description | Required | Default | Validation |
| ---------------------- | -------------------------------------------------------------- | -------- | ------- | ---------- |
| `clusterName` *string* | ClusterName is the name of the cluster that has been backed up | True | | |
| `backupID` *string* | BackupID is the unique identifier of the backup | True | | |

#### KlioBackupStatus

KlioBackupStatus defines the observed state of a KlioBackup.

*Appears in:*

- [KlioBackup](#kliobackup)

| Field | Description | Required | Default | Validation |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -------- | ------- | ---------- |
| `startLSN` *integer* | StartLSN is the LSN of the backup start | True | | |
| `endLSN` *integer* | EndLSN is the LSN of the backup end | True | | |
| `startWAL` *string* | StartWAL is the current WAL when the backup started | True | | |
| `endWAL` *string* | EndWAL is the current WAL when the backup ends | True | | |
| `tablespaces` *[TablespaceLayoutList](#tablespacelayoutlist)* | Tablespaces are the metadata of the tablespaces | True | | |
| `annotations` *object (keys:string, values:string)* | Annotations is a generic data store where each<br />backend can put its metadata. | True | | |
| `startedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta)* | StartedAt is the current time when the backup started. | True | | |
| `stoppedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta)* | StoppedAt is the current time when the backup ended. | True | | |

#### TablespaceLayout

TablespaceLayout is the on-disk structure of a tablespace.

*Appears in:*

- [TablespaceLayoutList](#tablespacelayoutlist)

| Field | Description | Required | Default | Validation |
| --------------------------------------------------- | -------------------------------------------------------------------------------------- | -------- | ------- | ---------- |
| `name` *string* | Name is the tablespace name | True | | |
| `oid` *string* | Oid is the OID of the tablespace. | True | | |
| `path` *string* | Path is the path where the tablespace can be found. | True | | |
| `annotations` *object (keys:string, values:string)* | Annotations is a generic data store where each backend<br />can annotate its metadata. | True | | |

#### TablespaceLayoutList

*Underlying type:* *[TablespaceLayout](#tablespacelayout)*

TablespaceLayoutList is a list of TablespaceLayout.

*Appears in:*

- [KlioBackupStatus](#kliobackupstatus)

| Field | Description | Required | Default | Validation |
| --------------------------------------------------- | -------------------------------------------------------------------------------------- | -------- | ------- | ---------- |
| `name` *string* | Name is the tablespace name | True | | |
| `oid` *string* | Oid is the OID of the tablespace. | True | | |
| `path` *string* | Path is the path where the tablespace can be found. | True | | |
| `annotations` *object (keys:string, values:string)* | Annotations is a generic data store where each backend<br />can annotate its metadata. | True | | |
10 changes: 10 additions & 0 deletions product_docs/docs/klio/0/api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: API Reference
navigation:
- klio_api
- klio_catalog_api
- '!_klio_api'
- '!_klio_catalog_api'
indexCards: extra
---

11 changes: 11 additions & 0 deletions product_docs/docs/klio/0/api/klio_api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Klio API reference
originalFilePath: >-
https://github.com/EnterpriseDB/klio/blob/main/docs/documentation/web//versioned_docs/version-0.0.11/api/klio_api.mdx
editTarget: originalFilePath

---

import KlioAPI from "./_klio_api.mdx";

<KlioAPI />
11 changes: 11 additions & 0 deletions product_docs/docs/klio/0/api/klio_catalog_api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Klio Catalog API reference
originalFilePath: >-
https://github.com/EnterpriseDB/klio/blob/main/docs/documentation/web//versioned_docs/version-0.0.11/api/klio_catalog_api.mdx
editTarget: originalFilePath

---

import KlioCatalogAPI from "./_klio_catalog_api.mdx";

<KlioCatalogAPI />
Loading
Loading