Releasing version 2.4.16 (#42)

Author: mross22

CHANGELOG.rst

@@ -7,6 +7,18 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a
 Changelog <http://keepachangelog.com/>`__.
 
+2.4.16 - 2018-02-08
+---------------------
+Added
+~~~~~~~~~~
+* Support for Domain Name System Service (oci dns)
+    * An example on using the Domain Name System Service can be found on `GitHub <https://github.com/oracle/oci-cli/blob/master/scripts/dns_example.sh>`_.
+* Support for Reserved Public IPs in Virtual Networking Service (oci network public-ip)
+* Support for the following features in Block Storage Service
+    * Automated and policy-based scheduled backups (oci bv volume-backup-policy | volume-backup-policy-assignment)
+    * Read-only volume attachments (--is-read-only option while attaching volume)
+    * Incremental backups (--type option while creating a volume backup)
+
 2.4.15 - 2018-01-25
 ---------------------
 Added

LICENSE.txt

@@ -1,9 +1,9 @@
-Copyright (c) 2016, 2017, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
 This software is dual-licensed to you under the Universal Permissive License (UPL) and Apache License 2.0.  See below for license terms.  You may choose either license, or both.
  ____________________________
 The Universal Permissive License (UPL), Version 1.0
-Copyright (c) 2016, 2017, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
 Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
 
@@ -19,7 +19,7 @@ The above copyright notice and either this complete permission notice or at a mi
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 The Apache Software License, Version 2.0
-Copyright (c) 2016, 2017, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License"); You may not use this product except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.  A copy of the license is also reproduced below.  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and  limitations under the License.
 

README.rst

@@ -93,7 +93,7 @@ __ https://github.com/oracle/oci-cli
 
 License
 =======
-Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License 2.0.
 

requirements.txt

@@ -12,7 +12,7 @@ Jinja2==2.9.6
 jmespath==0.9.3
 ndg-httpsclient==0.4.2
 mock==2.0.0
-oci==1.3.13
+oci==1.3.14
 packaging==16.8
 pluggy==0.4.0
 py==1.4.33

scripts/basic_cli_test_script.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
 set -e
 
 # Runs a few commands. If you don't see Success at the end, then something's wrong.

scripts/dns_example.sh

@@ -0,0 +1,102 @@
+#!/bin/bash
+# This script provides a basic example of how to use the DNS service in the CLI. The two variables at the beginning of the script must be specified accordingly:
+#
+#   * COMPARTMENT_ID: The first argument is the OCID of the compartment where we'll create a DNS zone
+#   * DNS_ZONE_NAME: The second is the name of the DNS zone to create (e.g. my-example-zone.com)
+#
+# Requirements for running this script:
+#   - OCI CLI v2.4.16 or later (you can check this by running oci --version)
+
+set -e
+
+COMPARTMENT_ID=""
+DNS_ZONE_NAME=""
+
+BORDER="=========================================="
+
+function print_header() {
+    echo $BORDER
+    echo $1
+    echo $BORDER
+}
+
+echo "Creating DNS zone: $DNS_ZONE_NAME"
+oci dns zone create -c $COMPARTMENT_ID --zone-type PRIMARY --name $DNS_ZONE_NAME
+
+ZONE_ID=$(oci dns zone get --zone-name-or-id $DNS_ZONE_NAME --raw-output --query 'data.id')
+echo "ZONE ID: $ZONE_ID"
+
+# list all zones
+print_header "List all zones"
+oci dns zone list -c $C_CLI
+
+# We can also provide filter conditions and sort order to the list_zones operation. Here we filter based
+# on an exact name match and filter by the time the zone was created descending
+print_header "List all zones with sort and filter"
+oci dns zone list -c $C_CLI --name $DNS_ZONE_NAME --sort-by timeCreated --sort-order DESC
+
+# We can update records in the zone. This will overwrite any existing records so if there are items
+# we wish to keep (e.g. the NS records in the zone) we need to read those out first and make
+# sure they are included in the update.
+#
+# Downloading the existing collection, editing it, and calling update is not easy from the command line so
+# we strongly recommend using the 'patch' functionality shown below to add / update / delete records. If 
+# you really want to use update, you can see an example in tests/test_dns.py::test_update_zone_records
+
+# In addition to updates, we can use the patch operation to add and remove records from the zone without
+# having to send through the complete list of records each time. In this example, we'll add 2 TXT records and 
+# remove one
+print_header "Original Zone Records"
+oci dns record zone get -c $C_CLI --zone-name-or-id $DNS_ZONE_NAME
+
+RECORD_OPERATIONS_TEMPLATE=$(cat dns_example/add_add_record_operations_template.json)
+RECORD_OPERATIONS=$(sed s/__DNS_ZONE_NAME__/$DNS_ZONE_NAME/g <<< $RECORD_OPERATIONS_TEMPLATE)
+echo $RECORD_OPERATIONS > "dns_example/add_add_record_operations.json"
+
+echo "Patching zone records..."
+oci dns record zone patch --zone-name-or-id $DNS_ZONE_NAME --items file://dns_example/add_add_record_operations.json > /dev/null 2>&1
+
+print_header "List patched zone records filtered to only TXT records (newly added ones)"
+oci dns record zone get -c $C_CLI --zone-name-or-id $DNS_ZONE_NAME --rtype TXT
+
+# the example input template files have __DNS_ZONE_NAME__ in them which needs to be replaced with the real DNS_ZONE_NAME
+RECORD_OPERATIONS_TEMPLATE=$(cat dns_example/remove_record_operation_template.json)
+RECORD_OPERATIONS=$(sed s/__DNS_ZONE_NAME__/$DNS_ZONE_NAME/g <<< $RECORD_OPERATIONS_TEMPLATE)
+echo $RECORD_OPERATIONS > "dns_example/remove_record_operation.json"
+
+echo "Patching zone records to remove one with rdata 'Some test data'..."
+oci dns record zone patch --zone-name-or-id $DNS_ZONE_NAME --items file://dns_example/remove_record_operation.json > /dev/null 2>&1
+
+print_header "List patched zone records filtered to only TXT records (now there is only one)"
+oci dns record zone get -c $C_CLI --zone-name-or-id $DNS_ZONE_NAME --rtype TXT
+
+# As part of patch operations, we can also specify preconditions (REQUIRE - data must be present, and
+# PROHIBIT - data must not be present) which must be met for the operation to succeed
+# This first example checks that there is no A record for subdomain testdomain1.$DNS_ZONE_NAME, and then adds one
+RECORD_OPERATIONS_TEMPLATE=$(cat dns_example/prohibit_if_present_then_add_record_template.json)
+RECORD_OPERATIONS=$(sed s/__DNS_ZONE_NAME__/$DNS_ZONE_NAME/g <<< $RECORD_OPERATIONS_TEMPLATE)
+echo $RECORD_OPERATIONS > "dns_example/prohibit_if_present_then_add_record.json"
+
+echo 'Patching zone records with PROHIBIT precondition...'
+oci dns record zone patch --zone-name-or-id $DNS_ZONE_NAME --items file://dns_example/prohibit_if_present_then_add_record.json
+
+print_header "List patched zone records filtered to only A records (now there is one)"
+oci dns record zone get -c $C_CLI --zone-name-or-id $DNS_ZONE_NAME --rtype A
+
+# we expect this next command to return an error so dont quit the script
+set +e
+
+# Run the same patch operation again, and this time we expect it to fail because the record in the PROHIBIT precondition *does* exist
+echo 'Repeating same patch with PROHIBIT precondition, which now fails because the record exists...'
+oci dns record zone patch --zone-name-or-id $DNS_ZONE_NAME --items file://dns_example/prohibit_if_present_then_add_record.json
+set -e
+
+echo "Deleting DNS zone: $DNS_ZONE_NAME"
+oci dns zone delete --zone-name-or-id $DNS_ZONE_NAME --force
+
+# clean up temporary files
+rm dns_example/add_add_record_operations.json
+rm dns_example/remove_record_operation.json
+rm dns_example/prohibit_if_present_then_add_record.json
+
+echo "SUCCESS"

scripts/dns_example/add_add_record_operations_template.json

@@ -0,0 +1,18 @@
+[
+  {
+    "domain": "__DNS_ZONE_NAME__",
+    "isProtected": true,
+    "operation": "ADD",
+    "rdata": "Patch test data",
+    "rtype": "TXT",
+    "ttl": 300
+  },
+  {
+    "domain": "__DNS_ZONE_NAME__",
+    "isProtected": true,
+    "operation": "ADD",
+    "rdata": "Some more test patch data",
+    "rtype": "TXT",
+    "ttl": 300
+  }
+]

scripts/dns_example/prohibit_if_present_then_add_record_template.json

@@ -0,0 +1,16 @@
+[
+  {
+    "domain": "__DNS_ZONE_NAME__",
+    "operation": "PROHIBIT",
+    "rtype": "A",
+    "ttl": 300
+  },
+  {
+    "domain": "__DNS_ZONE_NAME__",
+    "isProtected": true,
+    "operation": "ADD",
+    "rdata": "127.0.0.1",
+    "rtype": "A",
+    "ttl": 300
+  }
+]

scripts/dns_example/remove_record_operation_template.json

@@ -0,0 +1,9 @@
+[
+  {
+    "domain": "__DNS_ZONE_NAME__",
+    "operation": "REMOVE",
+    "rdata": "\"Patch\" \"test\" \"data\"",
+    "rtype": "TXT",
+    "ttl": 300
+  }
+]

scripts/install/install.ps1

@@ -1,4 +1,4 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 <#
 .DESCRIPTION