Merge pull request #94 from oracle/release_2018-12-13

Releasing version 2.1.3

CHANGELOG.rst

@@ -5,7 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
 ====================
-2.1.2 - 2018-11-29 
+2.1.3 - 12/13/2018
+====================
+
+Added
+-----
+* Support for Data Guard for VM shapes in the Database service
+* Support for sparse disk groups for Exadata shapes in the Database service
+* Support for a new field, isLatestForMajorVersion, when listing DB versions in the Database service
+* Support for in-transit encryption for paravirtualized boot volume and data volume attachments in the Block Storage service
+* Support for tagging DNS Zones in the DNS service
+* Support for resetting credentials for SCIM clients associated with an Identity provider and updating user capabilities in the Identity service
+
+Security 
+-------
+* pyOpenSSL pinning was changed to pyOpenSSL>=17.5.0 and cryptography pinning to cryptography>=2.1.4 to address vulnerability `CVE-2018-1000808 <https://nvd.nist.gov/vuln/detail/CVE-2018-1000808>`__
+
+====================
+2.1.2 - 2018-11-29
 ====================
 
 Added
@@ -16,7 +33,6 @@ Added
 Fixed
 -----
 * Block Storage service for copying volume backups across regions is now enabled
-
 
 ====================
 2.1.1 - 2018-11-15

LICENSE.txt

@@ -1,6 +1,6 @@
 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.
+This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0.  See below for license terms.  You may choose either license.
  ____________________________
 The Universal Permissive License (UPL), Version 1.0
 Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
@@ -79,4 +79,4 @@ END OF TERMS AND CONDITIONS
    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.
+   limitations under the License.

docs/api/database.rst

@@ -38,6 +38,7 @@ Database
     oci.database.models.CreateBackupDetails
     oci.database.models.CreateDataGuardAssociationDetails
     oci.database.models.CreateDataGuardAssociationToExistingDbSystemDetails
+    oci.database.models.CreateDataGuardAssociationWithNewDbSystemDetails
     oci.database.models.CreateDatabaseDetails
     oci.database.models.CreateDatabaseFromBackupDetails
     oci.database.models.CreateDbHomeDetails

docs/api/database/models/oci.database.models.CreateDataGuardAssociationWithNewDbSystemDetails.rst

@@ -0,0 +1,11 @@
+CreateDataGuardAssociationWithNewDbSystemDetails
+================================================
+
+.. currentmodule:: oci.database.models
+
+.. autoclass:: CreateDataGuardAssociationWithNewDbSystemDetails
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/api/dns.rst

@@ -20,6 +20,7 @@ DNS
 
     oci.dns.models.CreateZoneDetails
     oci.dns.models.ExternalMaster
+    oci.dns.models.Nameserver
     oci.dns.models.PatchDomainRecordsDetails
     oci.dns.models.PatchRRSetDetails
     oci.dns.models.PatchZoneRecordsDetails

docs/api/dns/models/oci.dns.models.Nameserver.rst

@@ -0,0 +1,11 @@
+Nameserver
+==========
+
+.. currentmodule:: oci.dns.models
+
+.. autoclass:: Nameserver
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/api/identity.rst

@@ -45,11 +45,13 @@ Identity
     oci.identity.models.FaultDomain
     oci.identity.models.Group
     oci.identity.models.IdentityProvider
+    oci.identity.models.IdentityProviderGroupSummary
     oci.identity.models.IdpGroupMapping
     oci.identity.models.Policy
     oci.identity.models.Region
     oci.identity.models.RegionSubscription
     oci.identity.models.Saml2IdentityProvider
+    oci.identity.models.ScimClientCredentials
     oci.identity.models.SmtpCredential
     oci.identity.models.SmtpCredentialSummary
     oci.identity.models.SwiftPassword
@@ -73,8 +75,10 @@ Identity
     oci.identity.models.UpdateSwiftPasswordDetails
     oci.identity.models.UpdateTagDetails
     oci.identity.models.UpdateTagNamespaceDetails
+    oci.identity.models.UpdateUserCapabilitiesDetails
     oci.identity.models.UpdateUserDetails
     oci.identity.models.User
+    oci.identity.models.UserCapabilities
     oci.identity.models.UserGroupMembership
     oci.identity.models.WorkRequest
     oci.identity.models.WorkRequestError

docs/api/identity/models/oci.identity.models.IdentityProviderGroupSummary.rst

@@ -0,0 +1,11 @@
+IdentityProviderGroupSummary
+============================
+
+.. currentmodule:: oci.identity.models
+
+.. autoclass:: IdentityProviderGroupSummary
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/api/identity/models/oci.identity.models.ScimClientCredentials.rst

@@ -0,0 +1,11 @@
+ScimClientCredentials
+=====================
+
+.. currentmodule:: oci.identity.models
+
+.. autoclass:: ScimClientCredentials
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/api/identity/models/oci.identity.models.UpdateUserCapabilitiesDetails.rst

@@ -0,0 +1,11 @@
+UpdateUserCapabilitiesDetails
+=============================
+
+.. currentmodule:: oci.identity.models
+
+.. autoclass:: UpdateUserCapabilitiesDetails
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/api/identity/models/oci.identity.models.UserCapabilities.rst

@@ -0,0 +1,11 @@
+UserCapabilities
+================
+
+.. currentmodule:: oci.identity.models
+
+.. autoclass:: UserCapabilities
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/api/index.rst

@@ -80,24 +80,24 @@ Block Storage
     :noindex:
 
 
-Compute 
-========
+Compute
+=======
 
 .. autoclass:: oci.core.compute_client.ComputeClient
     :members:
     :noindex:
 
 
-Compute Management 
-===================
+Compute Management
+==================
 
 .. autoclass:: oci.core.compute_management_client.ComputeManagementClient
     :members:
     :noindex:
 
 
-Virtual Network 
-================
+Virtual Network
+===============
 
 .. autoclass:: oci.core.virtual_network_client.VirtualNetworkClient
     :members:
@@ -251,24 +251,24 @@ Key Management
 ---------
 
 
-Kms Crypto 
-===========
+Kms Crypto
+==========
 
 .. autoclass:: oci.key_management.kms_crypto_client.KmsCryptoClient
     :members:
     :noindex:
 
 
-Kms Management 
-===============
+Kms Management
+==============
 
 .. autoclass:: oci.key_management.kms_management_client.KmsManagementClient
     :members:
     :noindex:
 
 
-Kms Vault 
-==========
+Kms Vault
+=========
 
 .. autoclass:: oci.key_management.kms_vault_client.KmsVaultClient
     :members:

docs/api/landing.rst

@@ -3,23 +3,23 @@ API Reference
 
 .. rubric:: Service Clients
 
-* :doc:`Audit  <audit>`
-* :doc:`Container Engine  <container_engine>`
+* :doc:`Audit <audit/client/oci.audit.AuditClient>`
+* :doc:`Container Engine <container_engine/client/oci.container_engine.ContainerEngineClient>`
 * :doc:`Block Storage <core/client/oci.core.BlockstorageClient>`
-* :doc:`Compute  <core/client/oci.core.ComputeClient>`
-* :doc:`Compute Management  <core/client/oci.core.ComputeManagementClient>`
-* :doc:`Virtual Network  <core/client/oci.core.VirtualNetworkClient>`
-* :doc:`Database  <database>`
-* :doc:`DNS <dns>`
-* :doc:`Email  <email>`
-* :doc:`File Storage  <file_storage>`
-* :doc:`Identity  <identity>`
-* :doc:`Kms Crypto  <key_management/client/oci.key_management.KmsCryptoClient>`
-* :doc:`Kms Management  <key_management/client/oci.key_management.KmsManagementClient>`
-* :doc:`Kms Vault  <key_management/client/oci.key_management.KmsVaultClient>`
-* :doc:`Load Balancer  <load_balancer>`
-* :doc:`Object Storage  <object_storage>`
-* :doc:`Resource Search  <resource_search>`
+* :doc:`Compute <core/client/oci.core.ComputeClient>`
+* :doc:`Compute Management <core/client/oci.core.ComputeManagementClient>`
+* :doc:`Virtual Network <core/client/oci.core.VirtualNetworkClient>`
+* :doc:`Database <database/client/oci.database.DatabaseClient>`
+* :doc:`DNS <dns/client/oci.dns.DnsClient>`
+* :doc:`Email <email/client/oci.email.EmailClient>`
+* :doc:`File Storage <file_storage/client/oci.file_storage.FileStorageClient>`
+* :doc:`Identity <identity/client/oci.identity.IdentityClient>`
+* :doc:`Kms Crypto <key_management/client/oci.key_management.KmsCryptoClient>`
+* :doc:`Kms Management <key_management/client/oci.key_management.KmsManagementClient>`
+* :doc:`Kms Vault <key_management/client/oci.key_management.KmsVaultClient>`
+* :doc:`Load Balancer <load_balancer/client/oci.load_balancer.LoadBalancerClient>`
+* :doc:`Object Storage <object_storage/client/oci.object_storage.ObjectStorageClient>`
+* :doc:`Resource Search <resource_search/client/oci.resource_search.ResourceSearchClient>`
 
 .. rubric:: Other Modules
 

docs/index.rst

@@ -48,6 +48,7 @@ To get started, head over to the :ref:`installation instructions <install>` or s
     forward-compatibility
     backward-compatibility
     quickstart
+    known-issues
     logging
     exceptions
     upload-manager

docs/installation.rst

@@ -15,36 +15,43 @@ Installation
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Python SDK.
 The Python SDK supports operations for the following services:
 
-* Audit Service
-* Core Services (Networking Service, Compute Service, and Block Volume Service)
-* Database Service
-* DNS Service
-* Email Service
-* File Storage Service
-* Identity and Access Management Service
-* Load Balancing Service
-* Object Storage Service
+* Audit
+* Container Engine for Kubernetes
+* Core Services (Networking, Compute, and Block Volume)
+* Database
+* DNS
+* Email
+* File Storage
+* IAM
+* Load Balancing
+* Object Storage
+* Search
+* Key Management
 
 
 ===============
  Prerequisites
 ===============
 
-.. note::
-    The Python SDK uses the `cryptography.io`_ library, which has its own additional `build requirements`_. Ensure
-    that you satisfy those requirements prior to installing the Python SDK.
+The Python SDK requires:
+
+* Python version 2.7.5 or 3.5 or later
+* `OpenSSL`_ version 1.0.1 or later. The Python SDK uses the `Cryptography.io`_ library which requires `OpenSSL`_. For details on all Cryptography.io prerequisites, see `Cryptography.io Installation`_.
+
+In addition, all Oracle Cloud Infrastructure SDKs require:
 
 * An Oracle Cloud Infrastructure account
 * A user created in that account, in a group with a policy that grants the desired permissions.
   This can be a user for yourself, or another person/system that needs to call the API.
   For an example of how to set up a new user, group, compartment, and policy, see
   `Adding Users`_ in the Getting Started Guide. For a list of other typical
   Oracle Cloud Infrastructure policies, see `Common Policies`_ in the User Guide.
-* Python version 2.7.5 or 3.5 or later, running on Mac, Windows, or Linux. 
 * A keypair used for signing API requests, with the public key uploaded to Oracle. Only the user calling
   the API should be in possession of the private key. (For more information, see `Configuring the SDK`_.)
 
 
+
+
 ====================================
  Downloading and Installing the SDK
 ====================================
@@ -183,10 +190,10 @@ When trying to use the SDK, if you get an exception related to SSL/TLS or certif
 
 .. _Adding Users: https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Tasks/addingusers.htm
 .. _Common Policies: https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/commonpolicies.htm
-.. _cryptography.io: https://cryptography.io/en/latest/
-.. _build requirements: https://cryptography.io/en/latest/installation/
+.. _Cryptography.io: https://cryptography.io/en/latest/
+.. _Cryptography.io Installation: https://cryptography.io/en/latest/installation/
 .. _TLS 1.2: https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdks.htm
 .. _PyPI link: https://pypi.python.org/pypi
-.. _openssl: https://www.openssl.org/
+.. _OpenSSL: https://www.openssl.org/
 .. _ConfiguringSDK: Configuring the SDK
 .. _OSXUsers: Verify OpenSSL Version

docs/known-issues.rst

@@ -0,0 +1,28 @@
+.. _known-issues:
+
+Known Issues
+~~~~~~~~~~~~~~~~~~~~~~
+These are the current known issues for the Python SDK.
+
+UploadManager generates ssl3_write_pending error when a read timeout is set for the Object Storage client
+=========================================================================================================
+**Details:** UploadManager generates the following error when a read timeout is set for the Object Storage client.
+
+.. code-block:: python
+
+    OpenSSL.SSL.Error: [('SSL routines', 'ssl3_write_pending', 'bad write retry')]
+
+**Workaround:** Do not set the read timeout for the Object Storage client. There are a two ways to do so:
+
+- Create an Object Storage client without setting a timeout. 
+- Clear the timeout on an already initialized Object Storage client by setting the timeout of the base_client to ``None``.
+
+.. code-block:: python
+
+    client.base_client.timeout = None
+
+If you need to retain the connection timeout while clearing the read timeout, you can do so by setting the timeout to a tuple. The first item in the tuple is the connection timeout and the second is the read timeout. In the following example, the connection timeout is set to 90.0 seconds and the read timeout is set to infinite, or no timeout.
+
+.. code-block:: python
+
+    client.base_client.timeout = (90.0, None)