fix override origin proto, update docs (#81)

* fix override origin protocol for rule create/update

* * fix override origin protocol for rule create/update
* update docs

* * update docs

* * update docs

Co-authored-by: Vitaly Velikodny <[email protected]>

Author: vvelikodny

docs/index.md

@@ -254,7 +254,7 @@ resource "gcore_lbmember" "lbm2" {
 - **gcore_cdn_api** (String) CDN API
 - **gcore_client_id** (String) Client id
 - **gcore_dns_api** (String) DNS API
-- **gcore_platform** (String) Platform ulr is used for generate jwt
+- **gcore_platform** (String) Platform URL is used for generate JWT
 - **gcore_storage_api** (String) Storage API
 - **ignore_creds_auth_error** (Boolean) Should be set to true when you are gonna to use storage resource with permanent API-token only.
 - **password** (String)

docs/resources/gcore_cdn_resource.md

@@ -94,6 +94,9 @@ Optional:
 - **edge_cache_settings** (Block List, Max: 1) The cache expiration time for CDN servers. (see [below for nested schema](#nestedblock--options--edge_cache_settings))
 - **gzip_on** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--gzip_on))
 - **host_header** (Block List, Max: 1) Specify the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header. If the option is in NULL state Host Header value is taken from the CNAME field. (see [below for nested schema](#nestedblock--options--host_header))
+- **ignore_query_string** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--ignore_query_string))
+- **query_params_blacklist** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--query_params_blacklist))
+- **query_params_whitelist** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--query_params_whitelist))
 - **redirect_http_to_https** (Block List, Max: 1) Sets redirect from HTTP protocol to HTTPS for all resource requests. (see [below for nested schema](#nestedblock--options--redirect_http_to_https))
 - **rewrite** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--rewrite))
 - **sni** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--sni))
@@ -155,6 +158,42 @@ Optional:
 - **enabled** (Boolean)
 
 
+<a id="nestedblock--options--ignore_query_string"></a>
+### Nested Schema for `options.ignore_query_string`
+
+Required:
+
+- **value** (Boolean)
+
+Optional:
+
+- **enabled** (Boolean)
+
+
+<a id="nestedblock--options--query_params_blacklist"></a>
+### Nested Schema for `options.query_params_blacklist`
+
+Required:
+
+- **value** (Set of String)
+
+Optional:
+
+- **enabled** (Boolean)
+
+
+<a id="nestedblock--options--query_params_whitelist"></a>
+### Nested Schema for `options.query_params_whitelist`
+
+Required:
+
+- **value** (Set of String)
+
+Optional:
+
+- **enabled** (Boolean)
+
+
 <a id="nestedblock--options--redirect_http_to_https"></a>
 ### Nested Schema for `options.redirect_http_to_https`
 

docs/resources/gcore_cdn_rule.md

@@ -63,6 +63,7 @@ resource "gcore_cdn_rule" "cdn_example_com_rule_2" {
   name = "All JS scripts"
   rule = "/folder/images/*.js"
   rule_type = 0
+  origin_protocol = "HTTP"
 
   options {
     redirect_http_to_https {
@@ -107,6 +108,7 @@ resource "gcore_cdn_resource" "cdn_example_com" {
 
 - **id** (String) The ID of this resource.
 - **options** (Block List, Max: 1) Each option in CDN resource settings. Each option added to CDN resource settings should have the following mandatory request fields: enabled, value. (see [below for nested schema](#nestedblock--options))
+- **origin_protocol** (String) This option defines the protocol that will be used by CDN servers to request content from an origin source. If not specified, it will be inherit from resource. Possible values are: HTTPS, HTTP, MATCH.
 
 <a id="nestedblock--options"></a>
 ### Nested Schema for `options`
@@ -118,6 +120,9 @@ Optional:
 - **edge_cache_settings** (Block List, Max: 1) The cache expiration time for CDN servers. (see [below for nested schema](#nestedblock--options--edge_cache_settings))
 - **gzip_on** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--gzip_on))
 - **host_header** (Block List, Max: 1) Specify the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header. If the option is in NULL state Host Header value is taken from the CNAME field. (see [below for nested schema](#nestedblock--options--host_header))
+- **ignore_query_string** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--ignore_query_string))
+- **query_params_blacklist** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--query_params_blacklist))
+- **query_params_whitelist** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--query_params_whitelist))
 - **redirect_http_to_https** (Block List, Max: 1) Sets redirect from HTTP protocol to HTTPS for all resource requests. (see [below for nested schema](#nestedblock--options--redirect_http_to_https))
 - **rewrite** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--rewrite))
 - **sni** (Block List, Max: 1) (see [below for nested schema](#nestedblock--options--sni))
@@ -179,6 +184,42 @@ Optional:
 - **enabled** (Boolean)
 
 
+<a id="nestedblock--options--ignore_query_string"></a>
+### Nested Schema for `options.ignore_query_string`
+
+Required:
+
+- **value** (Boolean)
+
+Optional:
+
+- **enabled** (Boolean)
+
+
+<a id="nestedblock--options--query_params_blacklist"></a>
+### Nested Schema for `options.query_params_blacklist`
+
+Required:
+
+- **value** (Set of String)
+
+Optional:
+
+- **enabled** (Boolean)
+
+
+<a id="nestedblock--options--query_params_whitelist"></a>
+### Nested Schema for `options.query_params_whitelist`
+
+Required:
+
+- **value** (Set of String)
+
+Optional:
+
+- **enabled** (Boolean)
+
+
 <a id="nestedblock--options--redirect_http_to_https"></a>
 ### Nested Schema for `options.redirect_http_to_https`
 

docs/resources/gcore_lblistener.md

@@ -25,11 +25,6 @@ resource "gcore_loadbalancer" "lb" {
   region_id = 1
   name = "test"
   flavor = "lb1-1-2"
-  listener {
-    name = "test"
-    protocol = "HTTP"
-    protocol_port = 80
-  }
 
   listener {
     name = "test3"

examples/resources/gcore_cdn_rule/resource.tf

@@ -48,6 +48,7 @@ resource "gcore_cdn_rule" "cdn_example_com_rule_2" {
   name = "All JS scripts"
   rule = "/folder/images/*.js"
   rule_type = 0
+  origin_protocol = "HTTP"
 
   options {
     redirect_http_to_https {

gcore/provider.go

@@ -56,7 +56,7 @@ func Provider() *schema.Provider {
 			"gcore_platform": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "Platform url is used for generate jwt",
+				Description: "Platform URL is used for generate JWT",
 				DefaultFunc: schema.EnvDefaultFunc("GCORE_PLATFORM", "https://api.gcdn.co"),
 			},
 			"gcore_api": {

gcore/resource_gcore_cdn_rule.go

@@ -37,10 +37,10 @@ func resourceCDNRule() *schema.Resource {
 				Required:    true,
 				Description: "Type of rule. The rule is applied if the requested URI matches the rule pattern. It has two possible values: Type 0 — RegEx. Must start with '^/' or '/'. Type 1 — RegEx. Legacy type. Note that for this rule type we automatically add / to each rule pattern before your regular expression. Please use Type 0.",
 			},
-			"override_origin_protocol": {
+			"origin_protocol": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "This option defines the protocol that will be used by CDN servers to request content from an origin source. If not specified, we will use HTTP to connect to an origin server. Possible values are: HTTPS, HTTP, MATCH.",
+				Description: "This option defines the protocol that will be used by CDN servers to request content from an origin source. If not specified, it will be inherit from resource. Possible values are: HTTPS, HTTP, MATCH.",
 			},
 			"options": optionsSchema,
 		},
@@ -62,8 +62,8 @@ func resourceCDNRuleCreate(ctx context.Context, d *schema.ResourceData, m interf
 	req.Rule = d.Get("rule").(string)
 	req.RuleType = d.Get("rule_type").(int)
 
-	if d.Get("override_origin_protocol") != nil && d.Get("override_origin_protocol") != "" {
-		req.OverrideOriginProtocol = pointer.ToString(d.Get("override_origin_protocol").(string))
+	if d.Get("origin_protocol") != nil && d.Get("origin_protocol") != "" {
+		req.OverrideOriginProtocol = pointer.ToString(d.Get("origin_protocol").(string))
 	}
 
 	resourceID := d.Get("resource_id").(int)
@@ -103,7 +103,7 @@ func resourceCDNRuleRead(ctx context.Context, d *schema.ResourceData, m interfac
 	d.Set("name", result.Name)
 	d.Set("rule", result.Pattern)
 	d.Set("rule_type", result.Type)
-	d.Set("override_origin_protocol", result.OverrideOriginProtocol)
+	d.Set("origin_protocol", result.OriginProtocol)
 	if err := d.Set("options", optionsToList(result.Options)); err != nil {
 		return diag.FromErr(err)
 	}
@@ -128,8 +128,8 @@ func resourceCDNRuleUpdate(ctx context.Context, d *schema.ResourceData, m interf
 	req.Rule = d.Get("rule").(string)
 	req.RuleType = d.Get("rule_type").(int)
 
-	if d.Get("override_origin_protocol") != nil && d.Get("override_origin_protocol") != "" {
-		req.OverrideOriginProtocol = pointer.ToString(d.Get("override_origin_protocol").(string))
+	if d.Get("origin_protocol") != nil && d.Get("origin_protocol") != "" {
+		req.OverrideOriginProtocol = pointer.ToString(d.Get("origin_protocol").(string))
 	}
 
 	req.Options = listToOptions(d.Get("options").([]interface{}))

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/G-Core/gcorelabscloud-go v0.4.42
 	github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320
 	github.com/hashicorp/terraform-exec v0.15.0 // indirect
+	github.com/hashicorp/terraform-plugin-docs v0.5.1 // indirect
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.10.1
 	github.com/mattn/go-colorable v0.1.11 // indirect
 	github.com/mitchellh/mapstructure v1.4.1