From 2d7be9bb9ea9fd9435aba168a8dd4cc30ab36154 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 29 Mar 2017 19:30:04 +0200 Subject: [PATCH] Hooking up the OracleOPC Docs --- website/source/assets/stylesheets/_docs.scss | 1 + .../d/opc_compute_vnic.html.markdown | 36 +++++++++++ .../providers/oracleopc/index.html.markdown | 55 +++++++++++++++++ .../r/opc_compute_instance.html.markdown | 4 +- .../opc_compute_ip_association.html.markdown | 6 +- .../opc_compute_ip_reservation.html.markdown | 6 +- ...compute_security_application.html.markdown | 8 +-- ...compute_security_association.html.markdown | 8 +-- ...opc_compute_security_ip_list.html.markdown | 8 +-- .../r/opc_compute_security_list.html.markdown | 8 +-- .../r/opc_compute_security_rule.html.markdown | 8 +-- .../r/opc_compute_ssh_key.html.markdown | 6 +- .../opc_compute_storage_volume.html.markdown | 4 +- website/source/layouts/docs.erb | 4 ++ website/source/layouts/oracleopc.erb | 59 +++++++++++++++++++ 15 files changed, 188 insertions(+), 33 deletions(-) create mode 100644 website/source/docs/providers/oracleopc/d/opc_compute_vnic.html.markdown create mode 100644 website/source/docs/providers/oracleopc/index.html.markdown create mode 100644 website/source/layouts/oracleopc.erb diff --git a/website/source/assets/stylesheets/_docs.scss b/website/source/assets/stylesheets/_docs.scss index 35f16eb60..9f2922c21 100755 --- a/website/source/assets/stylesheets/_docs.scss +++ b/website/source/assets/stylesheets/_docs.scss @@ -50,6 +50,7 @@ body.layout-nomad, body.layout-ns1, body.layout-openstack, body.layout-opsgenie, +body.layout-oracleopc, body.layout-packet, body.layout-pagerduty, body.layout-postgresql, diff --git a/website/source/docs/providers/oracleopc/d/opc_compute_vnic.html.markdown b/website/source/docs/providers/oracleopc/d/opc_compute_vnic.html.markdown new file mode 100644 index 000000000..78be49c4a --- /dev/null +++ b/website/source/docs/providers/oracleopc/d/opc_compute_vnic.html.markdown @@ -0,0 +1,36 @@ +--- +layout: "oracleopc" +page_title: "Oracle: opc_compute_vnic" +sidebar_current: "docs-oracleopc-datasource-vnic" +description: |- + Gets information about the configuration of a Virtual NIC. +--- + +# opc\_compute\_vnic + +Use this data source to access the configuration of a Virtual NIC. + +## Example Usage + +``` +data "opc_compute_vnic" "current" {} + +output "mac_address" { + value = "${data.opc_compute_vnic.current.mac_address}" +} +``` + +## Argument Reference +* `name` is the name of the Virtual NIC. + +## Attributes Reference + +* `description` is a description of the Virtual NIC. + +* `mac_address` is the MAC Address of the Virtual NIC. + +* `tags` is a list of Tags associated with the Virtual NIC. + +* `transit_flag` is `true` if the Virtual NIC is of the type `transit`. + +* `uri` is the Unique Resource Locator of the Virtual NIC. diff --git a/website/source/docs/providers/oracleopc/index.html.markdown b/website/source/docs/providers/oracleopc/index.html.markdown new file mode 100644 index 000000000..598346919 --- /dev/null +++ b/website/source/docs/providers/oracleopc/index.html.markdown @@ -0,0 +1,55 @@ +--- +layout: "oracleopc" +page_title: "Provider: Oracle Public Cloud" +sidebar_current: "docs-oracleopc-index" +description: |- + The Oracle Public Cloud provider is used to interact with the many resources supported by the Oracle Public Cloud. The provider needs to be configured with credentials for the Oracle Public Cloud API. +--- + +# Oracle Public Cloud Provider + +The Oracle Public Cloud provider is used to interact with the many resources supported by the Oracle Public Cloud. The provider needs to be configured with credentials for the Oracle Public Cloud API. + +Use the navigation to the left to read about the available resources. + +## Example Usage + +``` +# Configure the Oracle Public Cloud +provider "oracle" { + user = "..." + password = "..." + identity_domain = "..." + endpoint = "..." +} + +# Create an IP Reservation +resource "opc_compute_ip_reservation" "production" { + parent_pool = "/oracle/public/ippool" + permanent = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `user` - (Optional) The username to use, generally your email address. It can also + be sourced from the `OPC_USERNAME` environment variable. + +* `password` - (Optional) The password associated with the username to use. It can also be sourced from + the `OPC_PASSWORD` environment variable. + +* `identity_domain` - (Optional) The identity domain to use. It can also be sourced from + the `OPC_IDENTITY_DOMAIN` environment variable. + +* `endpoint` - (Optional) The API endpoint to use, associated with your Oracle Public Cloud account. This is known as the `REST Endpoint` within the Oracle portal. It can also be sourced from the `OPC_ENDPOINT` environment variable. + +Max num seconds to wait for successful response when operating on resources within OPC (defaults to 3000) +* `max_retry_timeout` - (Optional) The maximum number of seconds to wait for a successful response when operating on resources within Oracle Public Cloud. It can also be sourced from the `OPC_MAX_RETRY_TIMEOUT` environment variable. Defaults to 3000 seconds. + +## Testing + +Credentials must be provided via the `OPC_USERNAME`, `OPC_PASSWORD`, +`OPC_IDENTITY_DOMAIN` and `OPC_ENDPOINT` environment variables in order to run +acceptance tests. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_instance.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_instance.html.markdown index 04762b5c3..faeb3ee7c 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_instance.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_instance.html.markdown @@ -1,7 +1,7 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_instance" -sidebar_current: "docs-opc-resource-instance" +sidebar_current: "docs-oracleopc-resource-instance" description: |- Creates and manages an instance in an OPC identity domain. --- diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_ip_association.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_ip_association.html.markdown index deeed76c4..2518b2df1 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_ip_association.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_ip_association.html.markdown @@ -1,7 +1,7 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_ip_association" -sidebar_current: "docs-opc-resource-ip-association" +sidebar_current: "docs-oracleopc-resource-ip-association" description: |- Creates and manages an IP association in an OPC identity domain. --- @@ -28,4 +28,4 @@ The following arguments are supported: * `parentpool` - (Required) The pool from which to take an IP address. To associate a specific reserved IP address, use the prefix `ipreservation:` followed by the name of the IP reservation. To allocate an IP address from a pool, use the -prefix `ippool:`, e.g. `ippool:/oracle/public/ippool`. \ No newline at end of file +prefix `ippool:`, e.g. `ippool:/oracle/public/ippool`. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_ip_reservation.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_ip_reservation.html.markdown index 7c44c62ea..44b70cc0f 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_ip_reservation.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_ip_reservation.html.markdown @@ -1,7 +1,7 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_ip_reservation" -sidebar_current: "docs-opc-resource-ip-assocation" +sidebar_current: "docs-oracleopc-resource-ip-reservation" description: |- Creates and manages an IP reservation in an OPC identity domain. --- @@ -30,4 +30,4 @@ The following arguments are supported: (if true), or may be returned to the pool and replaced with a different IP address when an instance is restarted, or deleted and recreated (if false). -* `tags` - (Optional) List of tags that may be applied to the IP reservation. \ No newline at end of file +* `tags` - (Optional) List of tags that may be applied to the IP reservation. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_security_application.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_security_application.html.markdown index fe8c9ba3c..94760f082 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_security_application.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_security_application.html.markdown @@ -1,12 +1,12 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_security_application" -sidebar_current: "docs-opc-resource-security-application" +sidebar_current: "docs-oracleopc-resource-security-application" description: |- Creates and manages a security application in an OPC identity domain. --- -# opc\_compute\_ip\_reservation +# opc\_compute\_security\_application The ``opc_compute_security_application`` resource creates and manages a security application in an OPC identity domain. @@ -36,4 +36,4 @@ the corresponding integer in the range 0-254 from the list of [assigned protocol `echo`, `reply`, `ttl`, `traceroute`, `unreachable`. * `icmpcode` - (Optional) The ICMP code to enable for this application, if the `protocol` is `icmp`. Must be one of -`network`, `host`, `protocol`, `port`, `df`, `admin`. \ No newline at end of file +`network`, `host`, `protocol`, `port`, `df`, `admin`. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_security_association.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_security_association.html.markdown index 170acc2ea..49207c879 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_security_association.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_security_association.html.markdown @@ -1,12 +1,12 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_security_association" -sidebar_current: "docs-opc-resource-security-association" +sidebar_current: "docs-oracleopc-resource-security-association" description: |- Creates and manages a security association in an OPC identity domain. --- -# opc\_compute\_ip\_reservation +# opc\_compute\_security\_association The ``opc_compute_security_association`` resource creates and manages an association between an instance and a security list in an OPC identity domain. @@ -26,4 +26,4 @@ The following arguments are supported: * `vcable` - (Required) The `vcable` of the instance to associate to the security list. -* `seclist` - (Required) The name of the security list to associate the instance to. \ No newline at end of file +* `seclist` - (Required) The name of the security list to associate the instance to. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_security_ip_list.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_security_ip_list.html.markdown index bded4c30e..62f40d839 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_security_ip_list.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_security_ip_list.html.markdown @@ -1,12 +1,12 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_security_ip_list" -sidebar_current: "docs-opc-resource-security-list" +sidebar_current: "docs-oracleopc-resource-security-ip-list" description: |- Creates and manages a security IP list in an OPC identity domain. --- -# opc\_compute\_ip\_reservation +# opc\_compute\_security\_ip\_list The ``opc_compute_security_ip_list`` resource creates and manages a security IP list in an OPC identity domain. @@ -25,4 +25,4 @@ The following arguments are supported: * `name` - (Required) The unique (within the identity domain) name of the security IP list. -* `ip_entries` - (Required) The IP addresses to include in the list. \ No newline at end of file +* `ip_entries` - (Required) The IP addresses to include in the list. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_security_list.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_security_list.html.markdown index 7da5e5668..64547a41e 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_security_list.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_security_list.html.markdown @@ -1,12 +1,12 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_security_list" -sidebar_current: "docs-opc-resource-security-list" +sidebar_current: "docs-oracleopc-resource-security-list" description: |- Creates and manages a security list in an OPC identity domain. --- -# opc\_compute\_ip\_reservation +# opc\_compute\_security\_list The ``opc_compute_security_list`` resource creates and manages a security list in an OPC identity domain. @@ -30,4 +30,4 @@ The following arguments are supported: `reject` (packets are dropped but a reply is sent) and `deny` (packets are dropped and no reply is sent). * `output_cidr_policy` - (Required) The policy for outbound traffic from the security list.Must be one of `permit`, -`reject` (packets are dropped but a reply is sent) and `deny` (packets are dropped and no reply is sent). \ No newline at end of file +`reject` (packets are dropped but a reply is sent) and `deny` (packets are dropped and no reply is sent). diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_security_rule.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_security_rule.html.markdown index 02c4b7533..6497b0265 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_security_rule.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_security_rule.html.markdown @@ -1,7 +1,7 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_security_rule" -sidebar_current: "docs-opc-resource-security-rule" +sidebar_current: "docs-oracleopc-resource-security-rule" description: |- Creates and manages a security rule in an OPC identity domain. --- @@ -33,7 +33,7 @@ The following arguments are supported: * `source_list` - (Required) The source security list (prefixed with `seclist:`), or security IP list (prefixed with `seciplist:`). - + * `destination_list` - (Required) The destination security list (prefixed with `seclist:`), or security IP list (prefixed with `seciplist:`). @@ -43,4 +43,4 @@ The following arguments are supported: be `permit`. * `disabled` - (Required) Whether to disable this security rule. This is useful if you want to temporarily disable a rule -without removing it outright from your Terraform resource definition. \ No newline at end of file +without removing it outright from your Terraform resource definition. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_ssh_key.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_ssh_key.html.markdown index 9655653a9..ff85467d8 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_ssh_key.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_ssh_key.html.markdown @@ -1,7 +1,7 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_ssh_key" -sidebar_current: "docs-opc-resource-instance" +sidebar_current: "docs-oracleopc-resource-ssh-key" description: |- Creates and manages an SSH key in an OPC identity domain. --- @@ -29,4 +29,4 @@ The following arguments are supported: * `key` - (Required) The SSH key itself * `enabled` - (Required) Whether or not the key is enabled. This is useful if you want to temporarily disable an SSH key, -without removing it entirely from your Terraform resource definition. \ No newline at end of file +without removing it entirely from your Terraform resource definition. diff --git a/website/source/docs/providers/oracleopc/r/opc_compute_storage_volume.html.markdown b/website/source/docs/providers/oracleopc/r/opc_compute_storage_volume.html.markdown index 0e91a8ad7..4b30b59ed 100644 --- a/website/source/docs/providers/oracleopc/r/opc_compute_storage_volume.html.markdown +++ b/website/source/docs/providers/oracleopc/r/opc_compute_storage_volume.html.markdown @@ -1,7 +1,7 @@ --- -layout: "oracle" +layout: "oracleopc" page_title: "Oracle: opc_compute_storage_volume" -sidebar_current: "docs-opc-resource-storage_volume" +sidebar_current: "docs-oracleopc-resource-storage-volume" description: |- Creates and manages a storage volume in an OPC identity domain. --- diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 1f42c1e32..77d5bf2c3 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -355,6 +355,10 @@ OpsGenie + > + Oracle OPC + + > Packet diff --git a/website/source/layouts/oracleopc.erb b/website/source/layouts/oracleopc.erb new file mode 100644 index 000000000..a9d9579f8 --- /dev/null +++ b/website/source/layouts/oracleopc.erb @@ -0,0 +1,59 @@ +<% wrap_layout :inner do %> +<% content_for :sidebar do %> + +<% end %> + +<%= yield %> +<% end %>