PLT-798: Project name default and context clarification. (#363)

* PLT-798: Project name dafault and context clarification. * PLT-798: Project name typo fix docs gen. * PLT-798: Updated dependencies.
spectrocloud · Oct 27, 2023 · 8b13ac9 · 8b13ac9
1 parent 7b3d7d5
commit 8b13ac9
Show file tree

Hide file tree

Showing 68 changed files with 117 additions and 65 deletions.
diff --git a/docs/data-sources/cluster.md b/docs/data-sources/cluster.md
@@ -42,7 +42,7 @@ resource "local_file" "adminkubeconfig" {
 
 ### Optional
 
-- `context` (String) Cluster context can be 'project' or 'tenant'. Defaults to 'project'.
+- `context` (String) Cluster context can be `project` or `tenant`. Defaults to `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 
 ### Read-Only
 

diff --git a/docs/data-sources/cluster_group.md b/docs/data-sources/cluster_group.md
@@ -50,7 +50,7 @@ output "out_project_sc" {
 
 ### Optional
 
-- `context` (String) The context of where the cluster group is located. Allowed values  are `system` or `tenant`. Defaults to 'tenant'.
+- `context` (String) The context of where the cluster group is located. Allowed values  are `system` or `tenant`. Defaults to `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 
 ### Read-Only
 

diff --git a/docs/data-sources/cluster_profile.md b/docs/data-sources/cluster_profile.md
@@ -27,7 +27,7 @@ output "same" {
 
 ### Optional
 
-- `context` (String)
+- `context` (String) Cluster profile context can be `project` or `tenant`. Defaults to `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `name` (String)
 - `version` (String)
 

diff --git a/docs/data-sources/pack_simple.md b/docs/data-sources/pack_simple.md
@@ -35,7 +35,7 @@ data "spectrocloud_pack_simple" "pack" {
 
 ### Optional
 
-- `context` (String)
+- `context` (String) Indicates in which context registry should be searched for the pack values. Allowed values are `system`, `project` or `tenant`. Defaults to `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `registry_uid` (String) The unique identifier of the registry the pack belongs to.
 - `version` (String) The version of the pack.
 

diff --git a/docs/index.md b/docs/index.md
@@ -102,7 +102,7 @@ provider GitHub [discussion board](https://github.com/spectrocloud/terraform-pro
 - `host` (String) The Spectro Cloud API host url. Can also be set with the `SPECTROCLOUD_HOST` environment variable. Defaults to https://api.spectrocloud.com
 - `ignore_insecure_tls_error` (Boolean) Ignore insecure TLS errors for Spectro Cloud API endpoints. Defaults to false.
 - `password` (String, Sensitive, Deprecated) The Spectro Cloud user password. Can also be set with the `SPECTROCLOUD_PASSWORD` environment variable.
-- `project_name` (String) The Spectro Cloud project name.
+- `project_name` (String) The Spectro Cloud project name. If value is not provided or is an empty string it will be set to `Default`
 - `retry_attempts` (Number) Number of retry attempts. Can also be set with the `SPECTROCLOUD_RETRY_ATTEMPTS` environment variable. Defaults to 10.
 - `trace` (Boolean) Enable HTTP request tracing. Can also be set with the `SPECTROCLOUD_TRACE` environment variable. To enable Terraform debug logging, set `TF_LOG=DEBUG`. Visit the Terraform documentation to learn more about Terraform [debugging](https://developer.hashicorp.com/terraform/plugin/log/managing).
 - `username` (String, Deprecated) The Spectro Cloud username. Can also be set with the `SPECTROCLOUD_USERNAME` environment variable.
diff --git a/docs/resources/addon_deployment.md b/docs/resources/addon_deployment.md
@@ -19,12 +19,12 @@ description: |-
 ### Required
 
 - `cluster_uid` (String)
-- `context` (String)
 
 ### Optional
 
 - `apply_setting` (String) The setting to apply the cluster profile. `DownloadAndInstall` will download and install packs in one action. `DownloadAndInstallLater` will only download artifact and postpone install for later. Default value is `DownloadAndInstall`.
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
+- `context` (String) Specifies cluster context where addon profile is attached. Can be `project` or `tenant`. Defaults to `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 
 ### Read-Only

diff --git a/docs/resources/application_profile.md b/docs/resources/application_profile.md
@@ -390,7 +390,7 @@ resource "spectrocloud_application_profile" "app_profile_all_tiers" {
 ### Optional
 
 - `cloud` (String) The cloud provider the profile is eligible for. Default value is `all`.
-- `context` (String) Context of the profile. Allowed values are `project`, `cluster`, or `namespace`. Default value is `project`.
+- `context` (String) Context of the profile. Allowed values are `project`, `cluster`, or `namespace`. Default value is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `description` (String) Description of the profile.
 - `tags` (Set of String) A list of tags to be applied to the application profile. Tags must be in the form of `key:value`.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

diff --git a/docs/resources/cloudaccount_aws.md b/docs/resources/cloudaccount_aws.md
@@ -32,7 +32,7 @@ resource "spectrocloud_cloudaccount_aws" "aws-1" {
 - `arn` (String)
 - `aws_access_key` (String)
 - `aws_secret_key` (String, Sensitive)
-- `context` (String) The context of the AWS configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the AWS configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `external_id` (String, Sensitive)
 - `partition` (String) The AWS partition in which the cloud account is located. 
 Can be 'aws' for standard AWS regions or 'aws-us-gov' for AWS GovCloud (US) regions.

diff --git a/docs/resources/cloudaccount_azure.md b/docs/resources/cloudaccount_azure.md
@@ -33,7 +33,7 @@ resource "spectrocloud_cloudaccount_azure" "azure-1" {
 
 ### Optional
 
-- `context` (String) The context of the Azure configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the Azure configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `disable_properties_request` (Boolean) Disable properties request. This is a boolean value that indicates whether to disable properties request or not. If not specified, the default value is `false`.
 - `private_cloud_gateway_id` (String) ID of the private cloud gateway. This is the ID of the private cloud gateway that is used to connect to the private cluster endpoint.
 - `tenant_name` (String) The name of the tenant. This is the name of the tenant that is used to connect to the Azure cloud.

diff --git a/docs/resources/cloudaccount_coxedge.md b/docs/resources/cloudaccount_coxedge.md
@@ -26,7 +26,7 @@ description: |-
 
 ### Optional
 
-- `context` (String) The context of the CoxEdge configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the CoxEdge configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 
 ### Read-Only
 

diff --git a/docs/resources/cloudaccount_gcp.md b/docs/resources/cloudaccount_gcp.md
@@ -29,7 +29,7 @@ resource "spectrocloud_cloudaccount_gcp" "gcp-1" {
 
 ### Optional
 
-- `context` (String) The context of the GCP configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the GCP configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 
 ### Read-Only
 

diff --git a/docs/resources/cloudaccount_maas.md b/docs/resources/cloudaccount_maas.md
@@ -32,7 +32,7 @@ resource "spectrocloud_cloudaccount_maas" "maas-1" {
 
 ### Optional
 
-- `context` (String) The context of the MAAS configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the MAAS configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 
 ### Read-Only
 

diff --git a/docs/resources/cloudaccount_openstack.md b/docs/resources/cloudaccount_openstack.md
@@ -42,7 +42,7 @@ resource "spectrocloud_cloudaccount_openstack" "account" {
 ### Optional
 
 - `ca_certificate` (String) The CA certificate of the OpenStack cloud that is used to connect to the OpenStack cloud.
-- `context` (String) The context of the OpenStack configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the OpenStack configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `openstack_allow_insecure` (Boolean) Whether to allow insecure connections to the OpenStack cloud. Default is `false`.
 
 ### Read-Only

diff --git a/docs/resources/cloudaccount_tencent.md b/docs/resources/cloudaccount_tencent.md
@@ -28,7 +28,7 @@ resource "spectrocloud_cloudaccount_tencent" "tencent-1" {
 
 ### Optional
 
-- `context` (String) The context of the Tencent configuration. Can be `project` or `tenant`.
+- `context` (String) The context of the Tencent configuration. Can be `project` or `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `tencent_secret_id` (String)
 - `tencent_secret_key` (String, Sensitive)
 

diff --git a/docs/resources/cloudaccount_vsphere.md b/docs/resources/cloudaccount_vsphere.md
@@ -44,7 +44,7 @@ output "same" {
 
 ### Optional
 
-- `context` (String) Context of the cloud account. This can be either project or tenant. If not specified, the default value is project.
+- `context` (String) Context of the cloud account. This can be either `project` or `tenant`. If not specified, the default value is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `vsphere_ignore_insecure_error` (Boolean) Ignore insecure error. This is a boolean value that indicates whether to ignore the insecure error or not. If not specified, the default value is false.
 
 ### Read-Only

diff --git a/docs/resources/cluster_aks.md b/docs/resources/cluster_aks.md
@@ -106,7 +106,7 @@ resource "spectrocloud_cluster_aks" "cluster" {
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the AKS cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the AKS cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_aws.md b/docs/resources/cluster_aws.md
@@ -137,7 +137,7 @@ resource "spectrocloud_cluster_aws" "cluster" {
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the AWS cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the AWS cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_azure.md b/docs/resources/cluster_azure.md
@@ -100,7 +100,7 @@ resource "spectrocloud_cluster_azure" "cluster" {
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the Azure cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the Azure cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_coxedge.md b/docs/resources/cluster_coxedge.md
@@ -29,7 +29,7 @@ description: |-
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the CoxEdge cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the CoxEdge cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_edge_native.md b/docs/resources/cluster_edge_native.md
@@ -31,7 +31,7 @@ description: |-
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the Edge cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the Edge cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_edge_vsphere.md b/docs/resources/cluster_edge_vsphere.md
@@ -30,7 +30,7 @@ description: |-
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the Edge cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the Edge cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_eks.md b/docs/resources/cluster_eks.md
@@ -104,7 +104,7 @@ resource "spectrocloud_cluster_eks" "cluster" {
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the EKS cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the EKS cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `fargate_profile` (Block List) (see [below for nested schema](#nestedblock--fargate_profile))
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.

diff --git a/docs/resources/cluster_gcp.md b/docs/resources/cluster_gcp.md
@@ -97,7 +97,7 @@ resource "spectrocloud_cluster_gcp" "cluster" {
 - `cluster_meta_attribute` (String) `cluster_meta_attribute` can be used to set additional cluster metadata information, eg `{'nic_name': 'test', 'env': 'stage'}`
 - `cluster_profile` (Block List) (see [below for nested schema](#nestedblock--cluster_profile))
 - `cluster_rbac_binding` (Block List) The RBAC binding for the cluster. (see [below for nested schema](#nestedblock--cluster_rbac_binding))
-- `context` (String) The context of the GCP cluster. Can be `project` or `tenant`. Default is `project`.
+- `context` (String) The context of the GCP cluster. Can be `project` or `tenant`. Default is `project`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `force_delete` (Boolean) If set to `true`, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
 - `force_delete_delay` (Number) Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
 - `host_config` (Block List) The host configuration for the cluster. (see [below for nested schema](#nestedblock--host_config))

diff --git a/docs/resources/cluster_group.md b/docs/resources/cluster_group.md
@@ -52,7 +52,7 @@ resource "spectrocloud_cluster_group" "cg" {
 ### Optional
 
 - `clusters` (Block List) A list of clusters to include in the cluster group. (see [below for nested schema](#nestedblock--clusters))
-- `context` (String) The context of the Cluster group. Allowed values are `project` or `tenant`. Defaults to `tenant`.
+- `context` (String) The context of the Cluster group. Allowed values are `project` or `tenant`. Defaults to `tenant`.If `project` context is specified, `project_name` will be taken from provider configuration. Default value for `project_name` is `Default`.
 - `tags` (Set of String) A list of tags to be applied to the cluster group. Tags must be in the form of `key:value`.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))