Releasing version 2.2.9

Releasing version 2.2.9

Author: Rajesh Deshpande

CHANGELOG.rst

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
+====================
+2.2.9 - 2019-05-14
+====================
+
+Added
+-----
+* Support for the Seoul (ICN) region
+* Support for logging context fields on data-plane APIs of the Key Management Service
+* Support for reverse pagination on list operations of the Email service
+* Support for configuring backup retention windows on database backups in the Database service
+* Support for subscribed regions in stop_untagged_instances.py on `GitHub <https://github.com/oracle/oci-python-sdk/blob/master/examples/stop_untagged_instances.py>`__.
+* New services to showoci.py on `GitHub <https://github.com/oracle/oci-python-sdk/blob/master/examples/showoci/showoci.py>`__.
+
 ====================
 2.2.8 - 2019-05-07
 ====================

README-development.rst

@@ -64,6 +64,23 @@ variables to be set:
 
     * ``OCI_PYSDK_PUBLIC_SSH_KEY_FILE``: path to a public SSH key (.pub file) that will be given access to the instance launched in ``test_launch_instance_tutorial.py``.
 
+
+Checking Style
+==============
+The Python SDK adheres to PEP8 style guilds and uses Flake8 to validate style.  There are some exceptions and they can
+be viewed in the ``setup.cfg`` file.
+
+If you run tox with no environment specified Flake8 will be run.  You can also run flake8 with no arguments to check
+the style consistency for the whole project.  If you want to check a single file you can run flake8 with a path to the
+file to check.
+
+.. code-block:: sh
+    flake8 path/to/python_file_to_check.py
+
+If flake8 is not found, make sure you have ``requirements.txt`` installed into your virtualenv.  See the
+"Getting Started" section.
+
+
 Generating Documentation
 ========================
 Sphinx is used for documentation. You can generate HTML locally with the following:

examples/add_API_key.py

@@ -1,3 +1,6 @@
+# coding: utf-8
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
 import oci
 import sys
 import os.path

examples/showoci/CHANGELOG.rst

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
+====================
+19.5.13 - 2019-05-13
+====================
+
+Added
+-----
+* Option to print nice to screen + JSON file using -sjf switch
+* Added summary to JSON output file or screen
+* Added Monitoring Service
+* Added Notifications Service
+* Added Edge Services (Healthcheck)
+* Added Announcement
+* Added Array check for service availability to support Tokyo
+
 ====================
 19.4.23 - 2019-04-23
 ====================

examples/showoci/README.md

@@ -1,6 +1,6 @@
 ## showoci - Oracle Cloud Infrastructure Reporting Tool
 
-SHOWOCI is an reporting tool which uses the Python SDK to extract list of resources from your tenant. It covers more than 80% of OCI components, Output can be printer friendly or JSON file.
+SHOWOCI is an reporting tool which uses the Python SDK to extract list of resources from your tenant. It covers most of OCI components, Output can be printer friendly or JSON file.
 
 Modules Included:  
 - oci.core.VirtualNetworkClient          
@@ -17,14 +17,41 @@ Modules Included:
 - oci.streaming.StreamAdminClient
 - oci.budget.BudgetClient
 - oci.autoscaling.AutoScalingClient
+- oci.monitoring.MonitoringClient
+- oci.ons.NotificationControlPlaneClient
+- oci.ons.NotificationDataPlaneClient
+- oci.healthchecks.HealthChecksClient
+- oci.announcements_service.AnnouncementClient
 
 ## OCI User Requirement
 Required OCI IAM user with read only privileges:  
 
-Inspect privilege will have some limitations especially on object storage sizes
 ```
 ALLOW GROUP ReadOnlyUsers to read all-resources IN TENANCY  
 ```
+
+For restrictive privileges:
+
+```
+Allow group ReadOnlyUsers to inspect all-objects in tenancy
+Allow group ReadOnlyUsers to read instances      in tenancy
+Allow group ReadOnlyUsers to read load-balancers in tenancy
+Allow group ReadOnlyUsers to read buckets        in tenancy
+Allow group ReadOnlyUsers to read nat-gateways   in tenancy
+Allow group ReadOnlyUsers to read public-ips     in tenancy
+Allow group ReadOnlyUsers to read file-family    in tenancy
+Allow group ReadOnlyUsers to read instance-configurations in tenancy
+    
+# Explanation:
+    read instances      allows - ListInstances
+    read load-balancers allows - ListBackendSets, ListBackends, GetHealthChecker (for status)
+    read buckets        allows - GetBucket (for size), GetObjectLifecyclePolicy
+    read nat-gateways   allows - ListNatGateways
+    read public-ips     allows - ListPublicIps (not used yet)
+    read file-family    allows - ListExports, ListSnapshots
+    read instance-configurations allows - GetInstanceConfiguration
+
+```
 ** DISCLAIMER – This is not official Oracle application
 
 ## Installation Guide for Python 3 with OCI SDK  
@@ -112,15 +139,17 @@ Execute
 ```
 $ ./showoci.py  
 
-usage: showoci [-h] [-a] [-ani] [-b] [-n] [-i] [-c] [-cn] [-o] [-l] [-d] [-f]
-               [-e] [-s] [-rm] [-so] [-mc] [-nr] [-t PROFILE] [-p PROXY]
-               [-rg REGION] [-cp COMPART] [-cf CONFIG] [-jf JOUTFILE] [-js]
-               [-cachef SERVICEFILE] [-caches] [--version]
+usage: showoci.py [-h] [-a] [-ani] [-an] [-b] [-n] [-i] [-c] [-cn] [-o] [-l]
+                  [-d] [-f] [-e] [-m] [-s] [-rm] [-so] [-edge] [-mc] [-nr]
+                  [-t PROFILE] [-p PROXY] [-rg REGION] [-cp COMPART]
+                  [-cf CONFIG] [-jf JOUTFILE] [-js] [-sjf SJOUTFILE]
+                  [-cachef SERVICEFILE] [-caches] [--version]
 
 optional arguments:
   -h, --help           show this help message and exit
   -a                   Print All Resources
   -ani                 Print All Resources but identity
+  -an                  Print Announcements
   -b                   Print Budgets
   -n                   Print Network
   -i                   Print Identity
@@ -131,9 +160,11 @@ optional arguments:
   -d                   Print Database
   -f                   Print File Storage
   -e                   Print EMail
+  -m                   Print Monitoring and Notifications
   -s                   Print Streams
   -rm                  Print Resource management
   -so                  Print Summary Only
+  -edge                Print Edge Services (Healthcheck)
   -mc                  exclude ManagedCompartmentForPaaS
   -nr                  Not include root compartment
   -t PROFILE           Config file section to use (tenancy profile)
@@ -143,6 +174,7 @@ optional arguments:
   -cf CONFIG           Config File
   -jf JOUTFILE         Output to file (JSON format)
   -js                  Output to screen (JSON format)
+  -sjf SJOUTFILE       Output to screen (nice format) and JSON File
   -cachef SERVICEFILE  Output Cache to file (JSON format)
   -caches              Output Cache to screen (JSON format)
   --version            show program's version number and exit
@@ -695,7 +727,53 @@ Compartment gse00000000 (root):
 ##############################
 --> AdiStream, partitions (1), Created: 2019-04-10 20:42
     URL   : https://api.cell-1.us-ashburn-1.streaming.oci.oraclecloud.com
-			
+
+##############################
+#    Monitoring - Alarms     #
+##############################
+--> host_cpu_over_80 (oci_computeagent), Enabled = True, Severity = CRITICAL
+    Query : CpuUtilization[1m]{resourceDisplayName = "demohost"}.mean() > 80
+    Topic : adi_topic - adi_topic_desc
+
+
+##############################
+#   Notifications - Topics   #
+##############################
+--> adi_topic - adi_topic_desc Created: 2018-12-25 12:00
+    Sub   : EMAIL: [email protected]
+
+##############################
+#     Edge - Healthcheck     #
+##############################
+--> public_http_check (HTTPS: HEAD), Path = /, Enabled = False
+    Interval : 30 secs
+    Targets  : 129.213.148.40
+    VPoints  : aws-cdg
+
+--> public_demohost_check (ICMP, Port: 80), Enabled = False
+    Interval : 30 secs, Timeout = 30 secs
+    Targets  : 129.213.148.40
+    VPoints  : aws-cmh, aws-iad
+
+##############################
+#       Announcements        #
+##############################
+--> Container Engine for Kubernetes (CN-4368) - PRODUCTION_EVENT_NOTIFICATION, 2019-03-22 12:00
+    Regions  : Multiple Regions
+    Services : ['Oracle Cloud Infrastructure Container Engine for Kubernetes']
+
+--> Container Engine for Kubernetes (CN-4368) - PRODUCTION_EVENT_NOTIFICATION, 2019-03-22 12:25
+    Regions  : Multiple Regions
+    Services : ['Oracle Cloud Infrastructure Container Engine for Kubernetes']
+
+--> Container Engine for Kubernetes (CN-4368) - PRODUCTION_EVENT_NOTIFICATION, 2019-03-22 12:25
+    Regions  : Multiple Regions
+    Services : ['Oracle Cloud Infrastructure Container Engine for Kubernetes']
+
+--> Developer Services : Container Engine for Kubernetes: Node Pool Security List Update (CN-3934) - ACTION_REQUIRED, 2019-02-05 15:00
+    Regions  : All Regions
+    Services : ['Developer Services : Container Engine for Kubernetes']
+
 ##########################################################################################
 #                                 Summary - us-ashburn-1                                 #
 ##########################################################################################

examples/showoci/showoci.py

@@ -42,14 +42,15 @@
 # - oci.streaming.StreamAdminClient
 # - oci.budget.BudgetClient
 # - oci.autoscaling.AutoScalingClient
+# - oci.monitoring.MonitoringClient
+# - oci.ons.NotificationControlPlaneClient
+# - oci.ons.NotificationDataPlaneClient
+# - oci.healthchecks.HealthChecksClient
+# - oci.announcements_service.AnnouncementClient
 #
 # Modules Not Yet Covered:
-# - oci.ons.NotificationDataPlaneClient
 # - oci.waas.WaasClient
-# - oci.monitoring.MonitoringClient
-# - oci.healthchecks.HealthChecksClient
 # - oci.dns.DnsClient
-# - oci.announcements_service.AnnouncementClient
 #
 ##########################################################################
 from __future__ import print_function
@@ -61,7 +62,7 @@
 import argparse
 import datetime
 
-version = "19.4.23"
+version = "19.5.13"
 
 ##########################################################################
 # execute_extract
@@ -126,16 +127,33 @@ def execute_extract():
         extracted_data = data.process_oci_data()
 
         ############################################
-        # Check output config
+        # if JSON and screen
+        ############################################
+        if cmd.sjoutfile:
+            # print nice
+            output.print_data(extracted_data)
+            summary.print_summary(extracted_data)
+
+            # Add summary to JSON and print to JSON file
+            extracted_data.append({'summary': summary.get_summary_json()})
+            if cmd.sjoutfile.name:
+                print_to_json_file(output, cmd.sjoutfile.name, extracted_data, "JSON Data")
+
+        ############################################
+        # JSON File only
         ############################################
-        if cmd.joutfile:
+        elif cmd.joutfile:
             if cmd.joutfile.name:
-                print_to_json_file(cmd.joutfile.name, extracted_data, "JSON Data")
+                summary.print_summary(extracted_data)
+                extracted_data.append({'summary': summary.get_summary_json()})
+                print_to_json_file(output, cmd.joutfile.name, extracted_data, "JSON Data")
 
         ############################################
-        # print JSON to screen
+        # JSON to screen only
         ############################################
         elif cmd.joutscr:
+            summary.print_summary(extracted_data)
+            extracted_data.append({'summary': summary.get_summary_json()})
             print(json.dumps(extracted_data, indent=4, sort_keys=False))
 
         ############################################
@@ -193,6 +211,7 @@ def set_parser_arguments():
     parser = argparse.ArgumentParser()
     parser.add_argument('-a', action='store_true', default=False, dest='all', help='Print All Resources')
     parser.add_argument('-ani', action='store_true', default=False, dest='allnoiam', help='Print All Resources but identity')
+    parser.add_argument('-an', action='store_true', default=False, dest='announcement', help='Print Announcements')
     parser.add_argument('-b', action='store_true', default=False, dest='budgets', help='Print Budgets')
     parser.add_argument('-n', action='store_true', default=False, dest='network', help='Print Network')
     parser.add_argument('-i', action='store_true', default=False, dest='identity', help='Print Identity')
@@ -203,9 +222,11 @@ def set_parser_arguments():
     parser.add_argument('-d', action='store_true', default=False, dest='database', help='Print Database')
     parser.add_argument('-f', action='store_true', default=False, dest='file', help='Print File Storage')
     parser.add_argument('-e', action='store_true', default=False, dest='email', help='Print EMail')
+    parser.add_argument('-m', action='store_true', default=False, dest='monitoring', help='Print Monitoring and Notifications')
     parser.add_argument('-s', action='store_true', default=False, dest='streams', help='Print Streams')
     parser.add_argument('-rm', action='store_true', default=False, dest='orm', help='Print Resource management')
     parser.add_argument('-so', action='store_true', default=False, dest='sumonly', help='Print Summary Only')
+    parser.add_argument('-edge', action='store_true', default=False, dest='edge', help='Print Edge Services (Healthcheck)')
     parser.add_argument('-mc', action='store_true', default=False, dest='mgdcompart', help='exclude ManagedCompartmentForPaaS')
     parser.add_argument('-nr', action='store_true', default=False, dest='noroot', help='Not include root compartment')
     parser.add_argument('-t', default="", dest='profile', help='Config file section to use (tenancy profile)')
@@ -215,6 +236,7 @@ def set_parser_arguments():
     parser.add_argument('-cf', type=argparse.FileType('r'), dest='config', help="Config File")
     parser.add_argument('-jf', type=argparse.FileType('w'), dest='joutfile', help="Output to file   (JSON format)")
     parser.add_argument('-js', action='store_true', default=False, dest='joutscr', help="Output to screen (JSON format)")
+    parser.add_argument('-sjf', type=argparse.FileType('w'), dest='sjoutfile', help="Output to screen (nice format) and JSON File")
     parser.add_argument('-cachef', type=argparse.FileType('w'), dest='servicefile', help="Output Cache to file   (JSON format)")
     parser.add_argument('-caches', action='store_true', default=False, dest='servicescr', help="Output Cache to screen (JSON format)")
     parser.add_argument('--version', action='version', version='%(prog)s ' + version)
@@ -228,7 +250,7 @@ def set_parser_arguments():
     if not (result.all or result.allnoiam or result.network or result.identity or
             result.compute or result.object or
             result.load or result.database or result.file or result.email or result.orm or result.container or
-            result.streams or result.budgets):
+            result.streams or result.budgets or result.monitoring or result.edge or result.announcement):
 
         parser.print_help()
 
@@ -291,6 +313,15 @@ def set_service_extract_flags(cmd):
     if cmd.all or cmd.allnoiam or cmd.budgets:
         prm.read_budgets = True
 
+    if cmd.all or cmd.allnoiam or cmd.monitoring:
+        prm.read_monitoring_notifications = True
+
+    if cmd.all or cmd.allnoiam or cmd.announcement:
+        prm.read_announcement = True
+
+    if cmd.all or cmd.allnoiam or cmd.edge:
+        prm.read_edge = True
+
     if cmd.noroot:
         prm.read_root_compartment = False
 
@@ -313,12 +344,12 @@ def set_service_extract_flags(cmd):
 ############################################
 # print data to json file
 ############################################
-def print_to_json_file(file_name, data, header):
+def print_to_json_file(output, file_name, data, header):
 
     with open(file_name, 'w') as outfile:
         json.dump(data, outfile, indent=4, sort_keys=False)
 
-    print(header + " has been exported to " + file_name)
+    output.print_header(header + " exported to " + file_name, 0)
 
 
 ##########################################################################