Skip to content
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.

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

Move Sample Blueprints Out Of 'stable' Folder #1268

Merged
merged 5 commits into from
Mar 17, 2022
Merged
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
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/tooling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
37 changes: 10 additions & 27 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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).
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/cassandra-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/couchbase-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/elasticsearch-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/foundationdb-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/maria-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/mongo-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/mongo-dep-config-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/mssql-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/mysql-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/mysql-dep-config-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/pitr-postgres-blueprint.yaml
2 changes: 1 addition & 1 deletion pkg/blueprint/blueprints/postgres-blueprint.yaml