docs: add eol notice to redis resources

aiven · Jan 28, 2025 · 8e663ef · 8e663ef
1 parent 7d12bfd
commit 8e663ef
Show file tree

Hide file tree

Showing 6 changed files with 86 additions and 20 deletions.
diff --git a/docs/resources/redis.md b/docs/resources/redis.md
@@ -1,17 +1,24 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "aiven_redis Resource - terraform-provider-aiven"
 subcategory: ""
 description: |-
-  The Redis resource allows the creation and management of Aiven Redis services.
+  Creates and manages and Aiven for Caching https://aiven.io/docs/products/caching (formerly known as Aiven for Redis®) service.
 ---
-
 # aiven_redis (Resource)
 
-The Redis resource allows the creation and management of Aiven Redis services.
+Creates and manages and [Aiven for Caching](https://aiven.io/docs/products/caching) (formerly known as Aiven for Redis®) service.
 
-## Example Usage
 
+~> **End of life notice**
+In March 2024, a new licensing model was announced for Redis® that impacts the Aiven for Caching offering (formerly Aiven for Redis®).
+Aiven for Caching is entering its end-of-life cycle to comply with Redis's copyright and license agreements.
+From **February 15th, 2025**, it will not be possible to start a new Aiven for Caching service, but existing services up until version 7.2 will still be available until end of life.
+From **March 31st, 2025**, Aiven for Caching will no longer be available and all existing services will be migrated to Aiven for Valkey™.
+You can [upgrade to Valkey for free](https://aiven.io/docs/products/caching/howto/upgrade-aiven-for-caching-to-valkey) before then 
+and [update your existing `aiven_redis` resources](https://registry.terraform.io/providers/aiven/aiven/latest/docs/guides/update-deprecated-resources#update-aiven_redis-resources-after-valkey-upgrade).
+
+
+## Example Usage
 ```terraform
 resource "aiven_redis" "redis1" {
   project                 = data.aiven_project.pr1.project
@@ -30,7 +37,6 @@ resource "aiven_redis" "redis1" {
   }
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
@@ -230,11 +236,8 @@ Read-Only:
 - `route` (String)
 - `ssl` (Boolean)
 - `usage` (String)
-
 ## Import
-
 Import is supported using the following syntax:
-
 ```shell
 terraform import aiven_redis.redis1 project/service_name
 ```
diff --git a/docs/resources/redis_user.md b/docs/resources/redis_user.md
@@ -1,17 +1,24 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "aiven_redis_user Resource - terraform-provider-aiven"
 subcategory: ""
 description: |-
-  The Redis User resource allows the creation and management of Aiven Redis Users.
+  Creates and manages an Aiven for Caching https://aiven.io/docs/products/caching (formerly known as Aiven for Redis®) service user.
 ---
-
 # aiven_redis_user (Resource)
 
-The Redis User resource allows the creation and management of Aiven Redis Users.
+Creates and manages an [Aiven for Caching](https://aiven.io/docs/products/caching) (formerly known as Aiven for Redis®) service user.
 
-## Example Usage
 
+~> **End of life notice**
+In March 2024, a new licensing model was announced for Redis® that impacts the Aiven for Caching offering (formerly Aiven for Redis®).
+Aiven for Caching is entering its end-of-life cycle to comply with Redis's copyright and license agreements.
+From **February 15th, 2025**, it will not be possible to start a new Aiven for Caching service, but existing services up until version 7.2 will still be available until end of life.
+From **March 31st, 2025**, Aiven for Caching will no longer be available and all existing services will be migrated to Aiven for Valkey™.
+You can [upgrade to Valkey for free](https://aiven.io/docs/products/caching/howto/upgrade-aiven-for-caching-to-valkey) before then 
+and [update your existing `aiven_redis` resources](https://registry.terraform.io/providers/aiven/aiven/latest/docs/guides/update-deprecated-resources#update-aiven_redis-resources-after-valkey-upgrade).
+
+
+## Example Usage
 ```terraform
 resource "aiven_redis_user" "foo" {
   service_name = aiven_redis.bar.service_name
@@ -20,7 +27,6 @@ resource "aiven_redis_user" "foo" {
   password     = "Test$1234"
 }
 ```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
@@ -54,11 +60,8 @@ Optional:
 - `delete` (String)
 - `read` (String)
 - `update` (String)
-
 ## Import
-
 Import is supported using the following syntax:
-
 ```shell
 terraform import aiven_redis_user.foo PROJECT/SERVICE_NAME/USERNAME
 ```
diff --git a/internal/sdkprovider/service/redis/redis.go b/internal/sdkprovider/service/redis/redis.go
@@ -60,7 +60,7 @@ func redisSchema() map[string]*schema.Schema {
 
 func ResourceRedis() *schema.Resource {
 	return &schema.Resource{
-		Description:   "The Redis resource allows the creation and management of Aiven Redis services.",
+		Description:   "Creates and manages and [Aiven for Caching](https://aiven.io/docs/products/caching) (formerly known as Aiven for Redis®) service.",
 		CreateContext: schemautil.ResourceServiceCreateWrapper(schemautil.ServiceTypeRedis),
 		ReadContext:   schemautil.ResourceServiceRead,
 		UpdateContext: schemautil.ResourceServiceUpdate,

diff --git a/internal/sdkprovider/service/redis/redis_user.go b/internal/sdkprovider/service/redis/redis_user.go
@@ -80,7 +80,7 @@ var aivenRedisUserSchema = map[string]*schema.Schema{
 
 func ResourceRedisUser() *schema.Resource {
 	return &schema.Resource{
-		Description:   "The Redis User resource allows the creation and management of Aiven Redis Users.",
+		Description:   "Creates and manages an [Aiven for Caching](https://aiven.io/docs/products/caching) (formerly known as Aiven for Redis®) service user.",
 		CreateContext: resourceRedisUserCreate,
 		UpdateContext: resourceRedisUserUpdate,
 		ReadContext:   resourceRedisUserRead,

diff --git a/templates/resources/redis.md.tmpl b/templates/resources/redis.md.tmpl
@@ -0,0 +1,30 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+
+~> **End of life notice**
+In March 2024, a new licensing model was announced for Redis® that impacts the Aiven for Caching offering (formerly Aiven for Redis®).
+Aiven for Caching is entering its end-of-life cycle to comply with Redis's copyright and license agreements.
+From **February 15th, 2025**, it will not be possible to start a new Aiven for Caching service, but existing services up until version 7.2 will still be available until end of life.
+From **March 31st, 2025**, Aiven for Caching will no longer be available and all existing services will be migrated to Aiven for Valkey™.
+You can [upgrade to Valkey for free](https://aiven.io/docs/products/caching/howto/upgrade-aiven-for-caching-to-valkey) before then 
+and [update your existing `aiven_redis` resources](https://registry.terraform.io/providers/aiven/aiven/latest/docs/guides/update-deprecated-resources#update-aiven_redis-resources-after-valkey-upgrade).
+
+
+{{ if .HasExample -}}
+## Example Usage
+{{ tffile .ExampleFile }}
+{{- end }}
+{{ .SchemaMarkdown | trimspace }}
+{{ if .HasImport -}}
+## Import
+Import is supported using the following syntax:
+{{ codefile "shell" .ImportFile }}
+{{- end }}
diff --git a/templates/resources/redis_user.md.tmpl b/templates/resources/redis_user.md.tmpl
@@ -0,0 +1,30 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+
+~> **End of life notice**
+In March 2024, a new licensing model was announced for Redis® that impacts the Aiven for Caching offering (formerly Aiven for Redis®).
+Aiven for Caching is entering its end-of-life cycle to comply with Redis's copyright and license agreements.
+From **February 15th, 2025**, it will not be possible to start a new Aiven for Caching service, but existing services up until version 7.2 will still be available until end of life.
+From **March 31st, 2025**, Aiven for Caching will no longer be available and all existing services will be migrated to Aiven for Valkey™.
+You can [upgrade to Valkey for free](https://aiven.io/docs/products/caching/howto/upgrade-aiven-for-caching-to-valkey) before then 
+and [update your existing `aiven_redis` resources](https://registry.terraform.io/providers/aiven/aiven/latest/docs/guides/update-deprecated-resources#update-aiven_redis-resources-after-valkey-upgrade).
+
+
+{{ if .HasExample -}}
+## Example Usage
+{{ tffile .ExampleFile }}
+{{- end }}
+{{ .SchemaMarkdown | trimspace }}
+{{ if .HasImport -}}
+## Import
+Import is supported using the following syntax:
+{{ codefile "shell" .ImportFile }}
+{{- end }}