provider/opc: Update documentation

Updates documentation to add code-block tags, and populate the importability documentation page.
This commit is contained in:
Jake Champlin 2017-04-25 15:23:35 -04:00
parent 4441c6f53b
commit 77b996df6a
No known key found for this signature in database
GPG Key ID: DC31F41958EF4AC2
27 changed files with 110 additions and 70 deletions

View File

@ -174,6 +174,30 @@ To make a resource importable, please see the
* openstack_networking_secgroup_v2
* openstack_networking_subnet_v2
### OPC (Oracle Public Cloud)
* opc_compute_acl
* opc_compute_image_list
* opc_compute_instance
* opc_compute_ip_address_association
* opc_compute_ip_address_prefix_set
* opc_compute_ip_address_reservation
* opc_compute_ip_association
* opc_compute_ip_network_exchange
* opc_compute_ip_network
* opc_compute_ip_reservation
* opc_compute_route
* opc_compute_sec_rule
* opc_compute_security_application
* opc_compute_security_association
* opc_compute_security_ip_list
* opc_compute_security_list
* opc_compute_security_protocol
* opc_compute_security_rule
* opc_compute_ssh_key
* opc_compute_storage_volume_snapshot
* opc_compute_storage_volume
### PostgreSQL
* postgresql_database

View File

@ -12,7 +12,7 @@ Use this data source to access the configuration of an instance's network interf
## Example Usage
```
```hcl
data "opc_compute_network_interface" "foo" {
instance_id = "${opc_compute_instance.my_instance.id}"
instance_name = "${opc_compute_instance.my_instance.name}"

View File

@ -12,7 +12,7 @@ Use this data source to access the configuration of a Virtual NIC.
## Example Usage
```
```hcl
data "opc_compute_vnic" "current" {
name = "my_vnic_name"
}

View File

@ -14,7 +14,7 @@ Use the navigation to the left to read about the available resources.
## Example Usage
```
```hcl
# Configure the Oracle Public Cloud
provider "opc" {
user = "..."

View File

@ -12,7 +12,7 @@ The ``opc_compute_acl`` resource creates and manages an ACL in an OPC identity d
## Example Usage
```
```hcl
resource "opc_compute_acl" "default" {
name = "ACL1"
description = "This is a description for an acl"
@ -40,6 +40,6 @@ In addition to the above, the following values are exported:
ACL's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_acl.acl1 example
```shell
$ terraform import opc_compute_acl.acl1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_image_list`` resource creates and manages an Image List in an
## Example Usage
```
```hcl
resource "opc_compute_image_list" "test" {
name = "imagelist1"
description = "This is a description of the Image List"
@ -34,6 +34,6 @@ The following arguments are supported:
Image List's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_image_list.imagelist1 example
```shell
$ terraform import opc_compute_image_list.imagelist1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_image_list_entry`` resource creates and manages an Image List
## Example Usage
```
```hcl
resource "opc_compute_image_list" "test" {
name = "imagelist1"
description = "This is a description of the Image List"
@ -53,6 +53,6 @@ In addition to the above arguments, the following attributes are exported
Image List's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_image_list_entry.entry1 example
```shell
$ terraform import opc_compute_image_list_entry.entry1 example
```

View File

@ -18,7 +18,7 @@ on your instance resources as an extra safety measure.
## Example Usage
```
```hcl
resource "opc_compute_ip_network" "test" {
name = "internal-network"
description = "Terraform Provisioned Internal Network"
@ -193,6 +193,6 @@ For example, in the Web Console an instance's fully qualified name is:
The instance can be imported as such:
```
terraform import opc_compute_instance.instance1 instance_name/instance_id
```shell
$ terraform import opc_compute_instance.instance1 instance_name/instance_id
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ip_address_association`` resource creates and manages an IP ad
## Example Usage
```
```hcl
resource "opc_compute_ip_address_association" "default" {
name = "PrefixSet1"
ip_address_reservation = "${opc_compute_ip_address_reservation.default.name}"
@ -43,6 +43,6 @@ In addition to the above, the following variables are exported:
IP Address Associations can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ip_address_association.default example
```shell
$ terraform import opc_compute_ip_address_association.default example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ip_address_prefix_set`` resource creates and manages an IP add
## Example Usage
```
```hcl
resource "opc_compute_ip_address_prefix_set" "default" {
name = "PrefixSet1"
prefixes = ["192.168.0.0/16", "172.120.0.0/24"]
@ -40,6 +40,6 @@ In addition to the above, the following variables are exported:
IP Address Prefix Set can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ip_address_prefix_set.default example
```shell
$ terraform import opc_compute_ip_address_prefix_set.default example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ip_address_reservation`` resource creates and manages an IP ad
## Example Usage
```
```hcl
resource "opc_compute_ip_address_reservation" "default" {
name = "IPAddressReservation1"
ip_address_pool = "public-ippool"
@ -36,3 +36,11 @@ In addition to the above, the following attributes are exported:
* `ip_address` - Reserved NAT IPv4 address from the IP address pool.
* `uri` - The Uniform Resource Identifier of the ip address reservation
## Import
IP Address Reservations can be imported using the `resource name`, e.g.
```shell
$ terraform import opc_compute_ip_address_reservation.default example
```

View File

@ -13,7 +13,7 @@ an OPC identity domain, for the Shared Network.
## Example Usage
```
```hcl
resource "opc_compute_ip_association" "instance1_reservation1" {
vcable = "${opc_compute_instance.test_instance.vcable}"
parentpool = "ipreservation:${opc_compute_ip_reservation.reservation1.name}"
@ -41,6 +41,6 @@ The following attributes are exported:
IP Associations can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ip_association.association1 example
```shell
$ terraform import opc_compute_ip_association.association1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ip_network`` resource creates and manages an IP Network.
## Example Usage
```
```hcl
resource "opc_compute_ip_network" "foo" {
name = "my-ip-network"
description = "my IP Network"
@ -52,3 +52,11 @@ The following attributes are exported:
* `public_napt_enabled` - Whether public internet access using NAPT for VNICs without any public IP Reservation or not.
* `uri` - Uniform Resource Identifier for the IP Network
## Import
IP Networks can be imported using the `resource name`, e.g.
```shell
$ terraform import opc_compute_ip_network.default example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ip_network_exchange`` resource creates and manages an IP netwo
## Example Usage
```
```hcl
resource "opc_compute_ip_network_exchange" "default" {
name = "NetworkExchange1"
}
@ -32,6 +32,6 @@ The following arguments are supported:
IP Network Exchange's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ip_network_exchange.exchange1 example
```shell
$ terraform import opc_compute_ip_network_exchange.exchange1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ip_reservation`` resource creates and manages an IP reservatio
## Example Usage
```
```hcl
resource "opc_compute_ip_reservation" "reservation1" {
parent_pool = "/oracle/public/ippool"
permanent = true
@ -38,6 +38,6 @@ deleted and recreated (if false).
IP Reservations can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ip_reservations.reservation1 example
```shell
$ terraform import opc_compute_ip_reservations.reservation1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_route`` resource creates and manages a route for an IP Network
## Example Usage
```
```hcl
resource "opc_compute_route" "foo" {
name = "my-route"
description = "my IP Network route"
@ -55,6 +55,6 @@ The following attributes are exported:
Route's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_route.route1 example
```shell
$ terraform import opc_compute_route.route1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_sec_rule`` resource creates and manages a sec rule in an OPC i
## Example Usage
```
```hcl
resource "opc_compute_sec_rule" "test_rule" {
name = "test"
source_list = "seclist:${opc_compute_security_list.sec-list1.name}"
@ -52,6 +52,6 @@ In addition to the above, the following values are exported:
Sec Rule's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_sec_rule.rule1 example
```shell
$ terraform import opc_compute_sec_rule.rule1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_security_application`` resource creates and manages a security
## Example Usage (TCP)
```
```hcl
resource "opc_compute_security_application" "tomcat" {
name = "tomcat"
protocol = "tcp"
@ -22,7 +22,7 @@ resource "opc_compute_security_application" "tomcat" {
## Example Usage (ICMP)
```
```hcl
resource "opc_compute_security_application" "tomcat" {
name = "tomcat"
protocol = "icmp"
@ -52,6 +52,6 @@ The following arguments are supported:
Security Application's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_security_application.application1 example
```shell
$ terraform import opc_compute_security_application.application1 example
```

View File

@ -13,7 +13,7 @@ list in an OPC identity domain.
## Example Usage
```
```hcl
resource "opc_compute_security_association" "test_instance_sec_list_1" {
name = "association1"
vcable = "${opc_compute_instance.test_instance.vcable}"
@ -35,6 +35,6 @@ The following arguments are supported:
Security Association's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_security_association.association1 example
```shell
$ terraform import opc_compute_security_association.association1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_security_ip_list`` resource creates and manages a security IP
## Example Usage
```
```hcl
resource "opc_compute_security_ip_list" "sec_ip_list1" {
name = "sec-ip-list1"
ip_entries = ["217.138.34.4"]
@ -33,6 +33,6 @@ The following arguments are supported:
IP List's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ip_list.list1 example
```shell
$ terraform import opc_compute_ip_list.list1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_security_list`` resource creates and manages a security list i
## Example Usage
```
```hcl
resource "opc_compute_security_list" "sec_list1" {
name = "sec-list-1"
policy = "permit"
@ -36,6 +36,6 @@ The following arguments are supported:
Security List's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_security_list.list1 example
```shell
$ terraform import opc_compute_security_list.list1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_security_protocol`` resource creates and manages a security pr
## Example Usage
```
```hcl
resource "opc_compute_security_protocol" "default" {
name = "security-protocol-1"
dst_ports = ["2045-2050"]
@ -60,6 +60,6 @@ In addition to the above, the following values are exported:
ACL's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_security_protocol.default example
```shell
$ terraform import opc_compute_security_protocol.default example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_security_rule`` resource creates and manages a security rule i
## Example Usage
```
```hcl
resource "opc_compute_security_rule" "default" {
name = "SecurityRule1"
flow_direction = "ingress"
@ -57,6 +57,6 @@ In addition to the above, the following attributes are exported:
Security Rule's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_security_rule.rule1 example
```shell
$ terraform import opc_compute_security_rule.rule1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_ssh_key`` resource creates and manages an SSH key in an OPC id
## Example Usage
```
```hcl
resource "opc_compute_ssh_key" "%s" {
name = "test-key"
key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCqw6JwbjIk..."
@ -35,6 +35,6 @@ without removing it entirely from your Terraform resource definition. Defaults t
SSH Key's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_ssh_key.key1 example
```shell
$ terraform import opc_compute_ssh_key.key1 example
```

View File

@ -14,7 +14,7 @@ The ``opc_compute_storage_volume`` resource creates and manages a storage volume
## Example Usage
```
```hcl
resource "opc_compute_storage_volume" "test" {
name = "storageVolume1"
description = "Description for the Storage Volume"
@ -24,7 +24,7 @@ resource "opc_compute_storage_volume" "test" {
```
## Example Usage (Bootable Volume)
```
```hcl
resource "opc_compute_image_list" "test" {
name = "imageList1"
description = "Description for the Image List"
@ -77,6 +77,6 @@ The following attributes are exported:
Storage Volume's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_storage_volume.volume1 example
```shell
$ terraform import opc_compute_storage_volume.volume1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_storage_volume_snapshot`` resource creates and manages a stora
## Example Usage
```
```hcl
resource "opc_compute_storage_volume_snapshot" "test" {
name = "storageVolume1"
description = "Description for the Storage Volume"
@ -54,6 +54,6 @@ In addition to the attributes above, the following attributes are exported:
Storage Volume Snapshot's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_storage_volume_snapshot.volume1 example
```shell
$ terraform import opc_compute_storage_volume_snapshot.volume1 example
```

View File

@ -12,7 +12,7 @@ The ``opc_compute_vnic_set`` resource creates and manages a virtual NIC set in a
## Example Usage
```
```hcl
resource "opc_compute_vnic_set" "test_set" {
name = "test_vnic_set"
description = "My vnic set"
@ -40,6 +40,6 @@ The following arguments are supported:
VNIC Set's can be imported using the `resource name`, e.g.
```
terraform import opc_compute_vnic_set.set1 example
```shell
$ terraform import opc_compute_vnic_set.set1 example
```