tools/OVF_converter/Usage.txt

   1 ##
   2 # Copyright 2016-2019 VMware Inc.
   3 # This file is part of ETSI OSM
   4 # All Rights Reserved.
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   7 # not use this file except in compliance with the License. You may obtain
   8 # a copy of the License at
   9 #
  10 #         http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  15 # License for the specific language governing permissions and limitations
  16 # under the License.
  17 #
  18 # For those usages not covered by the Apache License, Version 2.0 please
  19 # contact:  osslegalrouting@vmware.com
  20 ##
  21
  22 The following two tools are provided to help simplify VMware based image
  23 management:
  24
  25 o  ovf_converter - converts libvirt .qcow2 files to VMware .vmdk format.
  26 o  ovf_uploader  - uploads .ovf and .vmdk files to vCD, similar to
  27                       openstack image upload command.
  28
  29 OVF Converter Usage
  30 ===================
  31
  32 This utility can be used for both VMware Integrated Openstack (VIO) or
  33 vCloud Director (vCD).  It converts libvirt images, such as files that end
  34 in .qcow2 or .img to VMware .vmdk format.  Both an .ovf and .vmdk file are
  35 created and can be used as needed.
  36
  37 OVF Uploader Usage
  38 ==================
  39
  40 This utility is only used for vCD, as there is no equivalent CLI that provides
  41 the ability to upload images into vCD.  It takes the output OVF from the
  42 converter and uploads both it and the VMDK file to the vCD catalog.
  43
  44 Examples:
  45 =========
  46
  47 o  Upload a CentOS .qcow2 file to VIO
  48
  49    $ ovf_converter CentOS-7-x86_64-GenericCloud.qcow2
  50    $ openstack image create --public \
  51      --file CentOS-7-x86_64-GenericCloud.vmdk \
  52      --disk-format vmdk CentOS-7
  53
  54 o  Upload a CentOS .qcow2 file to vCD
  55
  56    $ ovf_converter CentOS-7-x86_64-GenericCloud.qcow2
  57    $ ovf_uploader -u orgadmin -p password -o osm -l https://vcd \
  58      CentOS-7-x86_64-GenericCloud.ovf
  59
  60 Both commands suport -h to display help options.
  61