Move Sample Blueprints Out Of 'stable' Folder (#1268)

* Move 'stable' blueprints to the parent 'examples' folder The 'stable' folder indicates the stability of the Helm charts, not that of the blueprints. To avoid further confusion, we are removing that folder since we have no control over the stability of the charts. Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * Update READMEs and docs Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * Update symlinks to integration test blueprints Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * s/Kanisteri/Kanister Co-authored-by: Pavan Navarathna <pavan@kasten.io> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
kanisterio · Mar 17, 2022 · 6dcf914 · 6dcf914
1 parent b8e8008
commit 6dcf914
Show file tree

Hide file tree

Showing 68 changed files with 38 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -30,18 +30,18 @@ your storage infrastructure.
 ## Community Applications
 
 Stable Helm charts that have been updated with Kanister support.
-- **[Cassandra](./examples/stable/cassandra)**
-- **[Couchbase](./examples/stable/couchbase)**
-- **[Elasticsearch](./examples/stable/elasticsearch)**
-- **[FoundationDB](./examples/stable/foundationdb)**
-- **[MongoDB on OpenShift using DeploymentConfig](./examples/stable/mongodb-deploymentconfig)**
-- **[MongoDB](./examples/stable/mongodb)**
-- **[MySQL on OpenShift using DeploymentConfig](./examples/stable/mysql-deploymentconfig)**
-- **[MySQL](./examples/stable/mysql)**
-- **[PostgreSQL with Point In Time Recovery (PITR)](./examples/stable/postgresql-wale)**
+- **[Cassandra](./examples/cassandra)**
+- **[Couchbase](./examples/couchbase)**
+- **[Elasticsearch](./examples/elasticsearch)**
+- **[FoundationDB](./examples/foundationdb)**
+- **[MongoDB on OpenShift using DeploymentConfig](./examples/mongodb-deploymentconfig)**
+- **[MongoDB](./examples/mongodb)**
+- **[MySQL on OpenShift using DeploymentConfig](./examples/mysql-deploymentconfig)**
+- **[MySQL](./examples/mysql)**
+- **[PostgreSQL with Point In Time Recovery (PITR)](./examples/postgresql-wale)**
 - **[ETCD](./examples/etcd/etcd-in-cluster)**
-- **[PostgreSQL on OpenShift using DeploymentConfig](./examples/stable/postgresql-deploymentconfig)**
-- **[PostgreSQL](./examples/stable/postgresql)**
+- **[PostgreSQL on OpenShift using DeploymentConfig](./examples/postgresql-deploymentconfig)**
+- **[PostgreSQL](./examples/postgresql)**
 
 
 ## Kanister in action for MySQL Database

diff --git a/docs/tooling.rst b/docs/tooling.rst
@@ -299,7 +299,7 @@ using ``-f`` flag and optionally ``-v`` flag for kanister function version.
 .. substitution-code-block:: bash
 
    # Download mysql blueprint locally
-   $ curl -O https://raw.githubusercontent.com/kanisterio/kanister/|version|/examples/stable/mysql/mysql-blueprint.yaml
+   $ curl -O https://raw.githubusercontent.com/kanisterio/kanister/|version|/examples/mysql/mysql-blueprint.yaml
 
    # Run blueprint validator
    $ kanctl validate blueprint -f mysql-blueprint.yaml

diff --git a/examples/README.md b/examples/README.md
@@ -1,32 +1,15 @@
 # Examples
 
-## Helm Examples
+This folder contains some Helm charts that have been updated to include Kanister
+blueprints, to make experimenting with Kanister easier.
 
-To make it easier to experiment with Kanister, we have modified a few upstream Helm charts to add Kanister Blueprints as well as easily configure the application via Helm. More information on these is available in the [kanister docs](https://docs.kanister.io/helm.html) with a brief summary available below:
+If you are new to Kanister, start with the `time-log` blueprint. After that,
+feel free to try out some of the more advanced examples like the blueprints for
+MySQL, PgSQL, MongoDB and ElasticSearch, following the instructions in the
+[Kanister documentation](https://docs.kanister.io/helm.html#kanister-enabled-applications).
 
+Every example has its own README.md with information on how to set things up and
+commands to be run.
 
-* `kanister-mongodb-replicaset/`
-
-     Dynamically scaleable MongoDB replica set protected using mongodump
-
-* `kanister-mysql/`
-
-     Single-node MySQL deployment protected using mysqldump.
-
-* `kanister-postgresql/`
-
-    PostgreSQL deployment protected using continuous archiving of PostgreSQL WAL files and base backups. Supports advanced features such as Point-In-Time-Restore (PITR).
-
-## Non-Helm Examples
-
-* `mongo-sidecar/`
-
-    MongoDB statefulset with a Kanister sidecar. Uses monogdump.
-
-* `postgres-basic-pgdump/`
-
-    Unmodified PostgreSQL deployment (deployed via the Patroni operator) and protected using `pg_dumpall`.
-
-* `time-log/`
-
-    Kanister tutorial. Demonstrates Kanister features using a simple time-logger deployment.
+Found a mistake in a blueprint? Having difficulty getting the blueprints to
+work? Find us on the Kanister [Slack](kanisterio.slack.com).
diff --git a/examples/stable/cassandra/README.md → examples/cassandra/README.md b/examples/stable/cassandra/README.md → examples/cassandra/README.md
diff --git a/...stable/cassandra/cassandra-blueprint.yaml → examples/cassandra/cassandra-blueprint.yaml b/...stable/cassandra/cassandra-blueprint.yaml → examples/cassandra/cassandra-blueprint.yaml
diff --git a/examples/stable/couchbase/README.md → examples/couchbase/README.md b/examples/stable/couchbase/README.md → examples/couchbase/README.md
diff --git a/...ase/blueprint-v2/couchbase-blueprint.yaml → ...ase/blueprint-v2/couchbase-blueprint.yaml b/...ase/blueprint-v2/couchbase-blueprint.yaml → ...ase/blueprint-v2/couchbase-blueprint.yaml
diff --git a/...stable/couchbase/couchbase-blueprint.yaml → examples/couchbase/couchbase-blueprint.yaml b/...stable/couchbase/couchbase-blueprint.yaml → examples/couchbase/couchbase-blueprint.yaml
diff --git a/...chbase/kanister-clusteradmin-binding.yaml → ...chbase/kanister-clusteradmin-binding.yaml b/...chbase/kanister-clusteradmin-binding.yaml → ...chbase/kanister-clusteradmin-binding.yaml
diff --git a/examples/stable/csi-snapshot/README.md → examples/csi-snapshot/README.md b/examples/stable/csi-snapshot/README.md → examples/csi-snapshot/README.md
@@ -37,10 +37,10 @@ Sun Jan 23 08:54:39 UTC 2022
 
 Create the Blueprint in `kanister` namespace
 
-> **Note**:  This example uses a Kubernetes cluster on DigitalOcean. Therefore the `snapshotClass` and `storageClass` in the following `./examples/stable/csi-snapshot/csi-snapshot-blueprint.yaml` file are set to `do-block-storage`. Change the arguments appropriately before creating the blueprint.
+> **Note**:  This example uses a Kubernetes cluster on DigitalOcean. Therefore the `snapshotClass` and `storageClass` in the following `./examples/csi-snapshot/csi-snapshot-blueprint.yaml` file are set to `do-block-storage`. Change the arguments appropriately before creating the blueprint.
 
 ```bash
-$ kubectl create -f ./examples/stable/csi-snapshot/csi-snapshot-blueprint.yaml -n kanister
+$ kubectl create -f ./examples/csi-snapshot/csi-snapshot-blueprint.yaml -n kanister
 ```
 
 ### Backup the application data

diff --git a/.../csi-snapshot/csi-snapshot-blueprint.yaml → .../csi-snapshot/csi-snapshot-blueprint.yaml b/.../csi-snapshot/csi-snapshot-blueprint.yaml → .../csi-snapshot/csi-snapshot-blueprint.yaml
diff --git a/examples/stable/elasticsearch/README.md → examples/elasticsearch/README.md b/examples/stable/elasticsearch/README.md → examples/elasticsearch/README.md
@@ -122,7 +122,7 @@ $ curl 'localhost:9200/customer/_search?q=*&pretty'
 In order to perform backup, restore, and delete operations on the running elasticsearch, we need to create a blueprint. You can create that using the command below from the root of kanister repo.
 
 ```bash
-kubectl create -f ./examples/stable/elasticsearch/elasticsearch-blueprint.yaml -n kasten-io
+kubectl create -f ./examples/elasticsearch/elasticsearch-blueprint.yaml -n kasten-io
 ```
 
 ## Protect the Application

diff --git a/...blueprint-v2/elasticsearch-blueprint.yaml → ...blueprint-v2/elasticsearch-blueprint.yaml b/...blueprint-v2/elasticsearch-blueprint.yaml → ...blueprint-v2/elasticsearch-blueprint.yaml
diff --git a/...lasticsearch/elasticsearch-blueprint.yaml → ...lasticsearch/elasticsearch-blueprint.yaml b/...lasticsearch/elasticsearch-blueprint.yaml → ...lasticsearch/elasticsearch-blueprint.yaml
diff --git a/...le/elasticsearch/extraInitContainers.yaml → ...es/elasticsearch/extraInitContainers.yaml b/...le/elasticsearch/extraInitContainers.yaml → ...es/elasticsearch/extraInitContainers.yaml
diff --git a/examples/stable/foundationdb/README.md → examples/foundationdb/README.md b/examples/stable/foundationdb/README.md → examples/foundationdb/README.md
diff --git a/.../blueprint-v2/foundationdb-blueprint.yaml → .../blueprint-v2/foundationdb-blueprint.yaml b/.../blueprint-v2/foundationdb-blueprint.yaml → .../blueprint-v2/foundationdb-blueprint.yaml
diff --git a/.../foundationdb/foundationdb-blueprint.yaml → .../foundationdb/foundationdb-blueprint.yaml b/.../foundationdb/foundationdb-blueprint.yaml → .../foundationdb/foundationdb-blueprint.yaml
diff --git a/...tiondb/kanister-clusteradmin-binding.yaml → ...tiondb/kanister-clusteradmin-binding.yaml b/...tiondb/kanister-clusteradmin-binding.yaml → ...tiondb/kanister-clusteradmin-binding.yaml
diff --git a/...es/stable/foundationdb/local_cluster.yaml → examples/foundationdb/local_cluster.yaml b/...es/stable/foundationdb/local_cluster.yaml → examples/foundationdb/local_cluster.yaml
diff --git a/examples/stable/maria/README.md → examples/maria/README.md b/examples/stable/maria/README.md → examples/maria/README.md
diff --git a/...e/maria/blueprint-v2/maria-blueprint.yaml → ...s/maria/blueprint-v2/maria-blueprint.yaml b/...e/maria/blueprint-v2/maria-blueprint.yaml → ...s/maria/blueprint-v2/maria-blueprint.yaml
diff --git a/examples/stable/maria/maria-blueprint.yaml → examples/maria/maria-blueprint.yaml b/examples/stable/maria/maria-blueprint.yaml → examples/maria/maria-blueprint.yaml
diff --git a/...stable/mongodb-deploymentconfig/README.md → examples/mongodb-deploymentconfig/README.md b/...stable/mongodb-deploymentconfig/README.md → examples/mongodb-deploymentconfig/README.md
diff --git a/...eprint-v2/mongo-dep-config-blueprint.yaml → ...eprint-v2/mongo-dep-config-blueprint.yaml b/...eprint-v2/mongo-dep-config-blueprint.yaml → ...eprint-v2/mongo-dep-config-blueprint.yaml
diff --git a/...entconfig/mongo-dep-config-blueprint.yaml → ...entconfig/mongo-dep-config-blueprint.yaml b/...entconfig/mongo-dep-config-blueprint.yaml → ...entconfig/mongo-dep-config-blueprint.yaml
diff --git a/examples/stable/mongodb-restic/README.md → examples/mongodb-restic/README.md b/examples/stable/mongodb-restic/README.md → examples/mongodb-restic/README.md
diff --git a/...ble/mongodb-restic/mongodb-blueprint.yaml → ...les/mongodb-restic/mongodb-blueprint.yaml b/...ble/mongodb-restic/mongodb-blueprint.yaml → ...les/mongodb-restic/mongodb-blueprint.yaml
diff --git a/...table/mongodb/7.8.10/mongo-blueprint.yaml → examples/mongodb/7.8.10/mongo-blueprint.yaml b/...table/mongodb/7.8.10/mongo-blueprint.yaml → examples/mongodb/7.8.10/mongo-blueprint.yaml
diff --git a/examples/stable/mongodb/README.md → examples/mongodb/README.md b/examples/stable/mongodb/README.md → examples/mongodb/README.md
diff --git a/...mongodb/blueprint-v2/mongo-blueprint.yaml → ...mongodb/blueprint-v2/mongo-blueprint.yaml b/...mongodb/blueprint-v2/mongo-blueprint.yaml → ...mongodb/blueprint-v2/mongo-blueprint.yaml
diff --git a/examples/stable/mongodb/mongo-blueprint.yaml → examples/mongodb/mongo-blueprint.yaml b/examples/stable/mongodb/mongo-blueprint.yaml → examples/mongodb/mongo-blueprint.yaml
diff --git a/examples/stable/mssql/README.md → examples/mssql/README.md b/examples/stable/mssql/README.md → examples/mssql/README.md
diff --git a/...e/mssql/blueprint-v2/mssql-blueprint.yaml → ...s/mssql/blueprint-v2/mssql-blueprint.yaml b/...e/mssql/blueprint-v2/mssql-blueprint.yaml → ...s/mssql/blueprint-v2/mssql-blueprint.yaml
diff --git a/examples/stable/mssql/mssql-blueprint.yaml → examples/mssql/mssql-blueprint.yaml b/examples/stable/mssql/mssql-blueprint.yaml → examples/mssql/mssql-blueprint.yaml
diff --git a/...s/stable/mysql-deploymentconfig/README.md → examples/mysql-deploymentconfig/README.md b/...s/stable/mysql-deploymentconfig/README.md → examples/mysql-deploymentconfig/README.md
diff --git a/...eprint-v2/mysql-dep-config-blueprint.yaml → ...eprint-v2/mysql-dep-config-blueprint.yaml b/...eprint-v2/mysql-dep-config-blueprint.yaml → ...eprint-v2/mysql-dep-config-blueprint.yaml
diff --git a/...entconfig/mysql-dep-config-blueprint.yaml → ...entconfig/mysql-dep-config-blueprint.yaml b/...entconfig/mysql-dep-config-blueprint.yaml → ...entconfig/mysql-dep-config-blueprint.yaml
diff --git a/examples/stable/mysql/6.x/README.md → examples/mysql/6.x/README.md b/examples/stable/mysql/6.x/README.md → examples/mysql/6.x/README.md
diff --git a/...les/stable/mysql/6.x/mysql-blueprint.yaml → examples/mysql/6.x/mysql-blueprint.yaml b/...les/stable/mysql/6.x/mysql-blueprint.yaml → examples/mysql/6.x/mysql-blueprint.yaml
diff --git a/examples/stable/mysql/README.md → examples/mysql/README.md b/examples/stable/mysql/README.md → examples/mysql/README.md
diff --git a/...e/mysql/blueprint-v2/mysql-blueprint.yaml → ...s/mysql/blueprint-v2/mysql-blueprint.yaml b/...e/mysql/blueprint-v2/mysql-blueprint.yaml → ...s/mysql/blueprint-v2/mysql-blueprint.yaml
diff --git a/examples/stable/mysql/mysql-blueprint.yaml → examples/mysql/mysql-blueprint.yaml b/examples/stable/mysql/mysql-blueprint.yaml → examples/mysql/mysql-blueprint.yaml
diff --git a/...ble/postgresql-deploymentconfig/README.md → ...les/postgresql-deploymentconfig/README.md b/...ble/postgresql-deploymentconfig/README.md → ...les/postgresql-deploymentconfig/README.md
diff --git a/...int-v2/postgres-dep-config-blueprint.yaml → ...int-v2/postgres-dep-config-blueprint.yaml b/...int-v2/postgres-dep-config-blueprint.yaml → ...int-v2/postgres-dep-config-blueprint.yaml
diff --git a/...config/postgres-dep-config-blueprint.yaml → ...config/postgres-dep-config-blueprint.yaml b/...config/postgres-dep-config-blueprint.yaml → ...config/postgres-dep-config-blueprint.yaml
diff --git a/...le/postgresql-ha/hook-blueprint/README.md → ...es/postgresql-ha/hook-blueprint/README.md b/...le/postgresql-ha/hook-blueprint/README.md → ...es/postgresql-ha/hook-blueprint/README.md
diff --git a/...l-ha/hook-blueprint/postgres-ha-hook.yaml → ...l-ha/hook-blueprint/postgres-ha-hook.yaml b/...l-ha/hook-blueprint/postgres-ha-hook.yaml → ...l-ha/hook-blueprint/postgres-ha-hook.yaml
diff --git a/examples/stable/postgresql-wale/README.md → examples/postgresql-wale/README.md b/examples/stable/postgresql-wale/README.md → examples/postgresql-wale/README.md
diff --git a/...postgresql-wale/postgresql-blueprint.yaml → ...postgresql-wale/postgresql-blueprint.yaml b/...postgresql-wale/postgresql-blueprint.yaml → ...postgresql-wale/postgresql-blueprint.yaml
diff --git a/examples/stable/postgresql/README.md → examples/postgresql/README.md b/examples/stable/postgresql/README.md → examples/postgresql/README.md
diff --git a/...esql/blueprint-v2/postgres-blueprint.yaml → ...esql/blueprint-v2/postgres-blueprint.yaml b/...esql/blueprint-v2/postgres-blueprint.yaml → ...esql/blueprint-v2/postgres-blueprint.yaml
diff --git a/...stable/postgresql/postgres-blueprint.yaml → examples/postgresql/postgres-blueprint.yaml b/...stable/postgresql/postgres-blueprint.yaml → examples/postgresql/postgres-blueprint.yaml
diff --git a/...stgresql/v10.16.2/postgres-blueprint.yaml → ...stgresql/v10.16.2/postgres-blueprint.yaml b/...stgresql/v10.16.2/postgres-blueprint.yaml → ...stgresql/v10.16.2/postgres-blueprint.yaml
diff --git a/...postgresql/v8.6.4/postgres-blueprint.yaml → ...postgresql/v8.6.4/postgres-blueprint.yaml b/...postgresql/v8.6.4/postgres-blueprint.yaml → ...postgresql/v8.6.4/postgres-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/cassandra-blueprint.yaml b/pkg/blueprint/blueprints/cassandra-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/cassandra/cassandra-blueprint.yaml
+../../../examples/cassandra/cassandra-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/couchbase-blueprint.yaml b/pkg/blueprint/blueprints/couchbase-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/couchbase/couchbase-blueprint.yaml
+../../../examples/couchbase/couchbase-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/elasticsearch-blueprint.yaml b/pkg/blueprint/blueprints/elasticsearch-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/elasticsearch/elasticsearch-blueprint.yaml
+../../../examples/elasticsearch/elasticsearch-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/foundationdb-blueprint.yaml b/pkg/blueprint/blueprints/foundationdb-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/foundationdb/foundationdb-blueprint.yaml
+../../../examples/foundationdb/foundationdb-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/maria-blueprint.yaml b/pkg/blueprint/blueprints/maria-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/maria/maria-blueprint.yaml
+../../../examples/maria/maria-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/mongo-blueprint.yaml b/pkg/blueprint/blueprints/mongo-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/mongodb/mongo-blueprint.yaml
+../../../examples/mongodb/mongo-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/mongo-dep-config-blueprint.yaml b/pkg/blueprint/blueprints/mongo-dep-config-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/mongodb-deploymentconfig/mongo-dep-config-blueprint.yaml
+../../../examples/mongodb-deploymentconfig/mongo-dep-config-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/mssql-blueprint.yaml b/pkg/blueprint/blueprints/mssql-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/mssql/mssql-blueprint.yaml
+../../../examples/mssql/mssql-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/mysql-blueprint.yaml b/pkg/blueprint/blueprints/mysql-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/mysql/mysql-blueprint.yaml
+../../../examples/mysql/mysql-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/mysql-dep-config-blueprint.yaml b/pkg/blueprint/blueprints/mysql-dep-config-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/mysql-deploymentconfig/mysql-dep-config-blueprint.yaml
+../../../examples/mysql-deploymentconfig/mysql-dep-config-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/pitr-postgres-blueprint.yaml b/pkg/blueprint/blueprints/pitr-postgres-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/postgresql-wale/postgresql-blueprint.yaml
+../../../examples/postgresql-wale/postgresql-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/postgres-blueprint.yaml b/pkg/blueprint/blueprints/postgres-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/postgresql/postgres-blueprint.yaml
+../../../examples/postgresql/postgres-blueprint.yaml
diff --git a/pkg/blueprint/blueprints/postgres-dep-config-blueprint.yaml b/pkg/blueprint/blueprints/postgres-dep-config-blueprint.yaml
@@ -1 +1 @@
-../../../examples/stable/postgresql-deploymentconfig/postgres-dep-config-blueprint.yaml
+../../../examples/postgresql-deploymentconfig/postgres-dep-config-blueprint.yaml