# Stash Catalog

[Stash Catalog](https://github.com/stashed) - Catalog of Stash Addons

## TL;DR;

```bash
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/kubedb-kubestash-catalog --version=v2026.7.10
$ helm upgrade -i kubedb-kubestash-catalog appscode/kubedb-kubestash-catalog -n stash --create-namespace --version=v2026.7.10
```

## Introduction

This chart deploys Stash catalog on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

## Prerequisites

- Kubernetes 1.14+

## Installing the Chart

To install/upgrade the chart with the release name `kubedb-kubestash-catalog`:

```bash
$ helm upgrade -i kubedb-kubestash-catalog appscode/kubedb-kubestash-catalog -n stash --create-namespace --version=v2026.7.10
```

The command deploys Stash catalog on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

> **Tip**: List all releases using `helm list`

## Uninstalling the Chart

To uninstall the `kubedb-kubestash-catalog`:

```bash
$ helm uninstall kubedb-kubestash-catalog -n stash
```

The command removes all the Kubernetes components associated with the chart and deletes the release.

## Configuration

The following table lists the configurable parameters of the `kubedb-kubestash-catalog` chart and their default values.

|         Parameter          |                                                                                                                                                                                   Description                                                                                                                                                                                   |                  Default                   |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| proxies.dockerHub          |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| proxies.dockerLibrary      |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| proxies.ghcr               |                                                                                                                                                                                                                                                                                                                                                                                 | <code>ghcr.io</code>                       |
| proxies.quay               |                                                                                                                                                                                                                                                                                                                                                                                 | <code>quay.io</code>                       |
| proxies.kubernetes         |                                                                                                                                                                                                                                                                                                                                                                                 | <code>registry.k8s.io</code>               |
| proxies.microsoft          |                                                                                                                                                                                                                                                                                                                                                                                 | <code>mcr.microsoft.com</code>             |
| proxies.appscode           |                                                                                                                                                                                                                                                                                                                                                                                 | <code>r.appscode.com</code>                |
| proxies.oracle             |                                                                                                                                                                                                                                                                                                                                                                                 | <code>container-registry.oracle.com</code> |
| proxies.weaviate           |                                                                                                                                                                                                                                                                                                                                                                                 | <code>cr.weaviate.io</code>                |
| waitTimeout                | registryFQDN: harbor.appscode.ninja proxies: dockerHub: harbor.appscode.ninja/dockerhub dockerLibrary: "" ghcr: harbor.appscode.ninja/ghcr quay: harbor.appscode.ninja/quay kubernetes: harbor.appscode.ninja/k8s microsoft: harbor.appscode.ninja/mcr appscode: harbor.appscode.ninja/ac Number of seconds to wait for the database to be ready before backup/restore process. | <code>300</code>                           |
| featureGates.ClickHouse    |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Cassandra     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Druid         |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Elasticsearch |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Kafka         |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.MariaDB       |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Memcached     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.MSSQLServer   |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.MongoDB       |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.MySQL         |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Neo4j         |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.PerconaXtraDB |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.PgBouncer     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Pgpool        |                                                                                                                                                                                                                                                                                                                                                                                 | <code>false</code>                         |
| featureGates.Postgres      |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.ProxySQL      |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.RabbitMQ      |                                                                                                                                                                                                                                                                                                                                                                                 | <code>false</code>                         |
| featureGates.Redis         |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Qdrant        |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Singlestore   |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| featureGates.Solr          |                                                                                                                                                                                                                                                                                                                                                                                 | <code>false</code>                         |
| featureGates.ZooKeeper     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| cassandra.backup.args      |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| cassandra.restore.args     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| clickhouse.backup.args     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| clickhouse.restore.args    |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| druid.backup.args          | Arguments to pass to mysqldump or pg_dump command  during bakcup process                                                                                                                                                                                                                                                                                                        | <code>""</code>                            |
| druid.restore.args         | Arguments to pass to mysqldump or pg_dump command during restore process                                                                                                                                                                                                                                                                                                        | <code>""</code>                            |
| elasticsearch.backup.args  | Arguments to pass to `multielasticdump` command  during backup process                                                                                                                                                                                                                                                                                                          | <code>""</code>                            |
| elasticsearch.restore.args | Arguments to pass to `multielasticdump` command during restore process                                                                                                                                                                                                                                                                                                          | <code>""</code>                            |
| opensearch.backup.args     | Arguments to pass to `multielasticdump` command  during backup process                                                                                                                                                                                                                                                                                                          | <code>""</code>                            |
| opensearch.restore.args    | Arguments to pass to `multielasticdump` command during restore process                                                                                                                                                                                                                                                                                                          | <code>""</code>                            |
| kubedbmanifest.enabled     | If true, deploys KubeDBManifest addon                                                                                                                                                                                                                                                                                                                                           | <code>true</code>                          |
| mongodb.maxConcurrency     | Maximum concurrency to perform backup or restore tasks                                                                                                                                                                                                                                                                                                                          | <code>3</code>                             |
| mongodb.backup.args        | Arguments to pass to `mongodump` command during backup process                                                                                                                                                                                                                                                                                                                  | <code>""</code>                            |
| mongodb.restore.args       | Arguments to pass to `mongorestore` command during restore process                                                                                                                                                                                                                                                                                                              | <code>""</code>                            |
| mssqlserver.maxConcurrency | Maximum concurrency to perform backup or restore tasks                                                                                                                                                                                                                                                                                                                          | <code>3</code>                             |
| mssqlserver.backup.args    |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| mssqlserver.restore.args   |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| postgres.backup.cmd        | Postgres dump command, can either be: pg_dumpall  or pg_dump                                                                                                                                                                                                                                                                                                                    | <code>"pg_dumpall"</code>                  |
| postgres.backup.args       | Arguments to pass to `backup.cmd` command during backup process                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| postgres.restore.args      | Arguments to pass to `psql` command during restore process                                                                                                                                                                                                                                                                                                                      | <code>""</code>                            |
| mysql.backup.args          | Arguments to pass to `mysqldump` command  during bakcup process                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| mysql.restore.args         | Arguments to pass to `mysql` command during restore process                                                                                                                                                                                                                                                                                                                     | <code>""</code>                            |
| mariadb.backup.args        | Arguments to pass to `mariadb-dump` command  during bakcup process                                                                                                                                                                                                                                                                                                              | <code>""</code>                            |
| mariadb.restore.args       | Arguments to pass to `mariadb` command during restore process                                                                                                                                                                                                                                                                                                                   | <code>""</code>                            |
| redis.backup.args          | Arguments to pass to `redis-dump` command  during bakcup process                                                                                                                                                                                                                                                                                                                | <code>""</code>                            |
| redis.restore.args         | Arguments to pass to `redis` command during restore process                                                                                                                                                                                                                                                                                                                     | <code>""</code>                            |
| singlestore.backup.args    | Arguments to pass to `singlestore-dump` command  during bakcup process                                                                                                                                                                                                                                                                                                          | <code>""</code>                            |
| singlestore.restore.args   | Arguments to pass to `singlestore` command during restore process                                                                                                                                                                                                                                                                                                               | <code>""</code>                            |
| zookeeper.backup.args      | Arguments to pass to `zk-dump` command  during bakcup process                                                                                                                                                                                                                                                                                                                   | <code>""</code>                            |
| zookeeper.restore.args     | Arguments to pass to `zookeeper` command during restore process                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |
| kubedbverifier.enabled     |                                                                                                                                                                                                                                                                                                                                                                                 | <code>true</code>                          |
| distro.openshift           |                                                                                                                                                                                                                                                                                                                                                                                 | <code>false</code>                         |
| distro.ubi                 |                                                                                                                                                                                                                                                                                                                                                                                 | <code>""</code>                            |


Specify each parameter using the `--set key=value[,key=value]` argument to `helm upgrade -i`. For example:

```bash
$ helm upgrade -i kubedb-kubestash-catalog appscode/kubedb-kubestash-catalog -n stash --create-namespace --version=v2026.7.10 --set proxies.ghcr=ghcr.io
```

Alternatively, a YAML file that specifies the values for the parameters can be provided while
installing the chart. For example:

```bash
$ helm upgrade -i kubedb-kubestash-catalog appscode/kubedb-kubestash-catalog -n stash --create-namespace --version=v2026.7.10 --values values.yaml
```
