Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add eol notice to redis resources #2012

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions docs/resources/redis.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -30,7 +37,6 @@ resource "aiven_redis" "redis1" {
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down Expand Up @@ -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
```
21 changes: 12 additions & 9 deletions docs/resources/redis_user.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -20,7 +27,6 @@ resource "aiven_redis_user" "foo" {
password = "Test$1234"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down Expand Up @@ -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
```
2 changes: 1 addition & 1 deletion internal/sdkprovider/service/redis/redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion internal/sdkprovider/service/redis/redis_user.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
30 changes: 30 additions & 0 deletions templates/resources/redis.md.tmpl
Original file line number Diff line number Diff line change
@@ -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 }}
30 changes: 30 additions & 0 deletions templates/resources/redis_user.md.tmpl
Original file line number Diff line number Diff line change
@@ -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 }}
Loading