Skip to content

Commit

Permalink
remove helm2 references (#1270)
Browse files Browse the repository at this point in the history
* remove helm2 references

* address review comments

* remove helmv2 release name

* resolve conflicts

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
kale-amruta and mergify[bot] committed Mar 22, 2022
1 parent 9715d7b commit 60ff903
Show file tree
Hide file tree
Showing 19 changed files with 45 additions and 68 deletions.
2 changes: 1 addition & 1 deletion docs/helm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You also need to install the Kanister controller

.. substitution-code-block:: console

$ helm install --name myrelease --namespace kanister kanister/kanister-operator --set image.tag=|version|
$ helm install myrelease --namespace kanister --create-namespace kanister/kanister-operator --set image.tag=|version|

Kanister-Enabled Applications
=============================
Expand Down
6 changes: 3 additions & 3 deletions docs/helm_instructions/elasticsearch_instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Then install the sample Elasticsearch application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled Elasticsearch
$ helm install kanister/kanister-elasticsearch -n elasticsearch \
$ helm install elasticsearch kanister/kanister-elasticsearch \
--namespace es-test \
--set profile.create='true' \
--set profile.profileName='es-test-profile' \
Expand All @@ -36,7 +36,7 @@ Then install the sample Elasticsearch application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled Elasticsearch
$ helm install kanister/kanister-elasticsearch -n elasticsearch --namespace es-test
$ helm install elasticsearch kanister/kanister-elasticsearch --namespace es-test
The settings in the command above represent the minimum recommended set for
Expand All @@ -51,7 +51,7 @@ your installation.
.. code-block:: rst
# Install Kanister-enabled Elasticsearch
$ helm install kanister/kanister-elasticsearch -n elasticsearch --namespace es-test
$ helm install elasticsearch kanister/kanister-elasticsearch elasticsearch --namespace es-test
.. note:: The above command will attempt to use dynamic storage provisioning
based on the the default storage class for your cluster. You will to need to
Expand Down
6 changes: 3 additions & 3 deletions docs/helm_instructions/mongodb_instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Then install the sample MongoDB replica set application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled MongoDB Replica Set
$ helm install kanister/kanister-mongodb-replicaset -n mongodb \
$ helm install mongodb kanister/kanister-mongodb-replicaset \
--namespace mongodb-test \
--set profile.create='true' \
--set profile.profileName='mongo-test-profile' \
Expand All @@ -37,7 +37,7 @@ Then install the sample MongoDB replica set application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled MongoDB Replica Set
$ helm install kanister/kanister-mongodb-replicaset -n mongodb \
$ helm install mongodb kanister/kanister-mongodb-replicaset \
--namespace mongodb-test \
--set persistentVolume.size=2Gi
Expand All @@ -53,7 +53,7 @@ your installation of a single node replica set.
.. code-block:: rst
# Install Kanister-enabled MongoDB Replica Set
$ helm install kanister/kanister-mongodb-replicaset -n mongodb \
$ helm install mongodb kanister/kanister-mongodb-replicaset \
--namespace mongodb-test \
--set persistentVolume.size=2Gi
Expand Down
6 changes: 3 additions & 3 deletions docs/helm_instructions/mysql_instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Then install the sample MySQL application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled MySQL
$ helm install kanister/kanister-mysql -n mysql --namespace mysql-test \
$ helm install mysql kanister/kanister-mysql --namespace mysql-test \
--set profile.create='true' \
--set profile.profileName='mysql-test-profile' \
--set profile.location.type='s3Compliant' \
Expand All @@ -36,7 +36,7 @@ Then install the sample MySQL application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled MySQL
$ helm install kanister/kanister-mysql -n mysql --namespace mysql-test \
$ helm install mysql kanister/kanister-mysql --namespace mysql-test \
--set mysqlRootPassword="asd#45@mysqlEXAMPLE" \
--set persistence.size=10Gi
Expand All @@ -53,7 +53,7 @@ your installation.
.. code-block:: rst
# Install Kanister-enabled MySQL
$ helm install kanister/kanister-mysql -n mysql --namespace mysql-test \
$ helm install mysql kanister/kanister-mysql --namespace mysql-test \
--set mysqlRootPassword="asd#45@mysqlEXAMPLE" \
--set persistence.size=10Gi
Expand Down
6 changes: 3 additions & 3 deletions docs/helm_instructions/pgsql_instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Then install the sample PostgreSQL application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled PostgreSQL
$ helm install kanister/kanister-postgresql -n postgresql \
$ helm install postgresql kanister/kanister-postgresql \
--namespace postgresql-test \
--set profile.create='true' \
--set profile.profileName='postgres-test-profile' \
Expand All @@ -39,7 +39,7 @@ Then install the sample PostgreSQL application in its own namespace.
.. code-block:: rst
# Install Kanister-enabled PostgreSQL
$ helm install kanister/kanister-postgresql -n postgresql \
$ helm install postgresql kanister/kanister-postgresql \
--namespace postgresql-test
The settings in the command above represent the minimum recommended set for
Expand All @@ -63,7 +63,7 @@ your installation.
.. code-block:: rst
# Install Kanister-enabled PostgreSQL
$ helm install kanister/kanister-postgresql -n postgresql \
$ helm install postgresql kanister/kanister-postgresql \
--namespace postgresql-test
.. note:: The above command will attempt to use dynamic storage provisioning
Expand Down
4 changes: 2 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Prerequisites
* `kubectl <https://kubernetes.io/docs/tasks/tools/install-kubectl/>`_ installed
and setup

* `helm <https://helm.sh>`_ installed and initialized using the command ``helm init``
* `helm <https://helm.sh>`_ installed

* :ref:`kanctl <tooling>` installed

Expand All @@ -36,7 +36,7 @@ This will install the Kanister controller in the ``kanister`` namespace
$ helm repo add kanister https://charts.kanister.io/

# Install the Kanister operator controller using helm
$ helm install --name myrelease --namespace kanister kanister/kanister-operator --set image.tag=|version|
$ helm install myrelease --namespace kanister --create-namespace kanister/kanister-operator --set image.tag=|version|

# Create an S3 Compliant Kanister profile using kanctl
$ kanctl create profile s3compliant --bucket <bucket> --access-key ${AWS_ACCESS_KEY_ID} \
Expand Down
7 changes: 4 additions & 3 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,13 @@ and backup to an AWS S3 bucket.
helm repo add kanister http://charts.kanister.io

# Install the Kanister Controller
helm install --name myrelease --namespace kanister kanister/kanister-operator --set image.tag=|version|
helm install myrelease --namespace kanister --create-namespace kanister/kanister-operator --set image.tag=|version|

# Install MySQL and configure its Kanister Blueprint.
# Also create a Profile CR that can be used in ActionSets
helm install kanister/kanister-mysql \
--name mysql-release --namespace mysql-ns \

helm install mysql-release kanister/kanister-mysql \
--namespace mysql-ns \
--set profile.create='true' \
--set profile.location.type='s3Compliant' \
--set profile.location.bucket='mysql-backup-bucket' \
Expand Down
4 changes: 0 additions & 4 deletions examples/elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,6 @@ $ helm repo add elastic https://helm.elastic.co
Then install the sample Elasticsearch application with the release name `my-release` in its own namespace
`es-test` using the command below. Make sure you have the kanister controller running in namespace `kasten-io` which is the default setting in Elasticsearch charts. Otherwise, you will also have to set the `kanister.controller_namespace` parameter value to the respective kanister controller namespace in the following command:

```bash
$ helm install --namespace es-test --name elasticsearch elastic/elasticsearch --set antiAffinity=soft
```
If you are running helm version `v3.0.0`, please use the commands below:
```bash
$ kubectl create namespace es-test
$ helm install --namespace es-test elasticsearch elastic/elasticsearch --set antiAffinity=soft
Expand Down
2 changes: 1 addition & 1 deletion examples/maria/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ $ helm repo add bitnami https://charts.bitnami.com/bitnami
# Update your local chart repository
$ helm repo update

# Install the maria database (Helm Version 3)
# Install the maria database
$ kubectl create namespace maria-db
$ helm install my-release bitnami/mariadb -n maria-db

Expand Down
1 change: 0 additions & 1 deletion examples/mongodb-restic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ $ helm repo update
# Create namespace for test
$ kubectl create namespace mongo-test

# Using helm v3
$ helm install my-release bitnami/mongodb --namespace mongo-test \
--set architecture="replicaset" \
--set image.repository=ghcr.io/kanisterio/mongodb \
Expand Down
7 changes: 1 addition & 6 deletions examples/mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,7 @@ To install the chart with the release name `my-release`:
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update

# Using helm v3
$ helm install my-release bitnami/mongodb --namespace mongo-test \
--set architecture="replicaset"

# Using helm < v3
$ helm install bitnami/mongodb --name my-release --namespace mongo-test \
$ helm install my-release bitnami/mongodb --namespace mongo-test --create-namespace \
--set architecture="replicaset"
```

Expand Down
2 changes: 1 addition & 1 deletion examples/mysql/6.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ $ helm repo add bitnami https://charts.bitnami.com/bitnami
# Update your local chart repository
$ helm repo update

# Install the MySQL database (Helm Version 3)
# Install the MySQL database
$ kubectl create namespace mysql-test
$ helm install mysql-release bitnami/mysql --version 6.14.11 --namespace mysql-test \
--set root.password='asd#45@mysqlEXAMPLE'
Expand Down
2 changes: 1 addition & 1 deletion examples/mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ $ helm repo add bitnami https://charts.bitnami.com/bitnami
# Update your local chart repository
$ helm repo update

# Install the MySQL database (Helm Version 3)
# Install the MySQL database
$ kubectl create namespace mysql-test
$ helm install mysql-release bitnami/mysql --namespace mysql-test \
--set auth.rootPassword='asd#45@mysqlEXAMPLE'
Expand Down
4 changes: 2 additions & 2 deletions examples/picture-gallery-pvc-snapshot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Next create a Blueprint which describes how backup and restore actions can be ex

```bash
# Configure access to an S3 Bucket
$ helm install kanister/profile \
--name profile --namespace kanister \
$ helm install profile kanister/profile \
--namespace kanister --create-namespace \
--set defaultProfile=true \
--set location.type='s3Compliant' \
--set location.bucket="my-kanister-bucket" \
Expand Down
4 changes: 2 additions & 2 deletions examples/postgres-basic-pgdump/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ This is an example of using Kanister to backup and restore PostgreSQL. In this e

Deploy a Postgres instance using the instructions [here](https://github.com/kubernetes/charts/tree/master/incubator/patroni):
```bash
$ helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
$ helm repo add incubator https://charts.helm.sh/incubator/
$ helm dependency update
$ helm install --namespace kanister --name my-release incubator/patroni
$ helm install my-release --namespace kanister --create-namespace incubator/patroni
```

### 2. Protect the Application
Expand Down
8 changes: 0 additions & 8 deletions examples/postgresql-ha/hook-blueprint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,8 @@ To install the chart with the release name `my-release`:
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update

# If you are using helm v3
$ kubectl create ns postgres-ha-test
$ helm install my-release --namespace postgres-ha-test bitnami/postgresql-ha

# If you are using helm v2
$ helm install --name my-release --namespace postgres-ha-test bitnami/postgresql-ha
```

The command deploys PostgreSQL HA on the Kubernetes cluster in the default configuration.
Expand Down Expand Up @@ -147,10 +143,6 @@ $ kubectl describe actionset <actionset-name> -n kanister
To uninstall/delete the `my-release` deployment:

```bash
# If you are using helm v2
$ helm delete --purge my-release

# If you are using helm v3
$ helm delete my-release -n postgres-ha-test

Delete the namespace where the application is restored
Expand Down
22 changes: 11 additions & 11 deletions examples/postgresql-wale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ $ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update

$ helm install my-release bitnami/postgresql \
--namespace postgres-test \
--namespace postgres-test --create-namespace \
--set image.repository=ghcr.io/kanisterio/postgresql \
--set image.tag=0.74.0 \
--set postgresqlPassword=postgres-12345 \
Expand All @@ -41,7 +41,7 @@ In case, if you don't have `Kanister` installed already, you can use following c
Add Kanister Helm repository and install Kanister operator
```bash
$ helm repo add kanister https://charts.kanister.io
$ helm install --name kanister --namespace kasten-io kanister/kanister-operator --set image.tag=0.74.0
$ helm install kanister --namespace kanister --create-namespace kanister/kanister-operator --set image.tag=0.74.0
```

## Integrating with Kanister
Expand Down Expand Up @@ -71,7 +71,7 @@ can be shared between Kanister-enabled application instances.
Create Blueprint in the same namespace as the controller

```bash
$ kubectl create -f ./postgresql-blueprint.yaml -n kasten-io
$ kubectl create -f ./postgresql-blueprint.yaml -n kanister
```

### Create a Base Backup
Expand All @@ -90,7 +90,7 @@ apiVersion: cr.kanister.io/v1alpha1
kind: ActionSet
metadata:
name: pg-base-backup
namespace: kasten-io
namespace: kanister
spec:
actions:
- name: backup
Expand All @@ -111,7 +111,7 @@ spec:
EOF

# View the status of the actionset
$ kubectl --namespace kasten-io describe actionset pg-base-backup
$ kubectl --namespace kanister describe actionset pg-base-backup
```


Expand Down Expand Up @@ -224,14 +224,14 @@ To restore the missing data, you should use the backup that you created before.
Let's use PostgreSQL Point-In-Time Recovery to recover data till perticular time

```bash
$ kanctl --namespace kasten-io create actionset --action restore --from pg-base-backup --options pitr=2019-09-16T14:41:00Z
$ kanctl --namespace kanister create actionset --action restore --from pg-base-backup --options pitr=2019-09-16T14:41:00Z
actionset restore-pg-base-backup-d7g7w created

## NOTE: pitr argument to the command is optional. If you want to restore data till the latest consistent state, you can skip '--options pitr' option
# e.g $ kanctl --namespace kasten-io create actionset --action restore --from pg-base-backup
# e.g $ kanctl --namespace kanister create actionset --action restore --from pg-base-backup

## Check status
$ kubectl --namespace kasten-io describe actionset restore-pg-base-backup-d7g7w
$ kubectl --namespace kanister describe actionset restore-pg-base-backup-d7g7w
```

Once the ActionSet status is set to "complete", you can see that the data has been successfully restored to PostgreSQL
Expand Down Expand Up @@ -267,13 +267,13 @@ test=# select * from company;
If you run into any issues with the above commands, you can check the logs of the controller using:

```bash
$ kubectl --namespace kasten-io logs -l app=kanister-operator
$ kubectl --namespace kanister logs -l app=kanister-operator
```

you can also check events of the actionset

```bash
$ kubectl describe actionset restore-backup-md6gb-d7g7w -n kasten-io
$ kubectl describe actionset restore-backup-md6gb-d7g7w -n kanister
```

## Cleanup
Expand All @@ -293,7 +293,7 @@ To completely remove the release include the `--purge` flag.
Remove Blueprint and Profile CR

```bash
$ kubectl delete blueprints.cr.kanister.io postgresql-blueprint -n kasten-io
$ kubectl delete blueprints.cr.kanister.io postgresql-blueprint -n kanister

$ kubectl get profiles.cr.kanister.io -n postgres-test
NAME AGE
Expand Down
9 changes: 1 addition & 8 deletions examples/postgresql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,8 @@ To install the chart with the release name `my-release`:
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update

# If you are using helm v3
$ kubectl create ns postgres-test
$ helm install my-release --namespace postgres-test bitnami/postgresql

# If you are using helm v2
$ helm install --name my-release --namespace postgres-test bitnami/postgresql
```

The command deploys PostgreSQL on the Kubernetes cluster in the default configuration.
Expand All @@ -38,7 +34,7 @@ In case, if you don't have `Kanister` installed already, you can use following c
Add Kanister Helm repository and install Kanister operator
```bash
$ helm repo add kanister https://charts.kanister.io
$ helm install --name kanister --namespace kanister kanister/kanister-operator --set image.tag=0.74.0
$ helm install kanister --namespace kanister --create-namespace kanister/kanister-operator --set image.tag=0.74.0
```

## Integrating with Kanister
Expand Down Expand Up @@ -263,10 +259,7 @@ $ kubectl describe actionset <actionset-name> -n kanister
To uninstall/delete the `my-release` deployment:

```bash
# If you are using helm v2
$ helm delete --purge my-release

# If you are using helm v3
$ helm delete my-release -n postgres-test
```

Expand Down
Loading

0 comments on commit 60ff903

Please sign in to comment.