Skip to content

Commit b21864d

Browse files
committed
Update bug templates to include Oracle support procedures
1 parent e2b511b commit b21864d

File tree

4 files changed

+67
-9
lines changed

4 files changed

+67
-9
lines changed

.github/ISSUE_TEMPLATE/Bug_Report.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,26 @@ labels: bug
55
---
66

77
<!---
8-
Please note the following potential times when an issue might be in Terraform core:
8+
Before filing a bug report, see if your issue is already covered in the [troubleshooting guide](https://www.terraform.io/docs/providers/oci/guides/troubleshooting.html)
99
10+
Please note the following times when an issue is likely outside of the OCI provider.
11+
This could be either due to issues in the Oracle Cloud Infrastructure service or the Terraform core.
12+
13+
Examples of Oracle Cloud Infrastructure service issues:
14+
* You receive an error with HTTP status code such as 500
15+
* One of your resources timed out while waiting to reach a specific state, even after increasing your operation timeout value
16+
17+
If you are running into one of the above scenarios, we recommend contacting Oracle support at https://docs.cloud.oracle.com/iaas/Content/GSG/Tasks/contactingsupport.htm
18+
19+
20+
Examples of Terraform core issues:
1021
* [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues
1122
* [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues
1223
* [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues
1324
* [Registry](https://registry.terraform.io/) issues
1425
* Spans resources across multiple providers
1526
16-
If you are running into one of these scenarios, we recommend opening an issue in the [Terraform core repository](https://github.com/hashicorp/terraform/) instead.
27+
If you are running into a Terraform core issue, we recommend opening an issue in the [Terraform core repository](https://github.com/hashicorp/terraform/) instead.
1728
--->
1829

1930
<!--- Please keep this note for the community --->

.github/ISSUE_TEMPLATE/Question.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ labels: question
66

77
This Github template is intended for questions regarding the Terraform **Oracle Cloud Infrastructure** provider.
88

9+
Before using this template, check whether your question is already answered in one of the following guides:
10+
* [Frequently Asked Questions](https://www.terraform.io/docs/providers/oci/guides/faq.html)
11+
* [Troubleshooting](https://www.terraform.io/docs/providers/oci/guides/troubleshooting.html)
12+
13+
14+
If you have a support request related to Oracle Cloud Infrastructure services, please [contact Oracle support](https://docs.cloud.oracle.com/iaas/Content/GSG/Tasks/contactingsupport.htm)
15+
916
If you have a support request or question related to core Terraform functionality, please submit them to one of these resources:
1017

1118
* [Terraform community resources](https://www.terraform.io/docs/extend/community/index.html)

website/docs/guides/faq.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ See - http://darylscorner.com/2016/11/using-terraform-across-multiple-cloud-prov
3030
The change you made outside of Terraform will be overwritten the next time you apply the configuration unless you add the `ignore_changes` parameter to the resource in the configuration file.
3131

3232
#### Q: How do I get help?
33-
You can file an issue against the project
33+
First, see if your question is already answered by the [troubleshooting guide](https://www.terraform.io/docs/providers/oci/guides/troubleshooting.html)
34+
35+
You can also file an issue against the project
3436
https://github.com/terraform-providers/terraform-provider-oci/issues
3537

3638
or meet us in the OCI forums

website/docs/guides/troubleshooting.html.markdown

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,37 @@ sidebar_current: "docs-oci-guide-troubleshooting"
55
description: |-
66
The Oracle Cloud Infrastructure provider. Troubleshooting
77
---
8+
9+
## Troubleshooting
10+
11+
When troubleshooting or getting support for the OCI Terraform Provider, it is often useful to first check the status of the OCI services and to collect verbose logging.
12+
13+
14+
### Checking OCI service status and outages
15+
16+
To check on the latest status and whether there are any outages in OCI, see [OCI Status](https://ocistatus.oraclecloud.com/)
17+
18+
19+
### Verbose logging for OCI Terraform Provider
20+
21+
To get verbose console output when the provider is running, precede your Terraform command with the `TF_LOG` and `OCI_GO_SDK_DEBUG` flags:
22+
23+
```sh
24+
TF_LOG=DEBUG OCI_GO_SDK_DEBUG=v terraform plan
25+
```
26+
27+
The [tf_log](https://www.terraform.io/docs/internals/debugging.html) level and `OCI_GO_SDK_DEBUG` flags can also be set as environment variables.
28+
29+
30+
## Common Issues
31+
832
### Not Authenticated Error when configuring Terraform
933

1034
_If the Terraform CLI gives an error message like:_
1135

12-
`* oci_core_vcn.resource1: Service error:NotAuthenticated. The required information to complete authentication was not provided or was incorrect.. http status code: 401`
36+
```
37+
* oci_core_vcn.resource1: Service error:NotAuthenticated. The required information to complete authentication was not provided or was incorrect.. http status code: 401
38+
```
1339

1440
* Verify you have properly set `user_ocid`, `tenancy_ocid`, `fingerprint` and `private_key_path`
1541
* Verify your `private_key_path` is pointing to your private key and not the corresponding public key
@@ -50,12 +76,24 @@ export https_proxy=http://www.your-proxy.com:80/
5076
export no_proxy=localhost,127.0.0.1
5177
```
5278

53-
### Verbose logging for OCI Terraform Provider
5479

55-
To get verbose console output when the provider is running, precede your Terraform command with the `TF_LOG` and `OCI_GO_SDK_DEBUG` flags:
80+
### Errors about service limits
81+
82+
While using Terraform, you may encounter errors indicating that you have reached or exceeded the service limits for a resource.
83+
84+
To understand more about your OCI service limits and how to request a limit increase, see [Service Limits](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm)
85+
86+
87+
### Timeout errors when waiting for a state change
88+
89+
_If the Terraform CLI gives an error message like:_
5690

57-
```sh
58-
TF_LOG=DEBUG OCI_GO_SDK_DEBUG=v terraform plan
91+
```
92+
* oci_database_backup.mydb: timeout while waiting for state to become 'ACTIVE' (last state: 'CREATING', timeout: 15m0s)
5993
```
6094

61-
The [tf_log](https://www.terraform.io/docs/internals/debugging.html) level and `OCI_GO_SDK_DEBUG` flags can also be set as environment variables.
95+
Then the OCI service is indicating that the resource has not yet reached the expected state after polling for some time.
96+
97+
You may need to increase the operation timeout for your resource to continue polling for longer. See [Operation Timeouts](https://www.terraform.io/docs/configuration/resources.html#operation-timeouts) for details on how to do this.
98+
99+

0 commit comments

Comments
 (0)