Add objectstore namespace metadata

* consolidate object store examples into one

Author: ccushing

docs/examples/object_storage/bucket.tf

@@ -0,0 +1,23 @@
+/*
+ * This example shows how to manage a bucket
+ */
+
+resource "oci_objectstorage_bucket" "bucket1" {
+  compartment_id = "${var.compartment_ocid}"
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  name = "tf-example-bucket"
+  access_type = "NoPublicAccess"
+}
+
+data "oci_objectstorage_bucket_summaries" "buckets1" {
+  compartment_id = "${var.compartment_ocid}"
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  filter {
+    name = "name"
+    values = ["${oci_objectstorage_bucket.bucket1.name}"]
+  }
+}
+
+output buckets {
+  value = "${data.oci_objectstorage_bucket_summaries.buckets1.bucket_summaries}"
+}

docs/examples/object_storage/file_upload/file_upload.tf

@@ -0,0 +1,30 @@
+/*
+ * This example file shows how to read and output the object storage namespace and namespace_metadata.
+ */
+
+data "oci_objectstorage_namespace" "ns" {
+}
+
+output namespace {
+  value = "${data.oci_objectstorage_namespace.ns.namespace}"
+}
+
+
+resource "oci_objectstorage_namespace_metadata" "namespace-metadata1" {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  default_s3compartment_id = "${var.compartment_ocid}"
+  default_swift_compartment_id = "${var.compartment_ocid}"
+}
+
+data oci_objectstorage_namespace_metadata namespace-metadata1 {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+}
+
+output namespace-metadata {
+  value = <<EOF
+
+  namespace = ${data.oci_objectstorage_namespace_metadata.namespace-metadata1.namespace}
+  default_s3compartment_id = ${data.oci_objectstorage_namespace_metadata.namespace-metadata1.default_s3compartment_id}
+  default_swift_compartment_id = ${data.oci_objectstorage_namespace_metadata.namespace-metadata1.default_swift_compartment_id}
+EOF
+}

docs/examples/object_storage/file_upload/index.html renamed to docs/examples/object_storage/index.html

@@ -0,0 +1,38 @@
+/* This example demonstrates object store object management. It uses Terraforms built-in `file` function to upload a file.
+ * 
+ * WARNING: This should only be used with small files. The file helper does stringification so large files
+ * may cause terraform to slow, become unresponsive or exceed allowed memory usage.
+ */
+
+resource "oci_objectstorage_object" "object1" {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  bucket = "${oci_objectstorage_bucket.bucket1.name}"
+  object = "index.html"
+  content_language = "en-US"
+  content_type = "text/html"
+  content = "${file("index.html")}"
+}
+
+data "oci_objectstorage_object_head" "object-head1" {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  bucket = "${oci_objectstorage_bucket.bucket1.name}"
+  object = "${oci_objectstorage_object.object1.object}"
+}
+
+data "oci_objectstorage_objects" "objects1" {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  bucket = "${oci_objectstorage_bucket.bucket1.name}"
+}
+
+output object-head-data {
+  value = <<EOF
+
+  object = ${data.oci_objectstorage_object_head.object-head1.object}
+  content-length = ${data.oci_objectstorage_object_head.object-head1.content-length}
+  content-type = ${data.oci_objectstorage_object_head.object-head1.content-type}
+EOF
+}
+
+output objects {
+  value = "${data.oci_objectstorage_objects.objects1.objects}"
+}

docs/examples/object_storage/namespace.tf

@@ -0,0 +1,24 @@
+/*
+ * This example shows how to create preauthenticated requests for objects and buckets.
+ */
+
+resource "oci_objectstorage_preauthrequest" "bucket-par" {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  bucket = "${oci_objectstorage_bucket.bucket1.name}"
+  name = "parOnBucket"
+  access_type = "AnyObjectWrite" //Other configurations accepted are ObjectWrite, ObjectReadWrite
+  time_expires = "2020-12-10T23:00:00Z"
+}
+
+resource "oci_objectstorage_preauthrequest" "object-par" {
+  namespace = "${data.oci_objectstorage_namespace.ns.namespace}"
+  bucket = "${oci_objectstorage_bucket.bucket1.name}"
+  object = "${oci_objectstorage_object.object1.object}"
+  name = "object-par"
+  access_type = "ObjectRead" // ObjectRead, ObjectWrite, ObjectReadWrite, AnyObjectWrite
+  time_expires = "2020-12-29T23:00:00Z"
+}
+
+output "par_request_url" {
+  value = "https://objectstorage.${var.region}.oraclecloud.com${oci_objectstorage_preauthrequest.object-par.access_uri}"
+}

docs/examples/object_storage/object.tf

@@ -0,0 +1,20 @@
+/*
+ * This example file shows how to configure the oci provider to target the a single region.
+ */
+
+// These variables would commonly be defined as environment variables or sourced in a .env file
+variable "tenancy_ocid" {}
+variable "user_ocid" {}
+variable "fingerprint" {}
+variable "private_key_path" {}
+variable "compartment_ocid" {}
+variable "region" { default = "us-ashburn-1" }
+
+
+provider "oci" {
+  region = "${var.region}"
+  tenancy_ocid = "${var.tenancy_ocid}"
+  user_ocid = "${var.user_ocid}"
+  fingerprint = "${var.fingerprint}"
+  private_key_path = "${var.private_key_path}"
+}

docs/examples/object_storage/preauthrequest.tf

@@ -0,0 +1,13 @@
+    #     ___  ____     _    ____ _     _____
+    #    / _ \|  _ \   / \  / ___| |   | ____|
+    #   | | | | |_) | / _ \| |   | |   |  _|
+    #   | |_| |  _ < / ___ | |___| |___| |___
+    #    \___/|_| \_/_/   \_\____|_____|_____|
+***
+
+## Object Storage Resource and Datasource Examples
+
+This example demonstrates the following Object Storage concepts:
+* Creating Objects and buckets 
+* Defining Preauthenticated Requests for objects and buckets 
+* Accessing and modifying object store namespace metatdata

docs/examples/object_storage/preauthrequests/preauthreq.tf

@@ -0,0 +1,75 @@
+# oci_object_storage_namespace_metadata
+
+## NamespaceMetadata Resource
+
+### NamespaceMetadata Reference
+
+The following attributes are exported:
+
+* `default_s3compartment_id` - The default compartment ID for an S3 client.
+* `default_swift_compartment_id` - The default compartment ID for a Swift client.
+* `namespace` - The namespace to which the metadata belongs.
+
+
+
+### Create Operation
+
+
+The following arguments are supported:
+
+* `default_s3compartment_id` - (Optional) The default compartment ID for an S3 client.
+* `default_swift_compartment_id` - (Optional) The default compartment ID for a Swift client.
+* `namespace` - (Required) The namespace to which the metadata belongs.
+
+### Update Operation
+Change the default Swift/S3 compartmentId of user's namespace into the user-defined compartmentId. Upon doing
+this, all subsequent bucket creations will use the new default compartment, but no previously created
+buckets will be modified. A user must have the NAMESPACE_UPDATE permission to make changes to the default
+compartments for S3 and Swift.
+
+
+The following arguments support updates:
+* `default_s3compartment_id` - The default compartment ID for an S3 client.
+* `default_swift_compartment_id` - The default compartment ID for a Swift client.
+
+
+** IMPORTANT **
+Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
+
+### Example Usage
+
+```hcl
+resource "oci_objectstorage_namespace_metadata" "test_namespace_metadata" {
+  namespace = "${var.bucket_namespace}"
+  default_s3compartment_id = "${var.default_s3compartment_id}"
+  default_swift_compartment_id = "${var.default_swift_compartment_id}"
+}
+```
+
+# oci_object_storage_namespace_metadata
+
+## NamespaceMetadata DataSource
+
+Gets a single namespace_metadata
+
+### Get Operation
+Namespaces are unique. Namespaces are either the tenancy name or a random string automatically generated during
+account creation. You cannot edit a namespace.
+
+The following arguments are supported:
+* `namespace` - (Required) The namespace to which the metadata belongs.
+
+
+The following attributes are exported:
+* `default_s3compartment_id` - The default compartment ID for an S3 client.
+* `default_swift_compartment_id` - The default compartment ID for a Swift client.
+* `namespace` - The namespace to which the metadata belongs.
+
+
+### Example Usage
+
+```hcl
+data "oci_objectstorage_namespace_metadata" "test_namespace_metadata" {
+  namespace = "${var.bucket_namespace}"
+}
+```