packer/website/source/docs/builders/oracle-bmcs.html.md

layout	sidebar_current	page_title	description
docs	docs-builders-oracle-bmcs	Oracle Bare Metal Cloud Services (BMCS) - Builders	The oracle-bmcs Packer builder is able to create new custom images for use with Oracle Bare Metal Cloud Services (BMCS). The builder takes an Oracle-provided base image, runs any provisioning necessary on the base image after launching it, and finally snapshots it creating a reusable custom image.

Oracle Bare Metal Cloud Services (BMCS) Builder

Type: oracle-bmcs

The oracle-bmcs Packer builder is able to create new custom images for use with Oracle Bare Metal Cloud Services (BMCS). The builder takes an Oracle-provided base image, runs any provisioning necessary on the base image after launching it, and finally snapshots it creating a reusable custom image.

It is recommended that you familiarise yourself with the Key Concepts and Terminology prior to using this builder if you have not done so already.

The builder does not manage images. Once it creates an image, it is up to you to use it or delete it.

Authorization

The Oracle BMCS API requires that requests be signed with the RSA public key associated with your IAM user account. For a comprehensive example of how to configure the required authentication see the documentation on Required Keys and OCIDs (Oracle Cloud IDs).

Configuration Reference

There are many configuration options available for the oracle-bmcs builder. In addition to the options listed here, a communicator can be configured for this builder.

• access_cfg_file (string) - The path to the BMCS config file. Defaults to $HOME/.oraclebmc/config.

• access_cfg_file_account (string) - The specific account in the BMCS config file to use. Defaults to DEFAULT.

• availability_domain (string) - The name of the Availability Domain within which a new instance is launched and provisioned. The names of the Availability Domains have a prefix that is specific to your tenancy.

  To get a list of the Availability Domains, use the ListAvailabilityDomains operation, which is available in the IAM Service API.

• base_image_ocid (string) - The OCID of the Oracle-provided base image to use. This is the unique identifier of the image that will be used to launch a new instance and provision it.

  To get a list of the accepted image OCIDs, use the ListImages operation available in the Core Services API.

• compartment_ocid (string) - The OCID of the compartment

• fingerprint (string) - Fingerprint for the key pair being used. Overrides value provided by the BMCS config file if present.

• image_name (string) - The name to assign to the resulting custom image.

• key_file (string) - Full path and filename of the private key. Overrides value provided by the BMCS config file if present.

• region (string) - An Oracle Bare Metal Cloud Services region. Overrides value provided by the BMCS config file if present.

• shape (string) - The template that determines the number of CPUs, amount of memory, and other resources allocated to a newly created instance.

  To get a list of the available shapes, use the ListShapes operation available in the Core Services API.

• subnet_ocid (string) - The name of the subnet within which a new instance is launched and provisioned.

  To get a list of your subnets, use the ListSubnets operation available in the Core Services API.

• tenancy_ocid (string) - The OCID of your tenancy. Overrides value provided by the BMCS config file if present.

• user_ocid (string) - The OCID of the user calling the BMCS API. Overrides value provided by the BMCS config file if present.

Basic Example

Here is a basic example. Note that account specific configuration has been substituted with the letter a and OCIDS have been shortened for brevity.

{
  "type": "oracle-bmcs",
  "compartment_ocid": "ocid1.compartment.oc1..aaa",
  "availability_domain": "aaaa:PHX-AD-1",
  "subnet_ocid": "ocid1.subnet.oc1..aaa",
  "base_image_ocid": "ocid1.image.oc1..aaa",
  "shape": "VM.Standard1.1",
  "image_name": "ExampleImage"
}

---

Copyright (c) 2017 Oracle America, Inc.

The contents of this file are subject to the Mozilla Public License Version 2.0 (the "License"); you may not use this file except in compliance with the License. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/