-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #115 from vshn/feature/webhook_delprot
Document new deletionProtection feature
- Loading branch information
Showing
13 changed files
with
345 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // tag::common[] | ||
| [IMPORTANT] | ||
| .Non-reversible operation | ||
| ==== | ||
| If you delete the instance from the cluster, it will be deleted together with all of its data and backups! | ||
| ==== | ||
| // end::common[] |
144 changes: 144 additions & 0 deletions
144
docs/modules/ROOT/pages/references/deletion-protection.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| = Instance Deletion Protection | ||
|
|
||
| // tag::common[] | ||
| [IMPORTANT] | ||
| ==== | ||
| The Deletion Protection feature is enabled by default and ensures your instance is not deleted by accident. | ||
| ==== | ||
|
|
||
| == Configuration | ||
|
|
||
| Deletion protection can be enabled or disabled using the following configuration: | ||
| // end::common[] | ||
|
|
||
| // tag::keycloak[] | ||
| .Example of a Keycloak instance with deletion protection on. Update the namespace! | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: vshn.appcat.vshn.io/v1 | ||
| kind: VSHNKeycloak | ||
| metadata: | ||
| name: keycloak-app1-prod | ||
| namespace: <your-namespace> | ||
| spec: | ||
| parameters: | ||
| security: | ||
| deletionProtection: true # <1> | ||
| service: | ||
| version: "23" | ||
| postgreSQLParameters: {} | ||
| size: | ||
| plan: standard-2 | ||
| writeConnectionSecretToRef: | ||
| name: keycloak-creds | ||
| ---- | ||
| <1> Enable or disable instance deletion protection. | ||
| // end::keycloak[] | ||
|
|
||
| // tag::mariadb[] | ||
| .Example of a MariaDB instance with deletion protection on. Update the namespace! | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: vshn.appcat.vshn.io/v1 | ||
| kind: VSHNMariaDB | ||
| metadata: | ||
| name: mariadb-app1-prod | ||
| namespace: <your-namespace> | ||
| spec: | ||
| parameters: | ||
| security: | ||
| deletionProtection: true # <1> | ||
| service: | ||
| version: "11.2" | ||
| size: | ||
| plan: standard-2 | ||
| writeConnectionSecretToRef: | ||
| name: mariadb-creds | ||
| ---- | ||
| <1> Enable or disable instance deletion protection. | ||
| // end::mariadb[] | ||
|
|
||
| // tag::nextcloud[] | ||
| .Example of a Nextcloud instance with deletion protection on. Update the namespace! | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: vshn.appcat.vshn.io/v1 | ||
| kind: VSHNNextcloud | ||
| metadata: | ||
| name: nextcloud-app1-prod | ||
| namespace: <your-namespace> | ||
| spec: | ||
| parameters: | ||
| security: | ||
| deletionProtection: true # <1> | ||
| service: | ||
| fqdn: my-nextcloud.example.com | ||
| version: "29" | ||
| useExternalPostgreSQL: true | ||
| postgreSQLParameters: {} | ||
| size: | ||
| plan: standard-2 | ||
| writeConnectionSecretToRef: | ||
| name: nextcloud-creds | ||
| ---- | ||
| <1> Enable or disable instance deletion protection. | ||
| // end::nextcloud[] | ||
|
|
||
| // tag::postgresql[] | ||
| .Example of a PostgreSQL instance with deletion protection on. Update the namespace! | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: vshn.appcat.vshn.io/v1 | ||
| kind: VSHNPostgreSQL | ||
| metadata: | ||
| name: pgsql-app1 | ||
| namespace: <your-namespace> | ||
| spec: | ||
| parameters: | ||
| security: | ||
| deletionProtection: true # <1> | ||
| backup: | ||
| deletionProtection: true <2> | ||
| deletionRetention: 10 <2> | ||
| schedule: '0 22 * * *' | ||
| service: | ||
| majorVersion: "15" | ||
| pgSettings: | ||
| timezone: Europe/Zurich | ||
| size: | ||
| cpu: "600m" | ||
| memory: "3500Mi" | ||
| disk: "80Gi" | ||
| writeConnectionSecretToRef: | ||
| name: postgres-creds | ||
| ---- | ||
| <1> Enable or disable instance deletion protection. | ||
| <2> This is now deprecated and doesn't have any effect. Upon deletion of the instance, the backups are deleted as well. | ||
| // end::postgresql[] | ||
|
|
||
| // tag::redis[] | ||
| .Example of a Redis instance with deletion protection on. Update the namespace! | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: vshn.appcat.vshn.io/v1 | ||
| kind: VSHNRedis | ||
| metadata: | ||
| name: redis-app1 | ||
| namespace: <your-namespace> | ||
| spec: | ||
| parameters: | ||
| security: | ||
| deletionProtection: true # <1> | ||
| backup: | ||
| schedule: '0 22 * * *' | ||
| service: | ||
| version: "7.0" | ||
| redisSettings: | | ||
| activedefrag yes | ||
| size: | ||
| plan: standard-2 | ||
| writeConnectionSecretToRef: | ||
| name: redis-creds | ||
| ---- | ||
| <1> Enable or disable instance deletion protection. | ||
| // end::redis[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
docs/modules/ROOT/pages/vshn-managed/keycloak/deletion-protection.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| = Deletion Protection | ||
|
|
||
| include::page$references/deletion-protection.adoc[tag=common] | ||
|
|
||
| include::page$references/deletion-protection.adoc[tag=keycloak] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
docs/modules/ROOT/pages/vshn-managed/mariadb/deletion-protection.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| = Deletion Protection | ||
|
|
||
| include::page$references/deletion-protection.adoc[tag=common] | ||
|
|
||
| include::page$references/deletion-protection.adoc[tag=mariadb] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 5 additions & 0 deletions
5
docs/modules/ROOT/pages/vshn-managed/nextcloud/deletion-protection.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| = Deletion Protection | ||
|
|
||
| include::page$references/deletion-protection.adoc[tag=common] | ||
|
|
||
| include::page$references/deletion-protection.adoc[tag=nextcloud] |
Oops, something went wrong.