Skip to content

Commit cdd6166

Browse files
authored
Update readme to emphasize terraform v0.10.x usage (#312)
* Update readme to emphasize terraform v0.10.x usage * Update policy md to specify compartment_id as required param
1 parent e09d5ff commit cdd6166

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Oracle customers now have access to an enterprise class, developer friendly orch
1919
This Terraform provider is OSS, available to all OCI customers at no charge.
2020

2121
## Compatibility
22-
The provider is compatible with Terraform .9.\*.
22+
The provider is compatible with Terraform v0.10.x.
2323

2424
### Coverage
2525
The Terraform provider provides coverage for the entire OCI API, with some minor exceptions.
@@ -28,11 +28,11 @@ The Terraform provider provides coverage for the entire OCI API, with some minor
2828
Be sure to read the FAQ and Writing Terraform configurations for OCI in [/docs](https://github.com/oracle/terraform-provider-oci/tree/master/docs).
2929

3030
### Download Terraform
31-
Download the appropriate **.9.x binary** for your platform.
31+
Download the appropriate **v0.10.x binary** for your platform.
3232
https://www.terraform.io/downloads.html
3333

34-
**NOTE** Terraform v.10.x introduces a change to plugin management where
35-
previous v.9.x configuration no longer applies. See note below.
34+
**NOTE** Terraform v0.10.x introduces a change to plugin management where
35+
previous v0.9.x configuration no longer applies. See note below.
3636

3737

3838
### Install Terraform
@@ -41,9 +41,9 @@ https://www.terraform.io/intro/getting-started/install.html
4141
### Get the Oracle Cloud Infrastructure Terraform provider
4242
https://github.com/oracle/terraform-provider-oci/releases
4343

44-
Unpack the provider. Terraform v.10.x introduces a change to plugin
45-
management where v.9.x configuration no longer applies. To be compatible
46-
with both terraform v.9.x and v.10.x, put the provider in the following
44+
Unpack the provider. Terraform v0.10.x introduces a change to plugin
45+
management where v0.9.x configuration no longer applies. To be compatible
46+
with both terraform v0.9.x and v0.10.x, put the provider in the following
4747
location:
4848

4949
#### On \*nix
@@ -52,7 +52,7 @@ location:
5252
```
5353

5454
Then create the `~/.terraformrc` file that specifies the path to the
55-
`oci` provider **(only required for v.9.x)**.
55+
`oci` provider **(only required for v0.9.x)**.
5656
```
5757
providers {
5858
oci = "~/.terraform.d/plugins/terraform-provider-oci"
@@ -65,7 +65,7 @@ providers {
6565
```
6666

6767
Then create `%APPDATA%/terraform.rc` that specifies the path to the
68-
`oci` provider **(only required for v.9.x)**.
68+
`oci` provider **(only required for v0.9.x)**.
6969
```
7070
providers {
7171
oci = "%appdata%/terraform.d/plugins/terraform-provider-oci"
@@ -113,12 +113,21 @@ Edit it to include the OCID of the compartment you want to create the VCN. Remem
113113

114114
You should always plan, then apply a configuration -
115115
```
116-
# from the compute/instance directory
116+
# From the compute/instance directory
117+
118+
# Initialize the plugin for this template directory
119+
$ terraform init
120+
121+
# Run the plan command to see what will happen.
117122
$ terraform plan
118123
119-
# Make sure the plan looks right.
124+
# If the plan looks right, apply it.
120125
$ terraform apply
126+
127+
# If you are done with this infrastructure, take it down
128+
$ terraform destroy
121129
```
130+
122131
## OCI resource and datasource details
123132
https://github.com/oracle/terraform-provider-oci/tree/master/docs
124133

docs/resources/identity/policy.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Provides a policy resource.
66

77
```
88
resource "oci_identity_policy" "p" {
9+
compartment_id = <Compartment or Tenancy OCID>
910
name = "pol"
1011
description = "desc"
1112
statements = ["statementX","statementY"]
@@ -16,10 +17,11 @@ Provides a policy resource.
1617

1718
The following arguments are supported:
1819

20+
* `compartment_id` - (Required) The OCID of the compartment containing the policy (either the tenancy or another compartment).
1921
* `name` - (Required) The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.
2022
* `statements` - (Required) An array of policy statements written in the policy language.
2123
* `descriptions` - (Required) The description you assign to the policy during creation. Does not have to be unique, and it's changeable.
22-
* `version_date` - (Optional) The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.
24+
2325

2426
## Attributes Reference
2527
* `id` - The OCID of the policy.

0 commit comments

Comments
 (0)