PLT-682: Added Description for pack (#354)

spectrocloud · Oct 11, 2023 · b4b6eca · b4b6eca
1 parent 7c3ca4f
commit b4b6eca
Show file tree

Hide file tree

Showing 18 changed files with 20 additions and 19 deletions.
diff --git a/docs/resources/addon_deployment.md b/docs/resources/addon_deployment.md
@@ -40,7 +40,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_aks.md b/docs/resources/cluster_aks.md
@@ -216,7 +216,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_aws.md b/docs/resources/cluster_aws.md
@@ -247,7 +247,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_azure.md b/docs/resources/cluster_azure.md
@@ -212,7 +212,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_coxedge.md b/docs/resources/cluster_coxedge.md
@@ -190,7 +190,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_edge_native.md b/docs/resources/cluster_edge_native.md
@@ -143,7 +143,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_edge_vsphere.md b/docs/resources/cluster_edge_vsphere.md
@@ -167,7 +167,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_eks.md b/docs/resources/cluster_eks.md
@@ -228,7 +228,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_gcp.md b/docs/resources/cluster_gcp.md
@@ -200,7 +200,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_import.md b/docs/resources/cluster_import.md
@@ -80,7 +80,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_libvirt.md b/docs/resources/cluster_libvirt.md
@@ -211,7 +211,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_maas.md b/docs/resources/cluster_maas.md
@@ -227,7 +227,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_openstack.md b/docs/resources/cluster_openstack.md
@@ -205,7 +205,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_profile.md b/docs/resources/cluster_profile.md
@@ -155,7 +155,7 @@ resource "spectrocloud_cluster_profile" "profile" {
 - `cloud` (String) Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The  supported cloud types are - `all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, and gke`,If the value is set to `all`, then the type must be set to `add-on`. Otherwise, the cluster profile may be incompatible with other providers. Default value is `all`.
 - `context` (String) The context of the cluster profile. Allowed values are `project` or `tenant`. Default value is `project`.
 - `description` (String)
-- `pack` (Block List) (see [below for nested schema](#nestedblock--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--pack))
 - `tags` (Set of String) A list of tags to be applied to the cluster. Tags must be in the form of `key:value`.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 - `type` (String) Specify the cluster profile type to use. Allowed values are `cluster`, infra`, `add-on`, and `system`. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a **Full** cluster profile.For an Infrastructure cluster profile, use the value `infra`; for an Add-on cluster profile, use the value `add-on`.System cluster profiles can be specified using the value `system`. To learn more about cluster profiles, refer to the [Cluster Profile](https://docs.spectrocloud.com/cluster-profiles) documentation. Default value is `add-on`.

diff --git a/docs/resources/cluster_tke.md b/docs/resources/cluster_tke.md
@@ -137,7 +137,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/cluster_vsphere.md b/docs/resources/cluster_vsphere.md
@@ -167,7 +167,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/docs/resources/virtual_cluster.md b/docs/resources/virtual_cluster.md
@@ -125,7 +125,7 @@ Required:
 
 Optional:
 
-- `pack` (Block List) (see [below for nested schema](#nestedblock--cluster_profile--pack))
+- `pack` (Block List) For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified. (see [below for nested schema](#nestedblock--cluster_profile--pack))
 
 <a id="nestedblock--cluster_profile--pack"></a>
 ### Nested Schema for `cluster_profile.pack`

diff --git a/spectrocloud/schemas/pack.go b/spectrocloud/schemas/pack.go
@@ -8,8 +8,9 @@ import (
 
 func PackSchema() *schema.Schema {
 	return &schema.Schema{
-		Type:     schema.TypeList,
-		Optional: true,
+		Type:        schema.TypeList,
+		Optional:    true,
+		Description: "For packs of type `spectro`, `helm`, and `manifest`, at least one pack must be specified.",
 		Elem: &schema.Resource{
 			Schema: map[string]*schema.Schema{
 				"uid": {