feat: add compute_unit_per_broker and storage_unit_per_bookie (#93)

### Motivation
The compute_unit and storage_unit are actually "per broker" or "per
bookie" rather than "total". so rename to avoid confuse.

### Modifications

- Add `compute_unit_per_broker` and `storage_unit_per_bookie`

- Deprecate `compute_unit` and `storage_unit`

- Update docs

#### Verifications

Will show following warnings:

```
╷
│ Warning: Argument is deprecated
│ 
│   with streamnative_pulsar_cluster.test,
│   on main.tf line 23, in resource "streamnative_pulsar_cluster" "test":
│   23:   compute_unit     = 0.3
│ 
│ Deprecated. Please use compute_unit_per_broker instead.
│ 
│ (and 3 more similar warnings elsewhere)

Full warnings

terraform validate -json | jq -r '[ del( .diagnostics[] | select( .detail | startswith( "Experimental features" ) ) ) | .diagnostics[] | { Detail:.detail, Address:.address, Filename:.range.filename, Line:.range.start.line } ] | ( .[0] | keys_unsorted | ( . , map( length*"-" ) ) ), .[] | map(.) | @TSV' | column -ts $'\t'
Detail                                                   Address                           Filename  Line
------                                                   -------                           --------  ----
Deprecated. Please use compute_unit_per_broker instead.  streamnative_pulsar_cluster.test  main.tf   23
Deprecated. Please use storage_unit_per_bookie instead.  streamnative_pulsar_cluster.test  main.tf   24

```

---------

Signed-off-by: Max Xu <[email protected]>

Author: maxsxu

cloud/data_source_pulsar_cluster.go

@@ -17,12 +17,12 @@ package cloud
 import (
 	"context"
 	"fmt"
-	cloudv1alpha1 "github.com/streamnative/cloud-api-server/pkg/apis/cloud/v1alpha1"
-	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	cloudv1alpha1 "github.com/streamnative/cloud-api-server/pkg/apis/cloud/v1alpha1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -86,13 +86,25 @@ func dataSourcePulsarCluster() *schema.Resource {
 				Computed:    true,
 			},
 			"compute_unit": {
+				Deprecated:  "Deprecated. Please use compute_unit_per_broker instead.",
+				Type:        schema.TypeFloat,
+				Description: descriptions["compute_unit_per_broker"],
+				Computed:    true,
+			},
+			"compute_unit_per_broker": {
 				Type:        schema.TypeFloat,
-				Description: descriptions["compute_unit"],
+				Description: descriptions["compute_unit_per_broker"],
 				Computed:    true,
 			},
 			"storage_unit": {
+				Deprecated:  "Deprecated. Please use storage_unit_per_bookie instead.",
+				Type:        schema.TypeFloat,
+				Description: descriptions["storage_unit_per_bookie"],
+				Computed:    true,
+			},
+			"storage_unit_per_broker": {
 				Type:        schema.TypeFloat,
-				Description: descriptions["storage_unit"],
+				Description: descriptions["storage_unit_per_bookie"],
 				Computed:    true,
 			},
 			"config": {

cloud/provider.go

@@ -26,17 +26,16 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/mitchellh/go-homedir"
-	"k8s.io/cli-runtime/pkg/genericclioptions"
-	"k8s.io/client-go/rest"
-	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
-	cmdutil "k8s.io/kubectl/pkg/cmd/util"
-	"k8s.io/utils/clock"
-
 	"github.com/streamnative/cloud-cli/pkg/auth"
 	"github.com/streamnative/cloud-cli/pkg/auth/store"
 	"github.com/streamnative/cloud-cli/pkg/cmd"
 	"github.com/streamnative/cloud-cli/pkg/config"
 	"github.com/streamnative/cloud-cli/pkg/plugin"
+	"k8s.io/cli-runtime/pkg/genericclioptions"
+	"k8s.io/client-go/rest"
+	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
+	cmdutil "k8s.io/kubectl/pkg/cmd/util"
+	"k8s.io/utils/clock"
 )
 
 const (
@@ -79,18 +78,18 @@ func init() {
 		"instance_engine":              "The streamnative cloud instance engine, supporting 'ursa' and 'classic', default 'classic'",
 		"location": "The location of the pulsar cluster, " +
 			"supported location https://docs.streamnative.io/docs/cluster#cluster-location",
-		"release_channel":     "The release channel of the pulsar cluster subscribe to, it must to be lts or rapid, default rapid",
-		"bookie_replicas":     "The number of bookie replicas",
-		"broker_replicas":     "The number of broker replicas",
-		"compute_unit":        "compute unit, 1 compute unit is 2 cpu and 8gb memory",
-		"storage_unit":        "storage unit, 1 storage unit is 2 cpu and 8gb memory",
-		"cluster_ready":       "Pulsar cluster is ready, it will be set to 'True' after the cluster is ready",
-		"instance_ready":      "Pulsar instance is ready, it will be set to 'True' after the instance is ready",
-		"websocket_enabled":   "Whether the websocket is enabled",
-		"function_enabled":    "Whether the function is enabled",
-		"transaction_enabled": "Whether the transaction is enabled",
-		"kafka":               "Controls the kafka protocol config of pulsar cluster",
-		"mqtt":                "Controls the mqtt protocol config of pulsar cluster",
+		"release_channel":         "The release channel of the pulsar cluster subscribe to, it must to be lts or rapid, default rapid",
+		"bookie_replicas":         "The number of bookie replicas",
+		"broker_replicas":         "The number of broker replicas",
+		"compute_unit_per_broker": "compute unit per broker, 1 compute unit is 2 cpu and 8gb memory",
+		"storage_unit_per_bookie": "storage unit per bookie, 1 storage unit is 2 cpu and 8gb memory",
+		"cluster_ready":           "Pulsar cluster is ready, it will be set to 'True' after the cluster is ready",
+		"instance_ready":          "Pulsar instance is ready, it will be set to 'True' after the instance is ready",
+		"websocket_enabled":       "Whether the websocket is enabled",
+		"function_enabled":        "Whether the function is enabled",
+		"transaction_enabled":     "Whether the transaction is enabled",
+		"kafka":                   "Controls the kafka protocol config of pulsar cluster",
+		"mqtt":                    "Controls the mqtt protocol config of pulsar cluster",
 		"categories": "Controls the audit log categories config of pulsar cluster, supported categories: " +
 			"\"Management\", \"Describe\", \"Produce\", \"Consume\"",
 		"lakehouse_type":          "The type of the lakehouse",

cloud/resource_pulsar_cluster.go

@@ -17,20 +17,18 @@ package cloud
 import (
 	"context"
 	"fmt"
-	"github.com/hashicorp/terraform-plugin-log/tflog"
-	"k8s.io/apimachinery/pkg/api/errors"
 	"strings"
 	"time"
 
-	apierrors "k8s.io/apimachinery/pkg/api/errors"
-
+	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	cloudv1alpha1 "github.com/streamnative/cloud-api-server/pkg/apis/cloud/v1alpha1"
+	"k8s.io/apimachinery/pkg/api/errors"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-	cloudv1alpha1 "github.com/streamnative/cloud-api-server/pkg/apis/cloud/v1alpha1"
 )
 
 func resourcePulsarCluster() *schema.Resource {
@@ -131,20 +129,42 @@ func resourcePulsarCluster() *schema.Resource {
 				},
 			},
 			"compute_unit": {
+				Deprecated:   "Deprecated. Please use compute_unit_per_broker instead.",
+				Type:         schema.TypeFloat,
+				Optional:     true,
+				Default:      0.5,
+				Description:  descriptions["compute_unit_per_broker"],
+				ValidateFunc: validateCUSU,
+				DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
+					return d.Get("type") == string(cloudv1alpha1.PulsarInstanceTypeServerless)
+				},
+			},
+			"compute_unit_per_broker": {
 				Type:         schema.TypeFloat,
 				Optional:     true,
 				Default:      0.5,
-				Description:  descriptions["compute_unit"],
+				Description:  descriptions["compute_unit_per_broker"],
 				ValidateFunc: validateCUSU,
 				DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
 					return d.Get("type") == string(cloudv1alpha1.PulsarInstanceTypeServerless)
 				},
 			},
 			"storage_unit": {
+				Deprecated:   "Deprecated. Please use storage_unit_per_bookie instead.",
 				Type:         schema.TypeFloat,
 				Optional:     true,
 				Default:      0.5,
-				Description:  descriptions["storage_unit"],
+				Description:  descriptions["storage_unit_per_bookie"],
+				ValidateFunc: validateCUSU,
+				DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
+					return d.Get("type") == string(cloudv1alpha1.PulsarInstanceTypeServerless)
+				},
+			},
+			"storage_unit_per_bookie": {
+				Type:         schema.TypeFloat,
+				Optional:     true,
+				Default:      0.5,
+				Description:  descriptions["storage_unit_per_bookie"],
 				ValidateFunc: validateCUSU,
 				DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
 					return d.Get("type") == string(cloudv1alpha1.PulsarInstanceTypeServerless)
@@ -345,8 +365,8 @@ func resourcePulsarClusterCreate(ctx context.Context, d *schema.ResourceData, me
 	releaseChannel := d.Get("release_channel").(string)
 	bookieReplicas := int32(d.Get("bookie_replicas").(int))
 	brokerReplicas := int32(d.Get("broker_replicas").(int))
-	computeUnit := d.Get("compute_unit").(float64)
-	storageUnit := d.Get("storage_unit").(float64)
+	computeUnit := getComputeUnit(d)
+	storageUnit := getStorageUnit(d)
 	clientSet, err := getClientSet(getFactoryFromMeta(meta))
 	if err != nil {
 		return diag.FromErr(fmt.Errorf("ERROR_INIT_CLIENT_ON_CREATE_PULSAR_CLUSTER: %w", err))
@@ -672,15 +692,15 @@ func resourcePulsarClusterUpdate(ctx context.Context, d *schema.ResourceData, me
 		bookieReplicas := int32(d.Get("broker_replicas").(int))
 		pulsarCluster.Spec.Broker.Replicas = &bookieReplicas
 	}
-	if d.HasChange("compute_unit") {
-		computeUnit := d.Get("compute_unit").(float64)
+	if d.HasChange("compute_unit") || d.HasChange("compute_unit_per_broker") {
+		computeUnit := getComputeUnit(d)
 		pulsarCluster.Spec.Broker.Resources.Cpu = resource.NewMilliQuantity(
 			int64(computeUnit*2*1000), resource.DecimalSI)
 		pulsarCluster.Spec.Broker.Resources.Memory = resource.NewQuantity(
 			int64(computeUnit*8*1024*1024*1024), resource.DecimalSI)
 	}
-	if d.HasChange("storage_unit") {
-		storageUnit := d.Get("storage_unit").(float64)
+	if d.HasChange("storage_unit") || d.HasChange("storage_unit_per_bookie") {
+		storageUnit := getStorageUnit(d)
 		pulsarCluster.Spec.BookKeeper.Resources.Cpu = resource.NewMilliQuantity(
 			int64(storageUnit*2*1000), resource.DecimalSI)
 		pulsarCluster.Spec.BookKeeper.Resources.Memory = resource.NewQuantity(
@@ -694,7 +714,9 @@ func resourcePulsarClusterUpdate(ctx context.Context, d *schema.ResourceData, me
 	if d.HasChange("bookie_replicas") ||
 		d.HasChange("broker_replicas") ||
 		d.HasChange("compute_unit") ||
-		d.HasChange("storage_unit") || changed || displayNameChanged {
+		d.HasChange("storage_unit") ||
+		d.HasChange("compute_unit_per_broker") ||
+		d.HasChange("storage_unit_per_bookie") || changed || displayNameChanged {
 		_, err = clientSet.CloudV1alpha1().PulsarClusters(namespace).Update(ctx, pulsarCluster, metav1.UpdateOptions{
 			FieldManager: "terraform-update",
 		})
@@ -907,3 +929,19 @@ func getPulsarClusterChanged(ctx context.Context, pulsarCluster *cloudv1alpha1.P
 	})
 	return changed
 }
+
+func getComputeUnit(d *schema.ResourceData) float64 {
+	computeUnit := d.Get("compute_unit").(float64)
+	if newComputeUnit, exist := d.GetOk("compute_unit_per_broker"); exist {
+		computeUnit = newComputeUnit.(float64)
+	}
+	return computeUnit
+}
+
+func getStorageUnit(d *schema.ResourceData) float64 {
+	storageUnit := d.Get("storage_unit").(float64)
+	if newStorageUnit, exist := d.GetOk("storage_unit"); exist {
+		storageUnit = newStorageUnit.(float64)
+	}
+	return storageUnit
+}

docs/data-sources/cloud_environment.md

@@ -27,7 +27,7 @@ description: |-
 - `id` (String) The ID of this resource.
 - `network` (List of Object) (see [below for nested schema](#nestedatt--network))
 - `private_service_ids` (List of String) The private service ids are ids are service names of PrivateLink in AWS, the ids of Private Service Attachment in GCP, and the aliases of PrivateLinkService in Azure.
-- `region` (String) The region of the cloud environment
+- `region` (String) The region of the cloud environment, for Azure, it should be the resource group name
 
 <a id="nestedatt--default_gateway"></a>
 ### Nested Schema for `default_gateway`

docs/data-sources/pulsar_cluster.md

@@ -25,7 +25,8 @@ description: |-
 - `bookie_replicas` (Number) The number of bookie replicas
 - `bookkeeper_version` (String) The version of the bookkeeper cluster
 - `broker_replicas` (Number) The number of broker replicas
-- `compute_unit` (Number) compute unit, 1 compute unit is 2 cpu and 8gb memory
+- `compute_unit` (Number, Deprecated) compute unit per broker, 1 compute unit is 2 cpu and 8gb memory
+- `compute_unit_per_broker` (Number) compute unit per broker, 1 compute unit is 2 cpu and 8gb memory
 - `config` (List of Object) (see [below for nested schema](#nestedatt--config))
 - `http_tls_service_url` (String) The service url of the pulsar cluster, use it to management the pulsar cluster.
 - `http_tls_service_urls` (List of String) The service url of the pulsar cluster, use it to management the pulsar cluster. There'll be multiple service urls if the cluster attached with multiple gateways
@@ -41,7 +42,8 @@ description: |-
 - `pulsar_version` (String) The version of the pulsar cluster
 - `ready` (String) Pulsar cluster is ready, it will be set to 'True' after the cluster is ready
 - `release_channel` (String) The release channel of the pulsar cluster subscribe to, it must to be lts or rapid, default rapid
-- `storage_unit` (Number) storage unit, 1 storage unit is 2 cpu and 8gb memory
+- `storage_unit` (Number, Deprecated) storage unit per bookie, 1 storage unit is 2 cpu and 8gb memory
+- `storage_unit_per_broker` (Number) storage unit per bookie, 1 storage unit is 2 cpu and 8gb memory
 - `type` (String) The streamnative cloud instance type, supporting 'serverless', 'dedicated', 'byoc' and 'byoc-pro'
 - `websocket_service_url` (String) If you want to connect to the pulsar cluster using the websocket protocol, use this websocket service url.
 - `websocket_service_urls` (List of String) If you want to connect to the pulsar cluster using the websocket protocol, use this websocket service url. There'll be multiple service urls if the cluster attached with multiple gateways

docs/data-sources/rolebinding.md

@@ -22,7 +22,9 @@ description: |-
 
 ### Read-Only
 
+- `cel` (String) The CEL(Common Expression Langauge) for conditional role binding
 - `cluster_role_name` (String) The predefined role name
 - `id` (String) The ID of this resource.
 - `ready` (Boolean) The RoleBinding is ready, it will be set to 'True' after the cluster is ready
 - `service_account_names` (List of String) The list of service accounts that are role binding names
+- `user_names` (List of String) The list of users that are role binding names

docs/resources/cloud_environment.md

@@ -19,9 +19,9 @@ description: |-
 
 - `cloud_connection_name` (String) Name of the cloud connection
 - `environment_type` (String) Type of the cloud environment, either: dev, test, staging, production, acc, qa or poc
-- `network` (Block List, Min: 1) (see [below for nested schema](#nestedblock--network))
+- `network` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--network))
 - `organization` (String) The organization name
-- `region` (String) The region of the cloud environment
+- `region` (String) The region of the cloud environment, for Azure, it should be the resource group name
 
 ### Optional
 

docs/resources/pulsar_cluster.md

@@ -24,15 +24,17 @@ description: |-
 
 - `bookie_replicas` (Number) The number of bookie replicas
 - `broker_replicas` (Number) The number of broker replicas
-- `compute_unit` (Number) compute unit, 1 compute unit is 2 cpu and 8gb memory
+- `compute_unit` (Number, Deprecated) compute unit per broker, 1 compute unit is 2 cpu and 8gb memory
+- `compute_unit_per_broker` (Number) compute unit per broker, 1 compute unit is 2 cpu and 8gb memory
 - `config` (Block List) (see [below for nested schema](#nestedblock--config))
 - `display_name` (String) The pulsar cluster display name
 - `endpoint_access` (Block List) (see [below for nested schema](#nestedblock--endpoint_access))
 - `location` (String) The location of the pulsar cluster, supported location https://docs.streamnative.io/docs/cluster#cluster-location
 - `name` (String) The pulsar cluster name
 - `pool_member_name` (String) The infrastructure pool member name
 - `release_channel` (String) The release channel of the pulsar cluster subscribe to, it must to be lts or rapid, default rapid
-- `storage_unit` (Number) storage unit, 1 storage unit is 2 cpu and 8gb memory
+- `storage_unit` (Number, Deprecated) storage unit per bookie, 1 storage unit is 2 cpu and 8gb memory
+- `storage_unit_per_bookie` (Number) storage unit per bookie, 1 storage unit is 2 cpu and 8gb memory
 
 ### Read-Only
 

docs/resources/rolebinding.md

@@ -22,8 +22,10 @@ description: |-
 
 ### Optional
 
+- `cel` (String) The CEL(Common Expression Langauge) for conditional role binding
 - `cluster_role_name` (String) The predefined role name
 - `service_account_names` (List of String) The list of service accounts that are role binding names
+- `user_names` (List of String) The list of users that are role binding names
 
 ### Read-Only