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

Kanister docs update to version 0.95.0 #2318

Merged
Merged
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
Kanister docs update to version 0.95.0
Kasten Production authored and PrasadG193 committed Sep 8, 2023
commit 1533e24485e191349bc6712ccebe2012e84e6169
2 changes: 1 addition & 1 deletion examples/aws-rds/postgresql/README.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ This example is to demonstrate how Kanister can be integrated with AWS RDS insta
## Prerequisites

- Kubernetes 1.10+
- Kanister controller version 0.94.0 installed in your cluster
- Kanister controller version 0.95.0 installed in your cluster
- Kanctl CLI installed (https://docs.kanister.io/tooling.html#kanctl)

## Create RDS instance on AWS
6 changes: 3 additions & 3 deletions examples/aws-rds/postgresql/rds-postgres-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ actions:
- func: KubeTask
name: backupSnapshots
args:
image: "ghcr.io/kanisterio/postgres-kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/postgres-kanister-tools:0.95.0"
namespace: "{{ .Object.metadata.namespace }}"
command:
- bash
@@ -53,7 +53,7 @@ actions:
- func: KubeTask
name: restoreSnapshots
args:
image: "ghcr.io/kanisterio/postgres-kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/postgres-kanister-tools:0.95.0"
namespace: "{{ .Object.metadata.namespace }}"
command:
- bash
@@ -90,7 +90,7 @@ actions:
- func: KubeTask
name: restoreSnapshots
args:
image: "ghcr.io/kanisterio/postgres-kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/postgres-kanister-tools:0.95.0"
namespace: "{{ .Namespace.Name }}"
command:
- bash
Original file line number Diff line number Diff line change
@@ -66,7 +66,7 @@ actions:
name: deleteBackup
args:
namespace: "{{ .Namespace.Name }}"
image: ghcr.io/kanisterio/kanister-tools:0.94.0
image: ghcr.io/kanisterio/kanister-tools:0.95.0
command:
- bash
- -o
4 changes: 2 additions & 2 deletions examples/cassandra/README.md
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ As the official documentation of [Cassandra](http://cassandra.apache.org/) says,
* Kubernetes 1.9+
* Kubernetes beta APIs enabled only if `podDisruptionBudget` is enabled
* PV support on the underlying infrastructure
* Kanister controller version 0.94.0 installed in your cluster, let's say in namespace `<kanister-operator-namespace>`
* Kanister controller version 0.95.0 installed in your cluster, let's say in namespace `<kanister-operator-namespace>`
* Kanctl CLI installed (https://docs.kanister.io/tooling.html#kanctl)

To install kanister and related tools you can follow [this](https://docs.kanister.io/install.html#install) link.
@@ -29,7 +29,7 @@ $ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update
# remove app-namespace with the namespace you want to deploy the Cassandra app in
$ kubectl create ns <app-namespace>
$ helm install cassandra bitnami/cassandra --namespace <app-namespace> --set image.repository=kanisterio/cassandra --set image.tag=0.94.0 --set cluster.replicaCount=2 --set image.registry=ghcr.io --set image.pullPolicy=Always
$ helm install cassandra bitnami/cassandra --namespace <app-namespace> --set image.repository=kanisterio/cassandra --set image.tag=0.95.0 --set cluster.replicaCount=2 --set image.registry=ghcr.io --set image.pullPolicy=Always


```
2 changes: 1 addition & 1 deletion examples/cassandra/cassandra-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -102,7 +102,7 @@ actions:
name: restoreFromObjectStore
args:
namespace: "{{ .StatefulSet.Namespace }}"
image: ghcr.io/kanisterio/kanister-tools:0.94.0
image: ghcr.io/kanisterio/kanister-tools:0.95.0
backupArtifactPrefix: "{{ .ArtifactsIn.params.KeyValue.backupPrefixLocation }}"
pods: "{{ range .StatefulSet.Pods }} {{.}}{{end}}"
restorePath: "{{ .ArtifactsIn.params.KeyValue.restorePathPrefix }}"
2 changes: 1 addition & 1 deletion examples/cockroachdb/cockroachdb-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -151,7 +151,7 @@ actions:
- func: KubeTask
name: deleteFromS3Store
args:
image: ghcr.io/kanisterio/kanister-tools:0.94.0
image: ghcr.io/kanisterio/kanister-tools:0.95.0
namespace: "{{ .Namespace.Name }}"
command:
- bash
6 changes: 3 additions & 3 deletions examples/couchbase/blueprint-v2/couchbase-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ actions:
namespace: "{{ .Object.metadata.namespace }}"
args:
namespace: "{{ .Object.metadata.namespace }}"
image: ghcr.io/kanisterio/couchbase-tools:0.94.0
image: ghcr.io/kanisterio/couchbase-tools:0.95.0
command:
- bash
- -o
@@ -58,7 +58,7 @@ actions:
namespace: "{{ .Object.metadata.namespace }}"
args:
namespace: "{{ .Object.metadata.namespace }}"
image: ghcr.io/kanisterio/couchbase-tools:0.94.0
image: ghcr.io/kanisterio/couchbase-tools:0.95.0
command:
- bash
- -o
@@ -89,7 +89,7 @@ actions:
name: deleteBackup
args:
namespace: "{{ .Namespace.Name }}"
image: ghcr.io/kanisterio/couchbase-tools:0.94.0
image: ghcr.io/kanisterio/couchbase-tools:0.95.0
command:
- bash
- -o
2 changes: 1 addition & 1 deletion examples/couchbase/couchbase-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -79,7 +79,7 @@ actions:
name: deleteBackup
args:
namespace: "{{ .Namespace.Name }}"
image: ghcr.io/kanisterio/kanister-tools:0.94.0
image: ghcr.io/kanisterio/kanister-tools:0.95.0
command:
- bash
- -o
2 changes: 1 addition & 1 deletion examples/csi-snapshot/README.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ This example demonstrates Kanister's ability to protect an application called Ti

- Helm 3 installed
- Kubernetes 1.16+ with Beta APIs enabled
- Kanister controller version 0.94.0 installed in the cluster, let's assume in namespace `kanister`
- Kanister controller version 0.95.0 installed in the cluster, let's assume in namespace `kanister`
- Kanctl CLI installed (https://docs.kanister.io/tooling.html#install-the-tools)
- VolumeSnapshot CRDs, Snapshot Controller & a CSI Driver

4 changes: 2 additions & 2 deletions examples/elasticsearch/README.md
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ moving on to Elasticsearch 6.0.

* Kubernetes 1.20+
* PV provisioner support in the underlying infrastructure
* Kanister controller version 0.94.0 installed in your cluster
* Kanister controller version 0.95.0 installed in your cluster
* Kanctl CLI installed (https://docs.kanister.io/tooling.html#install-the-tools)

## StatefulSets Details
@@ -74,7 +74,7 @@ Add Kanister Helm repository and install Kanister operator
```bash
$ helm repo add kanister https://charts.kanister.io
$ helm install kanister --namespace kanister --create-namespace \
kanister/kanister-operator --set image.tag=0.94.0
kanister/kanister-operator --set image.tag=0.95.0
```

### Create Profile
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ actions:
namespace: "{{ .StatefulSet.Namespace }}"
args:
namespace: "{{ .StatefulSet.Namespace }}"
image: "ghcr.io/kanisterio/es-sidecar:0.94.0"
image: "ghcr.io/kanisterio/es-sidecar:0.95.0"
command:
- bash
- -o
@@ -50,7 +50,7 @@ actions:
namespace: "{{ .StatefulSet.Namespace }}"
args:
namespace: "{{ .StatefulSet.Namespace }}"
image: "ghcr.io/kanisterio/es-sidecar:0.94.0"
image: "ghcr.io/kanisterio/es-sidecar:0.95.0"
command:
- bash
- -o
@@ -75,7 +75,7 @@ actions:
name: deleteFromStore
args:
namespace: "{{ .Namespace.Name }}"
image: "ghcr.io/kanisterio/es-sidecar:0.94.0"
image: "ghcr.io/kanisterio/es-sidecar:0.95.0"
command:
- bash
- -o
6 changes: 3 additions & 3 deletions examples/elasticsearch/elasticsearch-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ actions:
namespace: "{{ .StatefulSet.Namespace }}"
args:
namespace: "{{ .StatefulSet.Namespace }}"
image: "ghcr.io/kanisterio/es-sidecar:0.94.0"
image: "ghcr.io/kanisterio/es-sidecar:0.95.0"
command:
- bash
- -o
@@ -48,7 +48,7 @@ actions:
namespace: "{{ .StatefulSet.Namespace }}"
args:
namespace: "{{ .StatefulSet.Namespace }}"
image: "ghcr.io/kanisterio/es-sidecar:0.94.0"
image: "ghcr.io/kanisterio/es-sidecar:0.95.0"
command:
- bash
- -o
@@ -69,7 +69,7 @@ actions:
name: deleteFromObjectStore
args:
namespace: "{{ .Namespace.Name }}"
image: "ghcr.io/kanisterio/es-sidecar:0.94.0"
image: "ghcr.io/kanisterio/es-sidecar:0.95.0"
command:
- bash
- -o
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ actions:
- func: KubeTask
name: takeSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -37,7 +37,7 @@ actions:
- func: KubeTask
name: uploadSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -55,7 +55,7 @@ actions:
- func: KubeTask
name: removeSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -74,7 +74,7 @@ actions:
name: deleteFromObjectStore
args:
namespace: "{{ .Namespace.Name }}"
image: "ghcr.io/kanisterio/kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/kanister-tools:0.95.0"
command:
- bash
- -o
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ actions:
- func: KubeTask
name: takeSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -34,7 +34,7 @@ actions:
- func: KubeTask
name: uploadSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -50,7 +50,7 @@ actions:
- func: KubeTask
name: removeSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -73,7 +73,7 @@ actions:
- func: PrepareData
name: copyFromObjectStore
args:
image: "ghcr.io/kanisterio/kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/kanister-tools:0.95.0"
namespace: "{{ .Object.metadata.namespace }}"
podOverride:
nodeSelector:
@@ -108,7 +108,7 @@ actions:
name: deleteFromObjectStore
args:
namespace: "{{ .Namespace.Name }}"
image: "ghcr.io/kanisterio/kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/kanister-tools:0.95.0"
command:
- bash
- -o
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ actions:
- func: KubeTask
name: takeSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -35,7 +35,7 @@ actions:
- func: KubeTask
name: uploadSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -53,7 +53,7 @@ actions:
- func: KubeTask
name: removeSnapshot
args:
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.94.0
image: ghcr.io/kanisterio/kanister-kubectl-1.18:0.95.0
command:
- sh
- -o
@@ -72,7 +72,7 @@ actions:
name: deleteFromObjectStore
args:
namespace: "{{ .Namespace.Name }}"
image: "ghcr.io/kanisterio/kanister-tools:0.94.0"
image: "ghcr.io/kanisterio/kanister-tools:0.95.0"
command:
- bash
- -o
2 changes: 1 addition & 1 deletion examples/foundationdb/README.md
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ cluster.
on you cluster.
* Kubernetes 1.9+ with Beta APIs enabled.
* PV support on the underlying infrastructure.
* Kanister version 0.94.0 with `profiles.cr.kanister.io` CRD installed.
* Kanister version 0.95.0 with `profiles.cr.kanister.io` CRD installed.
* Docker CLI installed
* A docker image containing the required tools to back up FoundationDB.
The Dockerfile for the image can be found [here](https://raw.githubusercontent.com/kanisterio/kanister/master/docker/foundationdb/Dockerfile).
Original file line number Diff line number Diff line change
@@ -77,7 +77,7 @@ actions:
name: deleteBackup
args:
namespace: "{{ .Namespace.Name }}"
image: ghcr.io/kanisterio/kanister-tools:0.94.0
image: ghcr.io/kanisterio/kanister-tools:0.95.0
command:
- bash
- -o
2 changes: 1 addition & 1 deletion examples/k8ssandra/README.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ K8ssandra operator uses Medusa to backup and restore Cassandra data. Kanister ca

* Kubernetes 1.17+
* PV support on the underlying infrastructure
* Kanister controller version 0.94.0 installed in your cluster
* Kanister controller version 0.95.0 installed in your cluster
* Kanctl CLI installed (https://docs.kanister.io/tooling.html#kanctl)
* K8ssandra needs at least 4 cores and 8GB of RAM available to Docker and appropriate heap sizes for Cassandra and Stargate. If you don’t have those resources available, you can avoid deploying features such as monitoring, Reaper and Medusa, and also reduce the number of Cassandra nodes.

2 changes: 1 addition & 1 deletion examples/kafka/adobe-s3-connector/README.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ During restore, topic messages are purged before the restore operation is perfor
## Prerequisites

* Kubernetes 1.9+
* Kanister controller version 0.94.0 installed in the cluster in a namespace <kanister-operator-namespace>. This example uses `kanister` namespace
* Kanister controller version 0.95.0 installed in the cluster in a namespace <kanister-operator-namespace>. This example uses `kanister` namespace
* Kanctl CLI installed (https://docs.kanister.io/tooling.html#kanctl)

## Assumption
6 changes: 3 additions & 3 deletions examples/maria/blueprint-v2/maria-blueprint.yaml
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@ actions:
name: '{{ .StatefulSet.Name }}'
namespace: '{{ .StatefulSet.Namespace }}'
args:
image: ghcr.io/kanisterio/mysql-sidecar:0.94.0
image: ghcr.io/kanisterio/mysql-sidecar:0.95.0
namespace: "{{ .StatefulSet.Namespace }}"
command:
- bash
@@ -53,7 +53,7 @@ actions:
name: '{{ .StatefulSet.Name }}'
namespace: '{{ .StatefulSet.Namespace }}'
args:
image: ghcr.io/kanisterio/mysql-sidecar:0.94.0
image: ghcr.io/kanisterio/mysql-sidecar:0.95.0
namespace: "{{ .StatefulSet.Namespace }}"
command:
- bash
@@ -76,7 +76,7 @@ actions:
- func: KubeTask
name: deleteFromStore
args:
image: ghcr.io/kanisterio/mysql-sidecar:0.94.0
image: ghcr.io/kanisterio/mysql-sidecar:0.95.0
namespace: "{{ .Namespace.Name }}"
command:
- bash
Loading