Releasing version 2.4.5 (#2)

Author: mross22

CHANGELOG.rst

@@ -7,6 +7,14 @@ 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.5 - 2017-07-20
+------------------
+
+Added
+~~~~~
+- Support for VCN multi-VNIC operations.
+- Support for compute image import/export operations.
+
 2.4.4 - 2017-06-09
 ------------------
 

requirements.txt

@@ -8,7 +8,7 @@ cryptography==1.8.1
 httpsig-cffi==15.0.0
 idna==2.5
 ndg-httpsclient==0.4.2
-oraclebmc==1.3.3
+oraclebmc==1.3.5
 packaging==16.8
 pluggy==0.4.0
 py==1.4.32

setup.py

@@ -30,7 +30,7 @@ def open_relative(*path):
 
 
 requires = [
- 'oraclebmc==1.3.3',
+ 'oraclebmc==1.3.5',
  'certifi',
  'click==6.7',
  'configparser==3.5.0',

src/oraclebmc_cli/core_cli_extended.py

@@ -9,7 +9,10 @@
 from .generated import blockstorage_cli
 from .generated import compute_cli
 from .generated import virtualnetwork_cli
+
+from oraclebmc import wait_until
 from oraclebmc.exceptions import ServiceError
+from oraclebmc.exceptions import MaximumWaitTimeExceeded
 from . import cli_util
 
 blockstorage_cli.blockstorage_group.add_command(blockstorage_cli.volume_group)
@@ -23,6 +26,8 @@
 compute_cli.compute_group.add_command(compute_cli.console_history_group)
 compute_cli.instance_group.add_command(compute_cli.get_windows_instance_initial_credentials)
 compute_cli.volume_attachment_group.add_command(compute_cli.detach_volume)
+compute_cli.vnic_attachment_group.commands.pop(compute_cli.attach_vnic.name)
+compute_cli.vnic_attachment_group.commands.pop(compute_cli.detach_vnic.name)
 
 virtualnetwork_cli.virtual_network_group.add_command(virtualnetwork_cli.vcn_group)
 virtualnetwork_cli.virtual_network_group.add_command(virtualnetwork_cli.subnet_group)
@@ -55,6 +60,21 @@
 cli_util.update_param_help(compute_cli.launch_instance, 'subnet_id', compute_instance_launch_subnet_id_help)
 cli_util.update_param_help(compute_cli.launch_instance, 'hostname_label', compute_instance_launch_hostname_label_help, example='`bminstance-1`')
 
+
+image_source_details_example = """'{ "objectName": "image-to-import.qcow2", "bucketName": "MyBucket", "namespaceName": "MyNamespace", "sourceType": "objectStorageTuple" }'
+
+or
+
+'{ "sourceUri": "https://objectstorage.us-phoenix-1.oraclecloud.com/n/MyNamespace/b/MyBucket/o/image-to-import.qcow2", "sourceType": "objectStorageUri" }'"""
+cli_util.update_param_help(compute_cli.create_image, 'image_source_details', "", append=True, example=image_source_details_example)
+
+destination_type_example = """'{ "objectName": "image-to-import.qcow2", "bucketName": "MyBucket", "namespaceName": "MyNamespace", "sourceType": "objectStorageTuple" }'
+
+or
+
+'{ "destinationUri": "https://objectstorage.us-phoenix-1.oraclecloud.com/n/MyNamespace/b/MyBucket/o/exported-image.qcow2", "destinationType": "objectStorageUri" }'"""
+cli_util.update_param_help(compute_cli.export_image, 'destination_type', "", append=True, example=destination_type_example)
+
 # help for bmcs network ip-sec-connection create --static-routes
 network_create_ip_sec_connection_static_routes_example = """'["10.0.0.0/16"]'"""
 network_create_ip_sec_connection_static_routes_help = """Static routes to the CPE. At least one route must be included. The CIDR must not be a multicast address or class E address. This must be provided in JSON format."""
@@ -201,3 +221,72 @@ def launch_instance_extended(ctx, **kwargs):
  del kwargs['vnic_display_name']
 
  ctx.invoke(compute_cli.launch_instance, **kwargs)
+
+
+@compute_cli.instance_group.command(name='attach-vnic', help="""Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see [Managing Virtual Network Interface Cards (VNICs)].""")
+@click.option('--instance-id', required=True, help="""The OCID of the instance.""")
+@click.option('--subnet-id', required=True, help="""The OCID of the subnet to create the VNIC in.""")
+@click.option('--vnic-display-name', required=False, help="""A user-friendly name for the VNIC. Does not have to be unique.""")
+@click.option('--assign-public-ip', required=False, type=click.BOOL, help="""Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (i.e., where prohibitPublicIpOnVnic=true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic=false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic=true, an error is returned.""")
+@click.option('--private-ip', required=False, help="""A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If no value is specified, a private IP address from the subnet will be automatically assigned.""")
+@click.option('--hostname-label', help="""The hostname for the VNIC. Used for DNS. The value is the hostname portion of the VNIC's fully qualified domain name (FQDN) (e.g., `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). The value can be retrieved from the [Vnic](#/en/iaas/20160918/Vnic/).""")
+@click.option('--wait', is_flag=True, default=False, help="""If set, then wait for the attachment to complete and return the newly attached VNIC. If not set, then the command will not wait and will return nothing on success.""")
+@cli_util.help_option
+@click.pass_context
+@cli_util.wrap_exceptions
+def attach_vnic(ctx, instance_id, subnet_id, vnic_display_name, assign_public_ip, private_ip, hostname_label, wait):
+ kwargs = {}
+
+ vnic_details = {}
+ vnic_details['subnetId'] = subnet_id
+ vnic_details['displayName'] = vnic_display_name
+ vnic_details['assignPublicIp'] = assign_public_ip
+ vnic_details['privateIp'] = private_ip
+ vnic_details['hostnameLabel'] = hostname_label
+
+ attachment_details = {}
+ attachment_details['createVnicDetails'] = vnic_details
+ attachment_details['instanceId'] = instance_id
+
+ compute_client = cli_util.build_client('compute', ctx)
+ response = compute_client.attach_vnic(
+ attach_vnic_details=attachment_details,
+ **kwargs
+ )
+
+ if not wait:
+ return
+
+ response = compute_client.get_vnic_attachment(response.data.id)
+
+ try:
+ response = wait_until(compute_client, response, 'lifecycle_state', 'ATTACHED', max_wait_seconds=180)
+ except MaximumWaitTimeExceeded:
+ sys.exit('Timed out while waiting for the VNIC attachment to reach the ATTACHED state.')
+
+ if not response.data.vnic_id:
+ sys.exit('The VNIC ID is not set on the VNIC attachment.')
+
+ network_client = cli_util.build_client('virtual_network', ctx)
+ response = network_client.get_vnic(vnic_id=response.data.vnic_id)
+ cli_util.render_response(response)
+
+
+@compute_cli.instance_group.command(name='detach-vnic', help="""Detaches and deletes the specified secondary VNIC. This operation cannot be used on the instance's primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted.""")
+@click.option('--vnic-id', required=True, help="""The OCID of the VNIC.""")
+@click.option('--compartment-id', required=True, help="""The OCID of the instance's compartment.""")
+@cli_util.confirm_delete_option
+@cli_util.help_option
+@click.pass_context
+@cli_util.wrap_exceptions
+def detach_vnic(ctx, vnic_id, compartment_id):
+ compute_client = cli_util.build_client('compute', ctx)
+ result = compute_client.list_vnic_attachments(compartment_id=compartment_id, vnic_id=vnic_id)
+
+ if result.data is None or len(result.data) == 0:
+ sys.exit('A VNIC attachment could not be found for the given VNIC ID.')
+
+ vnic_attachment_id = result.data[0].id
+ result = compute_client.detach_vnic(vnic_attachment_id=vnic_attachment_id)
+
+ cli_util.render_response(result)

src/oraclebmc_cli/generated/blockstorage_cli.py

@@ -37,16 +37,16 @@ def volume_backup_group():
  pass
 
 
-@volume_group.command(name=cli_util.override('create_volume.command_name', 'create'), help="""Creates a new volume in the specified compartment. The size of a volume can be either 256 GB or 2 TB. For general information about block volumes, see [Overview of Block Volume Service].
+@volume_group.command(name=cli_util.override('create_volume.command_name', 'create'), help="""Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 2 TB (2097152 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see [Overview of Block Volume Service].
 
 A volume and instance can be in separate compartments but must be in the same Availability Domain. For information about access control and compartments, see [Overview of the IAM Service]. For information about Availability Domains, see [Regions and Availability Domains]. To get a list of Availability Domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
 
-You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it.""")
+You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.""")
 @click.option('--availability-domain', required=True, help="""The Availability Domain of the volume.
 
 Example: `Uocm:PHX-AD-1`""")
 @click.option('--compartment-id', required=True, help="""The OCID of the compartment that contains the volume.""")
-@click.option('--display-name', help="""A user-friendly name. Does not have to be unique, and it's changeable.""")
+@click.option('--display-name', help="""A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.""")
 @click.option('--size-in-mbs', help="""The size of the volume in MBs.""")
 @click.option('--volume-backup-id', help="""The OCID of the volume backup from which the data should be restored on the newly created volume.""")
 @cli_util.help_option
@@ -80,7 +80,7 @@ def create_volume(ctx, availability_domain, compartment_id, display_name, size_i
 
 When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.""")
 @click.option('--volume-id', required=True, help="""The OCID of the volume that needs to be backed up.""")
-@click.option('--display-name', help="""A user-friendly name for the volume backup. Does not have to be unique and it's changeable.""")
+@click.option('--display-name', help="""A user-friendly name for the volume backup. Does not have to be unique and it's changeable. Avoid entering confidential information.""")
 @cli_util.help_option
 @click.pass_context
 @cli_util.wrap_exceptions
@@ -223,9 +223,9 @@ def list_volumes(ctx, compartment_id, availability_domain, limit, page):
  cli_util.render_response(result)
 
 
-@volume_group.command(name=cli_util.override('update_volume.command_name', 'update'), help="""Updates the specified volume's display name.""")
+@volume_group.command(name=cli_util.override('update_volume.command_name', 'update'), help="""Updates the specified volume's display name. Avoid entering confidential information.""")
 @click.option('--volume-id', required=True, help="""The OCID of the volume.""")
-@click.option('--display-name', help="""A user-friendly name. Does not have to be unique, and it's changeable.""")
+@click.option('--display-name', help="""A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.""")
 @click.option('--if-match', help="""For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.""")
 @cli_util.help_option
 @click.pass_context
@@ -249,9 +249,9 @@ def update_volume(ctx, volume_id, display_name, if_match):
  cli_util.render_response(result)
 
 
-@volume_backup_group.command(name=cli_util.override('update_volume_backup.command_name', 'update'), help="""Updates the display name for the specified volume backup.""")
+@volume_backup_group.command(name=cli_util.override('update_volume_backup.command_name', 'update'), help="""Updates the display name for the specified volume backup. Avoid entering confidential information.""")
 @click.option('--volume-backup-id', required=True, help="""The OCID of the volume backup.""")
-@click.option('--display-name', help="""A friendly user-specified name for the volume backup.""")
+@click.option('--display-name', help="""A friendly user-specified name for the volume backup. Avoid entering confidential information.""")
 @click.option('--if-match', help="""For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.""")
 @cli_util.help_option
 @click.pass_context