diff --git a/docs/addons/elasticsearch/README.md b/docs/addons/elasticsearch/README.md index 9534a648..ff540af3 100644 --- a/docs/addons/elasticsearch/README.md +++ b/docs/addons/elasticsearch/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/elasticsearch/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash Elasticsearch Addon Stash 0.9.0+ supports extending its functionality through addons. Stash Elasticsearch addon enables Stash to backup and restore Elasticsearch databases. diff --git a/docs/addons/elasticsearch/kubedb/index.md b/docs/addons/elasticsearch/kubedb/index.md index 327e641b..2de56ec4 100644 --- a/docs/addons/elasticsearch/kubedb/index.md +++ b/docs/addons/elasticsearch/kubedb/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and restore Elasticsearch database deployed with KubeDB Stash 0.9.0+ supports backup and restoration of Elasticsearch clusters. This guide will show you how you can backup and restore your KubeDB deployed Elasticsearch database using Stash. diff --git a/docs/addons/elasticsearch/overview/index.md b/docs/addons/elasticsearch/overview/index.md index 850ddf62..1986a762 100644 --- a/docs/addons/elasticsearch/overview/index.md +++ b/docs/addons/elasticsearch/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backup & Restore Elasticsearch Database Stash 0.9.0+ supports backup and restore operation of many databases. This guide will give you an overview of how Elasticsearch database backup and restore process works in Stash. diff --git a/docs/addons/etcd/README.md b/docs/addons/etcd/README.md index a9d8f9e1..8c6cfe8c 100644 --- a/docs/addons/etcd/README.md +++ b/docs/addons/etcd/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/etcd/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash Etcd Addon Stash `{{< param "info.version" >}}` supports extending its functionality through its addons. Stash Etcd addon enables Stash to backup and restore Etcd databases. diff --git a/docs/addons/etcd/basic-auth/index.md b/docs/addons/etcd/basic-auth/index.md index 1f347ccd..e69c9616 100644 --- a/docs/addons/etcd/basic-auth/index.md +++ b/docs/addons/etcd/basic-auth/index.md @@ -208,7 +208,7 @@ In this section, we are going to prepare the necessary resources (e.g., database ### Ensure Etcd Addon -When you install Stash Enterprise edition, it will automatically install all the official addons. Make sure that Etcd addon has been installed properly using the following command. +When you install Stash, it will automatically install all the official addons. Make sure that Etcd addon has been installed properly using the following command. ```bash ❯ kubectl get tasks.stash.appscode.com | grep etcd diff --git a/docs/addons/etcd/overview/index.md b/docs/addons/etcd/overview/index.md index 36f9041e..684f3006 100644 --- a/docs/addons/etcd/overview/index.md +++ b/docs/addons/etcd/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backups & Restores Etcd Database Stash `{{< param "info.version" >}}` supports backup and restore operation of many databases. This guide will give you an overview of how Etcd database backup and restore process works in Stash. diff --git a/docs/addons/etcd/tls/index.md b/docs/addons/etcd/tls/index.md index d3483289..e0e13abf 100644 --- a/docs/addons/etcd/tls/index.md +++ b/docs/addons/etcd/tls/index.md @@ -246,7 +246,7 @@ In this section, we are going to prepare the necessary resources (e.g., connecti ### Ensure Etcd Addon -When you install Stash Enterprise edition, it will automatically install all the official addons. Make sure that Etcd addon has been installed properly using the following command. +When you install Stash, it will automatically install all the official addons. Make sure that Etcd addon has been installed properly using the following command. ```bash ❯ kubectl get tasks.stash.appscode.com | grep etcd diff --git a/docs/addons/kubedump/README.md b/docs/addons/kubedump/README.md index c24e4b72..04bacebf 100644 --- a/docs/addons/kubedump/README.md +++ b/docs/addons/kubedump/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/kubedump/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash KubeDump Backup Addon Stash `{{< param "info.version" >}}` supports extending its functionality through addons. Stash KubeDump backup addon enables Stash to backup and restore Kubernetes manifests. You can backup the manifest of your entire cluster, a particular namespace, or a particular application. diff --git a/docs/addons/kubedump/overview/index.md b/docs/addons/kubedump/overview/index.md index eed3bbbf..a9e15461 100644 --- a/docs/addons/kubedump/overview/index.md +++ b/docs/addons/kubedump/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backups Kubernetes Resources Stash `{{< param "info.version" >}}` supports taking backup of Kubernetes resource YAMLs. You can backup the YAML definition of the resources of entire cluster, a particular namespaces, or only an application etc. In this guide, we are going to show you how Kubernetes resource backup works in Stash. diff --git a/docs/addons/mariadb/README.md b/docs/addons/mariadb/README.md index ca774a39..a2686dc1 100644 --- a/docs/addons/mariadb/README.md +++ b/docs/addons/mariadb/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/mariadb/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash MariaDB Addon Stash 0.9.0+ supports extending its functionality through addons. Stash MariaDB addon enables Stash to backup and restore MariaDB databases. diff --git a/docs/addons/mariadb/overview/index.md b/docs/addons/mariadb/overview/index.md index 5350b24d..3d91be48 100644 --- a/docs/addons/mariadb/overview/index.md +++ b/docs/addons/mariadb/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backups & Restores MariaDB Database Stash 0.9.0+ supports backup and restore operation of many databases. This guide will give you an overview of how MariaDB database backup and restore process works in Stash. diff --git a/docs/addons/mongodb/README.md b/docs/addons/mongodb/README.md index 8a38ba11..e8f14908 100644 --- a/docs/addons/mongodb/README.md +++ b/docs/addons/mongodb/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/mongodb/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash MongoDB Addon Stash 0.9.0+ supports extending its functionality through addons. Stash MongoDB addon enables Stash to backup and restore MongoDB databases. diff --git a/docs/addons/mongodb/overview/index.md b/docs/addons/mongodb/overview/index.md index 31590aed..822bc8ab 100644 --- a/docs/addons/mongodb/overview/index.md +++ b/docs/addons/mongodb/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backup & Restore MongoDB Database Stash 0.9.0+ supports backup and restore operation of many databases. This guide will give you an overview of how MongoDB database backup and restore process works in Stash. diff --git a/docs/addons/mongodb/replicaset/index.md b/docs/addons/mongodb/replicaset/index.md index 583596d1..474d49b6 100644 --- a/docs/addons/mongodb/replicaset/index.md +++ b/docs/addons/mongodb/replicaset/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and Restore MongoDB ReplicaSet Clusters using Stash Stash supports taking [backup and restores MongoDB ReplicaSet clusters in "idiomatic" way](https://docs.mongodb.com/manual/tutorial/restore-replica-set-from-backup/). This guide will show you how you can backup and restore your MongoDB ReplicaSet clusters with Stash. diff --git a/docs/addons/mongodb/sharding/index.md b/docs/addons/mongodb/sharding/index.md index e5c1783a..e89ab2cd 100644 --- a/docs/addons/mongodb/sharding/index.md +++ b/docs/addons/mongodb/sharding/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and Restore MongoDB Sharded Clusters using Stash Stash 0.9.0+ supports taking [backup](https://docs.mongodb.com/manual/tutorial/backup-sharded-cluster-with-database-dumps/) and [restores](https://docs.mongodb.com/manual/tutorial/restore-sharded-cluster/) MongoDB Sharded clusters in ["idiomatic" way](https://docs.mongodb.com/manual/administration/backup-sharded-clusters/). This guide will show you how you can backup and restore your MongoDB Sharded clusters with Stash. diff --git a/docs/addons/mongodb/standalone/index.md b/docs/addons/mongodb/standalone/index.md index 36dafe1a..4fd621ec 100644 --- a/docs/addons/mongodb/standalone/index.md +++ b/docs/addons/mongodb/standalone/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and Restore MongoDB database using Stash Stash 0.9.0+ supports backup and restoration of MongoDB databases. This guide will show you how you can backup and restore your MongoDB database with Stash. diff --git a/docs/addons/mysql/README.md b/docs/addons/mysql/README.md index f733449f..8f912afb 100644 --- a/docs/addons/mysql/README.md +++ b/docs/addons/mysql/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/mysql/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash MySQL Addon Stash 0.9.0+ supports extending its functionality through addons. Stash MySQL addon enables Stash to backup and restore MySQL databases. diff --git a/docs/addons/mysql/overview/index.md b/docs/addons/mysql/overview/index.md index 2fc99c4a..54a010da 100644 --- a/docs/addons/mysql/overview/index.md +++ b/docs/addons/mysql/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backup & Restore MySQL Database Stash 0.9.0+ supports backup and restore operation of many databases. This guide will give you an overview of how MySQL database backup and restore process works in Stash. diff --git a/docs/addons/nats/README.md b/docs/addons/nats/README.md index 71c89913..6adb1f0b 100644 --- a/docs/addons/nats/README.md +++ b/docs/addons/nats/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/nats/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash NATS Addon Stash `{{< param "info.version" >}}` supports extending its functionality through addons. Stash NATS addon enables Stash to backup and restore NATS streams. diff --git a/docs/addons/nats/overview/index.md b/docs/addons/nats/overview/index.md index 96d5a7e1..bfc62191 100644 --- a/docs/addons/nats/overview/index.md +++ b/docs/addons/nats/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backups & Restores NATS Streams Stash `{{< param "info.version" >}}` supports backup and restore operation of NATS streams. This guide will give you an overview of how NATS stream backup and restore process works in Stash. diff --git a/docs/addons/percona-xtradb/README.md b/docs/addons/percona-xtradb/README.md index fc27ef15..1043cb24 100644 --- a/docs/addons/percona-xtradb/README.md +++ b/docs/addons/percona-xtradb/README.md @@ -15,8 +15,6 @@ aliases: - /products/stash/{{ .version }}/addons/percona-xtradb/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash Percona XtraDB Addon Stash 0.9.0+ supports extending its functionality through addons. Stash Percona XtraDB addon enables Stash to backup and restore Percona XtraDB databases. diff --git a/docs/addons/percona-xtradb/cluster/index.md b/docs/addons/percona-xtradb/cluster/index.md index e8b52bee..51e954db 100644 --- a/docs/addons/percona-xtradb/cluster/index.md +++ b/docs/addons/percona-xtradb/cluster/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and Restore Percona XtraDB Cluster using Stash Stash 0.9.0+ supports backup and restoration of Percona XtraDB cluster databases. This guide will show you how you can backup and restore your Percona XtraDB cluster with Stash. diff --git a/docs/addons/percona-xtradb/overview/index.md b/docs/addons/percona-xtradb/overview/index.md index e42522a7..c766aa2d 100644 --- a/docs/addons/percona-xtradb/overview/index.md +++ b/docs/addons/percona-xtradb/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backup & Restore Percona XtraDB Database Stash 0.9.0+ supports backup and restore operation of many databases. This guide will give you an overview of how Percona XtraDB database backup and restore process works in Stash. diff --git a/docs/addons/percona-xtradb/standalone/index.md b/docs/addons/percona-xtradb/standalone/index.md index 90ac8573..70a792f1 100644 --- a/docs/addons/percona-xtradb/standalone/index.md +++ b/docs/addons/percona-xtradb/standalone/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and Restore Percona XtraDB database using Stash Stash 0.9.0+ supports backup and restoration of Percona XtraDB databases. This guide will show you how you can backup and restore your Percona XtraDB database with Stash. diff --git a/docs/addons/postgres/README.md b/docs/addons/postgres/README.md index 399a1a03..19affdc4 100644 --- a/docs/addons/postgres/README.md +++ b/docs/addons/postgres/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/postgres/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash PostgreSQL Addon Stash 0.9.0+ supports extending its functionality through addons. Stash PostgreSQL addon enables Stash to backup and restore PostgreSQL databases. diff --git a/docs/addons/postgres/auto-backup/index.md b/docs/addons/postgres/auto-backup/index.md index 291fc255..08fa3a23 100644 --- a/docs/addons/postgres/auto-backup/index.md +++ b/docs/addons/postgres/auto-backup/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup PostgreSQL using Stash Auto-Backup Stash can be configured to automatically backup any PostgreSQL database in your cluster. Stash enables cluster administrators to deploy backup blueprints ahead of time so that the database owners can easily backup their database with just a few annotations. @@ -51,7 +49,7 @@ namespace/demo-2 created namespace/demo-3 created ``` -When you install Stash Enterprise edition, it will automatically installs the official database addons. Make sure the addons for PostgreSQL was installed properly using the following command. +When you install Stash, it will automatically installs the official database addons. Make sure the addons for PostgreSQL was installed properly using the following command. ```bash ❯ kubectl get tasks.stash.appscode.com | grep postgres diff --git a/docs/addons/postgres/overview/index.md b/docs/addons/postgres/overview/index.md index e3c426e8..242e93e6 100644 --- a/docs/addons/postgres/overview/index.md +++ b/docs/addons/postgres/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backup & Restore PostgreSQL Database Stash 0.9.0+ supports backup and restore operation of many databases. This guide will give you an overview of how PostgreSQL database backup and restore process works in Stash. diff --git a/docs/addons/postgres/standalone/index.md b/docs/addons/postgres/standalone/index.md index 96e38336..e6c2e1d9 100644 --- a/docs/addons/postgres/standalone/index.md +++ b/docs/addons/postgres/standalone/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup and Restore PostgreSQL database using Stash Stash 0.9.0+ supports backup and restoration of PostgreSQL databases. This guide will show you how you can backup and restore your PostgreSQL database with Stash. diff --git a/docs/addons/redis/README.md b/docs/addons/redis/README.md index c84a4d12..7f67f219 100644 --- a/docs/addons/redis/README.md +++ b/docs/addons/redis/README.md @@ -15,8 +15,6 @@ aliases: - /docs/{{ .version }}/addons/redis/README/ --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Stash Redis Addon Stash `{{< param "info.version" >}}` supports extending its functionality through addons. Stash Redis addon enables Stash to backup and restore Redis databases. diff --git a/docs/addons/redis/overview/index.md b/docs/addons/redis/overview/index.md index 34ab4281..a13e496f 100644 --- a/docs/addons/redis/overview/index.md +++ b/docs/addons/redis/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: stash-addons --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # How Stash Backups & Restores Redis Database Stash `{{< param "info.version" >}}` supports backup and restore operation of many databases. This guide will give you an overview of how Redis database backup and restore process works in Stash. diff --git a/docs/concepts/crds/backupbatch/index.md b/docs/concepts/crds/backupbatch/index.md index c3799956..a96b98be 100644 --- a/docs/concepts/crds/backupbatch/index.md +++ b/docs/concepts/crds/backupbatch/index.md @@ -11,8 +11,6 @@ menu_name: docs_{{ .version }} section_menu_id: concepts --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # BackupBatch ## What is BackupBatch diff --git a/docs/concepts/crds/restorebatch/index.md b/docs/concepts/crds/restorebatch/index.md index 86915e0a..ca550d66 100644 --- a/docs/concepts/crds/restorebatch/index.md +++ b/docs/concepts/crds/restorebatch/index.md @@ -11,8 +11,6 @@ menu_name: docs_{{ .version }} section_menu_id: concepts --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # RestoreBatch ## What is RestoreBatch diff --git a/docs/guides/addons/overview/index.md b/docs/guides/addons/overview/index.md index 64e5d4db..90219d3b 100644 --- a/docs/guides/addons/overview/index.md +++ b/docs/guides/addons/overview/index.md @@ -38,6 +38,6 @@ A `Function` is fundamentally a container specification and `Task` specifies the ## Available Addons -The following addons are available for [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md): +The following addons are available for [Stash](/docs/setup/install/enterprise/index.md): {{< catalogtable "elasticsearch" "mariadb" "mongodb" "mysql" "percona-xtradb" "postgres" >}} diff --git a/docs/guides/auto-backup/database/index.md b/docs/guides/auto-backup/database/index.md index dcf61fb2..86ed5200 100644 --- a/docs/guides/auto-backup/database/index.md +++ b/docs/guides/auto-backup/database/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Auto Backup for Database This tutorial will give you an overview of how you can configure Stash auto-backup of the databases and the available configurable options for database auto-backup. diff --git a/docs/guides/auto-backup/overview/index.md b/docs/guides/auto-backup/overview/index.md index 4975bd2a..6b1c0b01 100644 --- a/docs/guides/auto-backup/overview/index.md +++ b/docs/guides/auto-backup/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Auto Backup with Stash Stash can be configured to automatically backup of any stateful workloads in your cluster. Stash enables cluster administrators to deploy backup blueprints ahead of time so that application owners can easily backup any types of workload with a few annotations. This allows Enterprises to stay prepared for disaster scenarios and recover from offsite secure backups in case of a disaster on public cloud and on-premises datacenters. diff --git a/docs/guides/auto-backup/pvc/index.md b/docs/guides/auto-backup/pvc/index.md index d4c2f3ef..1bdd8581 100644 --- a/docs/guides/auto-backup/pvc/index.md +++ b/docs/guides/auto-backup/pvc/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Auto Backup for PVC This tutorial will show you how to configure automatic backup for PersistentVolumeClaims. Here, we are going to backup a PVC provisioned from an NFS server using auto-backup. diff --git a/docs/guides/auto-backup/workload/index.md b/docs/guides/auto-backup/workload/index.md index c65f2526..ff05fc15 100644 --- a/docs/guides/auto-backup/workload/index.md +++ b/docs/guides/auto-backup/workload/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Auto Backup for Workloads This tutorial will show you how to configure automatic backup for Kubernetes workloads. Here, we are going to show a demo on how we can backup Deployments, StatefulSets, and DaemonSets using a common blueprint. diff --git a/docs/guides/backends/local/index.md b/docs/guides/backends/local/index.md index 816ec150..ae52cf43 100644 --- a/docs/guides/backends/local/index.md +++ b/docs/guides/backends/local/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Local Backend `Local` backend refers to a local path inside `stash` sidecar container. Any Kubernetes supported [persistent volume](https://kubernetes.io/docs/concepts/storage/volumes/) such as [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/volumes/#persistentvolumeclaim), [HostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath), [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) (for testing only), [NFS](https://kubernetes.io/docs/concepts/storage/volumes/#nfs), [gcePersistentDisk](https://kubernetes.io/docs/concepts/storage/volumes/#gcepersistentdisk) etc. can be used as local backend. diff --git a/docs/guides/batch-backup/overview/index.md b/docs/guides/batch-backup/overview/index.md index 3aaf6bdf..ef346e87 100644 --- a/docs/guides/batch-backup/overview/index.md +++ b/docs/guides/batch-backup/overview/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Batch Backup and Restore Overview Sometimes, an application may consist of multiple co-related components. For example, to deploy a WordPress, you will need a Deployment for the WordPress and another Deployment for the database. Now, it is sensible to want to backup or restore both of the deployments using a single configuration as they are parts of the same application. diff --git a/docs/guides/batch-backup/wordpress-backup/index.md b/docs/guides/batch-backup/wordpress-backup/index.md index 6eb3a493..0da5b94e 100644 --- a/docs/guides/batch-backup/wordpress-backup/index.md +++ b/docs/guides/batch-backup/wordpress-backup/index.md @@ -12,8 +12,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Backup & Restore a WordPress Site Using Batch Backup This tutorial will demonstrate how to use Stash to take backup of an application with multiple co-related components. Here, we are going to take backup of a [WordPress Site](https://kubernetes.io/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/). diff --git a/docs/guides/hooks/batch-backup/index.md b/docs/guides/hooks/batch-backup/index.md index 3c615975..36c40f67 100644 --- a/docs/guides/hooks/batch-backup/index.md +++ b/docs/guides/hooks/batch-backup/index.md @@ -11,8 +11,6 @@ menu_name: docs_{{ .version }} section_menu_id: guides --- -{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise/index.md) to try this feature." >}} - # Hooks in Batch Backup Stash 0.9.0+ supports taking backup of multiple co-related stateful workloads using a single configuration named `BackupBatch`. Combining with backup hooks, this can be very powerful. For example, you can prepare your application stack before backup to ensure backup integrity or you can send a notification to a webhook (i.e. in a Slack channel via slack incoming webhook) before or after the backup of all the resources of your application stack. diff --git a/docs/guides/monitoring/grafana/index.md b/docs/guides/monitoring/grafana/index.md index b86d3d61..7471d9e6 100644 --- a/docs/guides/monitoring/grafana/index.md +++ b/docs/guides/monitoring/grafana/index.md @@ -25,7 +25,7 @@ We provide a pre-built Grafana dashboard to our **Stash Enterprise** users. In t ## Before You Begin - At first, you need to setup a Prometheus monitoring stack in your cluster. Please, follow the [Prometheus Operator](/docs/guides/monitoring/prom-operator/index.md) guide to setup your monitoring stack if you haven't done already. -- Then, install Stash Enterprise edition with monitoring enabled. Please, follow [this guide](/docs/guides/monitoring/prom-operator/index.md#enable-monitoring-in-stash) if you haven't done already. +- Then, install Stash with monitoring enabled. Please, follow [this guide](/docs/guides/monitoring/prom-operator/index.md#enable-monitoring-in-stash) if you haven't done already. - You must have `stash_dashboard.json` file. Please, contact us to get the dashboard JSON file. ## Install Panopticon @@ -36,7 +36,7 @@ Stash Grafana dashboard depends on our another product called [Panopticon](https Like other AppsCode products, [Panopticon](https://blog.byte.builders/post/introducing-panopticon/) also need a license to run. You can grab a 30 days trial license for Panopticon from [here](https://license-issuer.appscode.com/?p=panopticon-enterprise). ->**If you already have an enterprise license for KubeDB or Stash, you do not need to issue a new license for Panopticon. Your existing KubeDB or Stash license will work with Panopticon.** +>**If you already have a license for KubeDB or Stash, you do not need to issue a new license for Panopticon. Your existing KubeDB or Stash license will work with Panopticon.** **Install Panopticon:** diff --git a/docs/guides/monitoring/overview/index.md b/docs/guides/monitoring/overview/index.md index f9efad57..23287d71 100644 --- a/docs/guides/monitoring/overview/index.md +++ b/docs/guides/monitoring/overview/index.md @@ -39,7 +39,7 @@ Stash exports metrics for the backup process, restore process, repository status ### Backup Metrics -This section lists the metrics available for Stash. Some of the metrics are only available for Stash Enterprise edition. +This section lists the metrics available for Stash. **Backup Session Metrics:** @@ -240,28 +240,28 @@ If you haven't installed Stash yet, run the following command to enable Promethe **Helm 3:** ```bash -$ helm install stash appscode/stash -n kube-system \ ---version {{< param "info.version" >}} \ ---set features.enterprise=true \ ---set stash-enterprise.monitoring.agent=prometheus.io/operator \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise. monitoring.operator=true \ ---set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack \ ---set-file global.license=/path/to/license-file.txt +$ helm install stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set stash-enterprise.monitoring.agent=prometheus.io/operator \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise. monitoring.operator=true \ + --set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack \ + --set-file global.license=/path/to/license-file.txt ``` **YAML (with Helm 3):** ```bash -$ helm install stash appscode/stash -n kube-system \ ---no-hooks \ ---version {{< param "info.version" >}} \ ---set features.enterprise=true \ ---set stash-enterprise.monitoring.agent=prometheus.io/operator \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true \ ---set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack \ ---set-file global.license=/path/to/license-file.txt | kubectl apply -f - +$ helm template stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --no-hooks \ + --set stash-enterprise.monitoring.agent=prometheus.io/operator \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true \ + --set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack \ + --set-file global.license=/path/to/license-file.txt | kubectl apply -f - ``` @@ -274,24 +274,28 @@ If you have installed Stash already in your cluster but didn't enable monitoring **Helm 3:** ```bash -$ helm upgrade stash appscode/stash -n kube-system \ ---reuse-values \ ---set stash-enterprise.monitoring.agent=prometheus.io/operator \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true \ ---set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack +$ helm upgrade -i stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --reuse-values \ + --set stash-enterprise.monitoring.agent=prometheus.io/operator \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true \ + --set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack ``` **YAML (with Helm 3):** ```bash -$ helm upgrade stash appscode/stash -n kube-system \ ---no-hooks \ ---reuse-values \ ---set stash-enterprise.monitoring.agent=prometheus.io/operator \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true \ ---set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack | kubectl apply -f - +$ helm template stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --no-hooks \ + --reuse-values \ + --set stash-enterprise.monitoring.agent=prometheus.io/operator \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true \ + --set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack | kubectl apply -f - ``` diff --git a/docs/guides/monitoring/prom-builtin/index.md b/docs/guides/monitoring/prom-builtin/index.md index 3a32c2b1..83021b2e 100644 --- a/docs/guides/monitoring/prom-builtin/index.md +++ b/docs/guides/monitoring/prom-builtin/index.md @@ -45,13 +45,13 @@ Here, we are going to enable monitoring for both backup metrics and operator met If you haven't installed Stash yet, run the following command to enable Prometheus monitoring during installation ```bash -$ helm install stash appscode/stash -n kube-system \ ---version {{< param "info.version" >}} \ ---set features.enterprise=true \ ---set stash-enterprise.monitoring.agent=prometheus.io/builtin \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true \ ---set-file global.license=/path/to/license-file.txt +$ helm install stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set stash-enterprise.monitoring.agent=prometheus.io/builtin \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true \ + --set-file global.license=/path/to/license-file.txt ``` @@ -62,11 +62,13 @@ $ helm install stash appscode/stash -n kube-system \ If you have installed Stash already in your cluster but didn't enable monitoring during installation, you can use `helm upgrade` command to enable monitoring in the existing installation. ```bash -$ helm upgrade stash appscode/stash -n kube-system \ ---reuse-values \ ---set stash-enterprise.monitoring.agent=prometheus.io/builtin \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true +$ helm upgrade -i stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --reuse-values \ + --set stash-enterprise.monitoring.agent=prometheus.io/builtin \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true ``` diff --git a/docs/guides/monitoring/prom-operator/index.md b/docs/guides/monitoring/prom-operator/index.md index ed34bb6d..b8aaf497 100644 --- a/docs/guides/monitoring/prom-operator/index.md +++ b/docs/guides/monitoring/prom-operator/index.md @@ -177,14 +177,14 @@ Here, we are going to enable monitoring for both backup metrics and operator met If you haven't installed Stash yet, run the following command to enable Prometheus monitoring during installation ```bash -$ helm install stash appscode/stash -n kube-system \ ---version {{< param "info.version" >}} \ ---set features.enterprise=true \ ---set stash-enterprise.monitoring.agent=prometheus.io/operator \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true \ ---set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack \ ---set-file global.license=/path/to/license-file.txt +$ helm install stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set stash-enterprise.monitoring.agent=prometheus.io/operator \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true \ + --set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack \ + --set-file global.license=/path/to/license-file.txt ``` @@ -195,12 +195,14 @@ $ helm install stash appscode/stash -n kube-system \ If you have installed Stash already in your cluster but didn't enable monitoring during installation, you can use `helm upgrade` command to enable monitoring in the existing installation. ```bash -$ helm upgrade stash appscode/stash -n kube-system \ ---reuse-values \ ---set stash-enterprise.monitoring.agent=prometheus.io/operator \ ---set stash-enterprise.monitoring.backup=true \ ---set stash-enterprise.monitoring.operator=true \ ---set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack +$ helm upgrade -i stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --reuse-values \ + --set stash-enterprise.monitoring.agent=prometheus.io/operator \ + --set stash-enterprise.monitoring.backup=true \ + --set stash-enterprise.monitoring.operator=true \ + --set stash-enterprise.monitoring.serviceMonitor.labels.release=prometheus-stack ``` diff --git a/docs/guides/platforms/eks-irsa/index.md b/docs/guides/platforms/eks-irsa/index.md index 3d763007..3c18aca2 100644 --- a/docs/guides/platforms/eks-irsa/index.md +++ b/docs/guides/platforms/eks-irsa/index.md @@ -165,7 +165,7 @@ In this section, we are going to prepare the necessary resources (i.e. database ### Verify Stash MariaDB Addon Installed -When you install the Stash Enterprise edition, it automatically installs all the official database addons. Verify that it has installed the MariaDB addons using the following command. +When you install the Stash, it automatically installs all the official database addons. Verify that it has installed the MariaDB addons using the following command. ```bash $ kubectl get tasks.stash.appscode.com | grep mariadb diff --git a/docs/guides/platforms/eks-kube2iam/index.md b/docs/guides/platforms/eks-kube2iam/index.md index c4005461..114b538a 100644 --- a/docs/guides/platforms/eks-kube2iam/index.md +++ b/docs/guides/platforms/eks-kube2iam/index.md @@ -296,7 +296,7 @@ In this section, we are going to prepare the necessary resources (i.e. database ### Verify Stash MariaDB Addon Installed -When you install the Stash Enterprise edition, it automatically installs all the official database addons. Verify that it has installed the MariaDB addons using the following command. +When you install the Stash, it automatically installs all the official database addons. Verify that it has installed the MariaDB addons using the following command. ```bash $ kubectl get tasks.stash.appscode.com | grep mariadb @@ -706,12 +706,11 @@ Here, `False` in the `SUSPEND` column means the CronJob is no longer suspended a When you list Snapshots using `kubectl get snapshot` command, Stash operator itself read the Snapshots directly from the backend. So, the operator needs permission to access the bucket. Therefore, stash operator pod should be annotated with the IAM Role. Run the following command to annotate the Stash operator pod using Helm, ```bash - helm upgrade stash appscode/stash \ - --version v2022.06.27 \ - --namespace stash --create-namespace \ - --set features.enterprise=true \ - --set-file global.license=/home/sayem/Downloads/stash.txt \ - --set stash-enterprise.podAnnotations.'iam\.amazonaws\.com/role'=arn:aws:iam::452618475015:role/bucket-accessor +$ helm upgrade -i stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set-file global.license=/home/sayem/Downloads/stash.txt \ + --set stash-enterprise.podAnnotations.'iam\.amazonaws\.com/role'=arn:aws:iam::452618475015:role/bucket-accessor ``` ### Cleanup diff --git a/docs/guides/platforms/gke/index.md b/docs/guides/platforms/gke/index.md index 9c936d52..8fa70cd2 100644 --- a/docs/guides/platforms/gke/index.md +++ b/docs/guides/platforms/gke/index.md @@ -191,7 +191,7 @@ In this section, we are going to prepare the necessary resources (i.e. database ### Verify Stash MariaDB Addon Installed -When you install the Stash Enterprise edition, it automatically installs all the official database addons. Verify that it has installed the MariaDB addons using the following command. +When you install the Stash, it automatically installs all the official database addons. Verify that it has installed the MariaDB addons using the following command. ```bash $ kubectl get tasks.stash.appscode.com | grep mariadb diff --git a/docs/guides/security/psp/index.md b/docs/guides/security/psp/index.md index 18cd8ccb..3b613234 100644 --- a/docs/guides/security/psp/index.md +++ b/docs/guides/security/psp/index.md @@ -18,7 +18,7 @@ Stash comes with built-in support for [Pod Security Policy (PSP)](https://kubern ### Baseline PSP - By default Stash uses minimally restrictive [baseline](https://kubernetes.io/docs/concepts/security/pod-security-standards/#baseline-default) PSP. Both Stash Community Edition and Stash Enterprise Edition uses baseline PSP. Here, is the YAML of the baseline PSP that uses by Stash operator. + By default Stash uses minimally restrictive [baseline](https://kubernetes.io/docs/concepts/security/pod-security-standards/#baseline-default) PSP. Stash uses baseline PSP. Here, is the YAML of the baseline PSP that uses by Stash operator. ```yaml # ref: https://kubernetes.io/docs/concepts/security/pod-security-standards/#policy-instantiation @@ -106,7 +106,7 @@ spec: ### Privileged PSP -If you are using an NFS server as backend with Stash Enterprise Edition, you may need to give Stash operator privileged permission. In this case, Stash will use [privileged](https://kubernetes.io/docs/concepts/security/pod-security-standards/#privileged) PSP. Here, is the YAML of privileged PSP that is used by Stash Enterprise Edition when you uses NFS server as backend, +If you are using an NFS server as backend with Stash, you may need to give Stash operator privileged permission. In this case, Stash will use [privileged](https://kubernetes.io/docs/concepts/security/pod-security-standards/#privileged) PSP. Here, is the YAML of privileged PSP that is used by Stash when you uses NFS server as backend, ```yaml apiVersion: policy/v1beta1 @@ -141,8 +141,9 @@ spec: You can use your own PodSecurityPolicy with Stash. In this case, you have to create the PSP manually and provide the PSP names during installation. You can provide the custom PSP names during installation as below, ```bash -$ helm install stash appscode/stash-community \ - -n kube-system \ - --set podSecurityPolicies[0]=abc \ - --set podSecurityPolicies[1]=xyz +$ helm install stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set podSecurityPolicies[0]=abc \ + --set podSecurityPolicies[1]=xyz ``` diff --git a/docs/setup/README.md b/docs/setup/README.md index d46eb7bc..6829c5a3 100644 --- a/docs/setup/README.md +++ b/docs/setup/README.md @@ -18,21 +18,19 @@ aliases: # Setup
- Install Community Edition - Try Enterprise Edition - Compare Editions + Install Stash

The setup section contains instructions for installing the Stash and its various components in Kubernetes. This section has been divided into the following sub-sections: - **Install Stash:** Installation instructions for Stash and its various components. - - [Community Edition](/docs/setup/install/community/index.md): Installation instructions for Stash Community Edition. - - [Enterprise Edition](/docs/setup/install/enterprise/index.md): Installation instructions for Stash Enterprise Edition. + - [Stash operator](/docs/setup/install/stash/index.md): Installation instructions for Stash operator. - [Stash kubectl Plugin](/docs/setup/install/kubectl-plugin/index.md): Installation instructions for Stash `kubectl` plugin. - [Troubleshooting](/docs/setup/install/troubleshooting/index.md): Troubleshooting guide for various installation problems. + - **Uninstall Stash:** Uninstallation instructions for Stash and its various components. - - [Community Edition](/docs/setup/uninstall/community/index.md): Uninstallation instructions for Stash Community Edition. - - [Enterprise Edition](/docs/setup/uninstall/enterprise/index.md): Uninstallation instructions for Stash Enterprise Edition. + - [Stash operator](/docs/setup/uninstall/stash/index.md): Uninstallation instructions for Stash operator. - [Stash kubectl Plugin](/docs/setup/uninstall/kubectl-plugin/index.md): Uninstallation instructions for Stash `kubectl` plugin. + - [Upgrading Stash](/docs/setup/upgrade/index.md): Instruction for updating Stash license and upgrading between various Stash versions. diff --git a/docs/setup/install/community/images/community_license_form.png b/docs/setup/install/community/images/community_license_form.png deleted file mode 100644 index 161c98e3..00000000 Binary files a/docs/setup/install/community/images/community_license_form.png and /dev/null differ diff --git a/docs/setup/install/community/index.md b/docs/setup/install/community/index.md deleted file mode 100644 index 4d48b629..00000000 --- a/docs/setup/install/community/index.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: Install Stash Community Edition -description: Installation guide for Stash Community edition -menu: - docs_{{ .version }}: - identifier: install-stash-community - name: Community Edition - parent: installation-guide - weight: 10 -product_name: stash -menu_name: docs_{{ .version }} -section_menu_id: setup ---- - -# Install Stash Community Edition - -Stash Community edition is available under [AppsCode-Community-1.0.0](https://github.com/appscode/licenses/raw/1.0.0/AppsCode-Community-1.0.0.md) license and free to use for both commercial and non-commercial purposes. It comes with all the basic backup functionalities. However, it lacks some advanced features such as [Database Backup](/docs/guides/addons/overview/index.md), [Auto-Backup](/docs/guides/auto-backup/overview/index.md), [Batch Backup](/docs/guides/batch-backup/overview/index.md), and [Local Backend](/docs/guides/backends/local/index.md) support, etc. compared to the Enterprise edition. A full features comparison between the Stash Community edition and Enterprise edition can be found [here](/docs/concepts/what-is-stash/overview/index.md). - -To use Stash Community edition, you can grab **1 year** free license from [here](https://license-issuer.appscode.com/?p=stash-community). - -## Prerequisites - -- **Kubernetes version**: Stash is compatible with any Kubernetes cluster with version `1.16` or later. -- **Extended API server**: Your cluster needs to support Kubernetes extended API server. -- **Webhook support**: Your cluster must support Kubernetes validation and mutation webhooks. -- **RBAC permissions**: Stash operator needs a few RBAC permissions on your cluster. You can find the list of the required RBAC permissions [here](/docs/guides/security/rbac/index.md). -- **Installing on GKE cluster**: To install Stash on your GKE cluster, please check the requirements [here](https://stash.run/docs/{{< param "info.version" >}}/setup/install/troubleshoting/#installing-in-gke-cluster). -- **NFS volume**: If you are willing to use NFS volume as a backend, you need to customize the Stash installation like [here](https://stash.run/docs/{{< param "info.version" >}}/setup/install/troubleshoting/#configuring-network-volume-accessor). - -## Get a License - -In this section, we are going to show you how you can get a **1 year** free license for Stash Community edition. You can get a license for your Kubernetes cluster by going through the following steps: - -- At first, go to [AppsCode License Server](https://license-issuer.appscode.com/?p=stash-community) and fill up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the `kube-system` namespace). -- Provide your name and email address. You can provide your personal or work email address. -- Then, select `Stash Community Edition` in the product field. -- Now, provide your cluster ID. You can get your cluster ID easily by running the following command: - -```bash -kubectl get ns kube-system -o=jsonpath='{.metadata.uid}' -``` - -- Then, you have to agree with the terms and conditions. We recommend reading it before checking the box. -- Now, you can submit the form. After you submit the form, the AppsCode License server will send an email to the provided email address with a link to your license file. -- Navigate to the provided link and save the license into a file. Here, we save the license to a `license.txt` file. - -Here is a screenshot of the license form. - -
- Stash Backend Overview -
Fig: Stash License Form
-
- -You can create licenses for as many clusters as you want. You can upgrade your license any time without re-installing Stash by following the upgrading guide from [here](/docs/setup/upgrade/index.md#upgrading-license). - -> Stash licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from [here](https://github.com/appscode/offline-license-server#offline-license-server). - -## Install - -Stash operator can be installed as a Helm chart or simply as Kubernetes manifests. - - -
-
- -## Using Helm 3 - -Stash can be installed via [Helm](https://helm.sh/) using the [chart](https://github.com/stashed/installer/tree/{{< param "info.installer" >}}/charts/stash) from [AppsCode Charts Repository](https://github.com/appscode/charts). To install the chart with the release name `stash`: - -```bash -$ helm repo add appscode https://charts.appscode.com/stable/ -$ helm repo update -$ helm search repo appscode/stash --version {{< param "info.version" >}} -NAME CHART VERSION APP VERSION DESCRIPTION -appscode/stash {{< param "info.version" >}} {{< param "info.version" >}} Stash by AppsCode - Backup your Kubernetes native applications - -$ helm install stash appscode/stash \ - --version {{< param "info.version" >}} \ - --namespace kube-system \ - --set features.community=true \ - --set-file global.license=/path/to/the/license.txt -``` - -To see the detailed configuration options, visit [here](https://github.com/stashed/installer/tree/{{< param "info.installer" >}}/charts/stash-community). - -
-
- -## Using YAML - -If you prefer to not use Helm, you can generate YAMLs from Stash chart and deploy using `kubectl`. Here we are going to show the prodecure using Helm 3. - -```bash -$ helm repo add appscode https://charts.appscode.com/stable/ -$ helm repo update -$ helm search repo appscode/stash --version {{< param "info.version" >}} -NAME CHART VERSION APP VERSION DESCRIPTION -appscode/stash {{< param "info.version" >}} {{< param "info.version" >}} Stash by AppsCode - Backup your Kubernetes native applications - -$ helm template stash appscode/stash \ - --version {{< param "info.version" >}} \ - --namespace kube-system \ - --set features.community=true \ - --set global.skipCleaner=true \ - --set-file global.license=/path/to/the/license.txt | kubectl apply -f - -``` - -To see the detailed configuration options, visit [here](https://github.com/stashed/installer/tree/{{< param "info.installer" >}}/charts/stash-community). - -
-
- -## Verify installation - -To check if Stash operator pods have started, run the following command: - -```bash -$ ❯ kubectl get pods --all-namespaces -l app.kubernetes.io/name=stash-community --watch -NAMESPACE NAME READY STATUS RESTARTS AGE -kube-system stash-stash-community-66b86d9647-kcncc 2/2 Running 0 2m6s -``` - -Once the operator pod is running, you can cancel the above command by typing `Ctrl+C`. - -Now, to confirm CRD groups have been registered by the operator, run the following command: - -```bash -$ kubectl get crd -l app.kubernetes.io/name=stash - -NAME CREATED AT -backupconfigurations.stash.appscode.com 2020-08-24T08:20:54Z -backupsessions.stash.appscode.com 2020-08-24T08:20:55Z -functions.stash.appscode.com 2020-08-24T08:20:55Z -recoveries.stash.appscode.com 2020-08-24T08:20:54Z -repositories.stash.appscode.com 2020-08-24T08:20:54Z -restics.stash.appscode.com 2020-08-24T08:20:54Z -restoresessions.stash.appscode.com 2020-08-24T08:20:55Z -tasks.stash.appscode.com 2020-08-24T08:20:55Z -``` - -Now, you are ready to [take your first backup](/docs/guides/README.md) using Stash. diff --git a/docs/setup/install/enterprise/images/enterprise_license_form.png b/docs/setup/install/stash/images/enterprise_license_form.png similarity index 100% rename from docs/setup/install/enterprise/images/enterprise_license_form.png rename to docs/setup/install/stash/images/enterprise_license_form.png diff --git a/docs/setup/install/enterprise/index.md b/docs/setup/install/stash/index.md similarity index 70% rename from docs/setup/install/enterprise/index.md rename to docs/setup/install/stash/index.md index 8bbef02c..74b84ff6 100644 --- a/docs/setup/install/enterprise/index.md +++ b/docs/setup/install/stash/index.md @@ -1,10 +1,10 @@ --- -title: Install Stash Enterprise Edition -description: Installation guide for Stash Enterprise edition +title: Install Stash +description: Installation guide for Stash menu: docs_{{ .version }}: identifier: install-stash-enterprise - name: Enterprise Edition + name: Stash parent: installation-guide weight: 20 product_name: stash @@ -12,11 +12,7 @@ menu_name: docs_{{ .version }} section_menu_id: setup --- -# Install Stash Enterprise Edition - -Stash Enterprise edition is the open core version of [Stash](https://github.com/stashed/stash). It comes with all the functionalities of Stash Community edition as well as some advanced features such as [Database Backup](/docs/guides/addons/overview/index.md), [Auto-Backup](/docs/guides/auto-backup/overview/index.md), [Batch Backup](/docs/guides/batch-backup/overview/index.md), and [Local Backend](/docs/guides/backends/local/index.md) support, etc. A full features comparison between Stash Enterprise Edition and community version can be found [here](/docs/concepts/what-is-stash/overview/index.md). - -If you are willing to try Stash Enterprise Edition, you can grab a **30 days trial** license from [here](https://license-issuer.appscode.com/?p=stash-enterprise). +# Install Stash ## Prerequisites @@ -27,13 +23,13 @@ If you are willing to try Stash Enterprise Edition, you can grab a **30 days tri - **Installing on GKE cluster**: To install Stash on your GKE cluster, please check the requirements [here](https://stash.run/docs/{{< param "info.version" >}}/setup/install/troubleshoting/#installing-in-gke-cluster). - **NFS volume**: If you are willing to use NFS volume as a backend, you need to customize the Stash installation like [here](https://stash.run/docs/{{< param "info.version" >}}/setup/install/troubleshoting/#configuring-network-volume-accessor). -## Get a Trial License +## Get a Free Trial License -In this section, we are going to show you how you can get a **30 days trial** license for Stash Enterprise edition. You can get a license for your Kubernetes cluster by going through the following steps: +In this section, we are going to show you how you can get a free **30 days trial** license for Stash. You can get a license for your Kubernetes cluster by going through the following steps: -- At first, go to [AppsCode License Server](https://license-issuer.appscode.com/?p=stash-enterprise) and fill up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the `kube-system` namespace). +- At first, go to [AppsCode License Server](https://appscode.com/issue-license?p=stash) and fill up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the `kube-system` namespace). - Provide your name and email address. **You must provide your work email address**. -- Then, select `Stash Enterprise Edition` in the product field. +- Then, select `Stash` in the product field. - Now, provide your cluster ID. You can get your cluster ID easily by running the following command: ```bash @@ -55,11 +51,11 @@ You can create licenses for as many clusters as you want. You can upgrade your l >Stash licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from [here](https://github.com/appscode/offline-license-server#offline-license-server). -## Get an Enterprise License +## Purchase Stash License -If you are interested in purchasing Enterprise license, please contact us via sales@appscode.com for further discussion. You can also set up a meeting via our [calendly link](https://calendly.com/appscode/intro). +If you are interested in purchasing Stash license, please contact us via sales@appscode.com for further discussion. You can also set up a meeting via our [calendly link](https://calendly.com/appscode/intro). -If you are willing to purchasing Enterprise license but need more time to test in your dev cluster, feel free to contact sales@appscode.com. We will be happy to extend your trial period. +If you are willing to purchase Stash license but need more time to test in your dev cluster, feel free to contact sales@appscode.com. We will be happy to extend your trial period. ## Install @@ -81,16 +77,9 @@ Stash operator can be installed as a Helm chart or simply as Kubernetes manifest Stash can be installed via [Helm](https://helm.sh/) using the [chart](https://github.com/stashed/installer/tree/{{< param "info.installer" >}}/charts/stash) from [AppsCode Charts Repository](https://github.com/appscode/charts). To install the chart with the release name `stash`: ```bash -$ helm repo add appscode https://charts.appscode.com/stable/ -$ helm repo update -$ helm search repo appscode/stash --version {{< param "info.version" >}} -NAME CHART VERSION APP VERSION DESCRIPTION -appscode/stash {{< param "info.version" >}} {{< param "info.version" >}} Stash by AppsCode - Backup your Kubernetes native applications - -$ helm install stash appscode/stash \ - --version {{< param "info.version" >}} \ - --namespace kube-system \ - --set features.enterprise=true \ +$ helm install stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ --set-file global.license=/path/to/the/license.txt ``` @@ -104,17 +93,10 @@ To see the detailed configuration options, visit [here](https://github.com/stash If you prefer to not use Helm, you can generate YAMLs from Stash chart and deploy using `kubectl`. Here we are going to show the prodecure using Helm 3. ```bash -$ helm repo add appscode https://charts.appscode.com/stable/ -$ helm repo update -$ helm search repo appscode/stash --version {{< param "info.version" >}} -NAME CHART VERSION APP VERSION DESCRIPTION -appscode/stash {{< param "info.version" >}} {{< param "info.version" >}} Stash by AppsCode - Backup your Kubernetes native applications - -$ helm template stash appscode/stash \ - --version {{< param "info.version" >}} \ - --namespace kube-system \ - --set features.enterprise=true \ - --set global.skipCleaner=true \ +$ helm template stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set global.skipCleaner=true \ --set-file global.license=/path/to/the/license.txt | kubectl apply -f - ``` @@ -155,7 +137,7 @@ tasks.stash.appscode.com 2020-08-24T08:20:55Z ### Verify Catalogs -Stash Enterprise edition automatically installs the necessary Addon catalogs for database backup. Verify that the Addon catalogs have been installed using the following command. +Stash automatically installs the necessary Addon catalogs for database backup. Verify that the Addon catalogs have been installed using the following command. ```bash ❯ kubectl get tasks.stash.appscode.com diff --git a/docs/setup/install/troubleshooting/index.md b/docs/setup/install/troubleshooting/index.md index b98f4f45..9e908d9c 100644 --- a/docs/setup/install/troubleshooting/index.md +++ b/docs/setup/install/troubleshooting/index.md @@ -45,15 +45,14 @@ For network volume such as NFS, Stash needs to deploy a helper deployment in the If you haven't installed Stash yet, run the following command to configure the network volume accessor during installation ```bash -$ helm install stash appscode/stash \ ---version {{< param "info.version" >}} \ ---namespace kube-system \ ---set features.enterprise=true \ ---set stash-enterprise.netVolAccessor.cpu=200m \ ---set stash-enterprise.netVolAccessor.memory=128Mi \ ---set stash-enterprise.netVolAccessor.runAsUser=0 \ ---set stash-enterprise.netVolAccessor.privileged=true ---set-file global.license=/path/to/license-file.txt +$ helm upgrade -i stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --set stash-enterprise.netVolAccessor.cpu=200m \ + --set stash-enterprise.netVolAccessor.memory=128Mi \ + --set stash-enterprise.netVolAccessor.runAsUser=0 \ + --set stash-enterprise.netVolAccessor.privileged=true \ + --set-file global.license=/path/to/license-file.txt ``` @@ -64,12 +63,15 @@ $ helm install stash appscode/stash \ If you have installed Stash already in your cluster but didn't configure the network volume accessor, you can use `helm upgrade` command to configure it in the existing installation. ```bash -$ helm upgrade stash appscode/stash -n kube-system \ - --reuse-values \ - --set stash-enterprise.netVolAccessor.cpu=200m \ - --set stash-enterprise.netVolAccessor.memory=128Mi \ - --set stash-enterprise.netVolAccessor.runAsUser=0 \ - --set stash-enterprise.netVolAccessor.privileged=true +$ helm upgrade -i stash oci://ghcr.io/appscode-charts/stash \ + --version {{< param "info.version" >}} \ + --namespace stash --create-namespace \ + --reuse-values \ + --set stash-enterprise.netVolAccessor.cpu=200m \ + --set stash-enterprise.netVolAccessor.memory=128Mi \ + --set stash-enterprise.netVolAccessor.runAsUser=0 \ + --set stash-enterprise.netVolAccessor.privileged=true \ + --set-file global.license=/path/to/license-file.txt ``` diff --git a/docs/setup/uninstall/community/index.md b/docs/setup/uninstall/community/index.md deleted file mode 100644 index f50e2ea0..00000000 --- a/docs/setup/uninstall/community/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Uninstall Stash Community Edition -description: Uninstallation guide for Stash Community edition -menu: - docs_{{ .version }}: - identifier: uninstall-stash-community - name: Community Edition - parent: uninstallation-guide - weight: 10 -product_name: stash -menu_name: docs_{{ .version }} -section_menu_id: setup ---- - -# Uninstall Stash Community Edition - -To uninstall Stash Community edition, run the following command: - - -
-
- -### Using Helm 3 - -In Helm 3, release names are [scoped to a namespace](https://v3.helm.sh/docs/faq/#release-names-are-now-scoped-to-the-namespace). So, provide the namespace you used to install the operator when installing. - -```bash -$ helm uninstall stash --namespace kube-system -``` - -
-
- -### Using YAML (with helm 3) - -If you prefer to not use Helm, you can generate YAMLs from Stash chart and uninstall using `kubectl`. - -```bash -$ helm template stash appscode/stash -n kube-system \ ---set features.community=true \ ---set global.license="nothing" \ ---set global.skipCleaner=true | kubectl delete -f - -``` - -
-
- -## Delete CRDs - -The above uninstallation process will uninstall the Stash operator. However, it will keep the Stash registered CRDs so that you don't lose your Stash objects i.e. `BackupConfiguration`, `Repository`, etc. during re-installation. If you want to remove the Stash CRDs too, please run the following command. - -```bash -kubectl delete crd -l=app.kubernetes.io/name=stash -``` - -If you wan't to delete the `AppBinding` CRD, run the following command. - -```bash - kubectl delete crd -l=app.kubernetes.io/name=catalog -``` diff --git a/docs/setup/uninstall/enterprise/index.md b/docs/setup/uninstall/stash/index.md similarity index 80% rename from docs/setup/uninstall/enterprise/index.md rename to docs/setup/uninstall/stash/index.md index 75f1d2d8..5ae1ac57 100644 --- a/docs/setup/uninstall/enterprise/index.md +++ b/docs/setup/uninstall/stash/index.md @@ -1,10 +1,10 @@ --- -title: Uninstall Stash Enterprise Edition -description: Uninstallation guide for Stash Enterprise edition +title: Uninstall Stash +description: Uninstallation guide for Stash menu: docs_{{ .version }}: identifier: uninstall-stash-enterprise - name: Enterprise Edition + name: Stash parent: uninstallation-guide weight: 20 product_name: stash @@ -12,9 +12,9 @@ menu_name: docs_{{ .version }} section_menu_id: setup --- -# Uninstall Stash Enterprise Edition +# Uninstall Stash -To uninstall Stash Enterprise edition, run the following command: +To uninstall Stash, run the following command: