OCI Java SDK Maven Plugin

1. Introduction

A Maven plugin for the Oracle Cloud Infrastructure Java SDK.

Currently supported OCI Java SDK version is 2.46.0.

For the time being, this plugin provides the minimum capabilities to setup instances. In the future this plugin may provide access to all services exposed by the OCI Java SDK.

This plugin is not endorsed by Oracle nor does the company provide any support for it.

2. Usage

As this is a typical Maven plugin, simply declare the plugin in the <plugins> section of your POM file: Plugin declaration in pom.xml

<plugins>
    <plugin>
        <groupId>org.kordamp.maven</groupId>
        <artifactId>oci-maven-plugin</artifactId>
        <version>0.8.0</version>
    </plugin>
</plugins>

2.1. Requirements

Java 8 and Maven 3.6 are the minimum requirements to use this plugin.

2.1.1. Example

Provisioning an Instance with brand new Vcn, Subnets, InternetGateway, and InstanceConsoleConnection, making sure that OpenJDK is installed and port 8080 is open

mvn oci:setup-instance \
  -Doci.compartment.id=ocid1.compartment.oc1... \
  -Doci.verbose=true \
  -Doci.instance.name=myInstance \
  -Doci.image=Oracle-Linux-7.6-2019.04.18-0 \
  -Doci.shape=VM.Standard2.1 \
  -Doci.public.key.file=/home/myuser/.oci/oci-key.pub \
  -Doci.user.data.file=/home/myuser/oci/cloud-init.sh

cloud-init.sh

#!/bin/bash

# install Java
yum install -y yum java-1.8.0-openjdk

# amend firewall rules to allow port 8080
firewall-cmd --permanent --zone=public --add-port=8080/tcp
firewall-cmd --reload

2.2. Configuration

You can configure mojos using the standard ~/.oci/config file. The format of the configuration file is specified at this page, it looks something similar to

[DEFAULT]
user=ocid1.user.oc1...
fingerprint=f9:14:d0:...
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1...
region=eu-frankfurt-1
pass_phrase=<secret>

2.3. Mojos

All mojos share the following properties

Property	Type	System	Environment	Default
profile	String	oci.profile	OCI_PROFILE	DEFAULT
region	String	oci.region	OCI_REGION
showSecrets	boolean			false
skip	boolean			false
displayStreamLogs	boolean	oci.display.stream.logs	OCI_DISPLAY_STREAM_LOGS	false

Property

Type

System

Environment

Default

Required

profile

String

oci.profile

OCI_PROFILE

DEFAULT

region

String

oci.region

OCI_REGION

showSecrets

boolean

false

skip

boolean

false

displayStreamLogs

boolean

oci.display.stream.logs

OCI_DISPLAY_STREAM_LOGS

false

Where each column defines

Property	The name of the mojo property.
Type	The type of the property.
System	The system property to set this property’s value. Use `-D` as prefix, i.e, `-Doci.profile=mine`
Environment	The environment key to set this property’s value. Set as key/value in command shell, i.e, `export OCI_PROFILE=mine`.
Default	Default value for this property (if any).
Required	Whether this property is required or not.

Property values are resolved in the following order

Environment > System Property > Property

Task paths may be used as prefix for Environment and System properties such that, for a task named step01 on a subproject named project1 you get the following Environment and System keys for the profile property

STEP01_OCI_PROFILE
step01.oci.profile
OCI_PROFILE
oci.profile

2.3.1. OCI Create

createBucket	Creates a Bucket.
createCompartment	Creates a Compartment.
createInstanceConsoleConnection	Creates an InstanceConsoleConnection.
createInstance	Creates an Instance.
createInternetGateway	Creates a InternetGateway.
createSubnet	Creates a Subnet.
createVcn	Creates a Vcn.

Table 1. createBucket
Property	Type	System	Environment	Default
compartmentId	String	oci.compartment.id	OCI_COMPARTMENT_ID
bucketName	String	oci.bucket.name	OCI_BUCKET_NAME
namespaceName	String	oci.namespace.name	OCI_NAMESPACE_NAME
verbose	boolean	oci.verbose	OCI_VERBOSE	false

Property	Type	System	Environment	Default
compartmentDescription	String	oci.compartment.description	OCI_COMPARTMENT_DESCRIPTION
compartmentId	String	oci.compartment.id	OCI_COMPARTMENT_ID
compartmentName	String	oci.compartment.name	OCI_COMPARTMENT_NAME
verbose	boolean	oci.verbose	OCI_VERBOSE	false
waitForCompletion	boolean	oci.wait.for.completion	OCI_WAIT_FOR_COMPLETION	false

Property	Type	System	Environment	Default
internetGatewayName	String	oci.internet.gateway.name	OCI_INTERNET_GATEWAY_NAME
verbose	boolean	oci.verbose	OCI_VERBOSE	false
waitForCompletion	boolean	oci.wait.for.completion	OCI_WAIT_FOR_COMPLETION	false

Property	Type	System	Environment	Default
availabilityDomain	String	oci.availability.domain	OCI_AVAILABILITY_DOMAIN
compartmentId	String	oci.compartment.id	OCI_COMPARTMENT_ID
dnsLabel	String	oci.dns.label	OCI_DNS_LABEL
subnetName	String	oci.subnet.name	OCI_SUBNET_NAME
vcnId	String	oci.vcn.id	OCI_VCN_ID
verbose	boolean	oci.verbose	OCI_VERBOSE	false
waitForCompletion	boolean	oci.wait.for.completion	OCI_WAIT_FOR_COMPLETION	false

deleteBucket	Deletes a Bucket.
deleteCompartment	Deletes a Compartment.
deleteInstanceConsoleConnection	Deletes an InstanceConsoleConnection.
deleteInternetGateway	Deletes a InternetGateway.
deleteObject	Deletes an Object.
deleteSubnet	Deletes a Subnet.
deleteVcn	Deletes a Vcn.

Property	Type	System	Environment	Default	Required
instanceConsoleConnectionId	String	oci.instance.console.connection.id	OCI_INSTANCE_CONSOLE_CONNECTION_ID
waitForCompletion	boolean	oci.wait.for.completion	OCI_WAIT_FOR_COMPLETION	false

getBucket	Displays information for an specific Bucket.
getCompartment	Displays information for an specific Compartment.
getInstanceConsoleConnection	Displays information for an specific InstanceConsoleConnection.
getInstancePublicIp	Displays public Ip addresses for a particular Instance.
getInstance	Displays information for an specific Instance.
getInternetGateway	Displays information for an specific InternetGateway.
getNamespace	Displays information for an specific Namespace.
getObject	Displays information for an specific Object.
getRouteTable	Displays information for an specific RouteTable.
getSecurityList	Displays information for an specific SecurityList.
getSubnet	Displays information for an specific Subnet.
getVcn	Displays information for an specific Vcn.

addIngressSecurityRule	Adds IngressSecurityRules to a SecurityList.
instanceAction	Performs a given action on an Instance.
setupInstance	Setups an Instance with Vcn, InternetGateway, Subnets, InstanceConsoleConnection, and Volume.
terminateInstance	Terminates an Instance.

Property	Type	System	Environment	Default
sourcePort	int
destinationPort	int
portType	String	oci.port.type	OCI_PORT_TYPE	TCP
securityListId	String	oci.security.list.id	OCI_SECURITY_LIST_ID

Property	Type	System	Environment	Default	Required
action	String	oci.action	OCI_ACTION	STOP
compartmentId	String	oci.compartment.id	OCI_COMPARTMENT_ID
instanceId	String	oci.instance.id	OCI_INSTANCE_ID		*
instanceName	String	oci.instance.name	OCI_INSTANCE_NAME		*
waitForCompletion	boolean	oci.wait.for.completion	OCI_WAIT_FOR_COMPLETION	false

listAvailabilityDomains	Lists AvailabilityDomains available on a Compartment.
listBuckets	Lists available Buckets.
listCompartments	Lists available Compartments.
listImages	Lists Images available on a Compartment.
listInstanceConsoleConnections	Lists available InstanceConsoleConnection on an Instance.
listInstances	Lists available Instances.
listInternetGateways	Lists InternetGateways available on a Vcn.
listObjects	Lists available Objects in a Bucket.
listRegions	Lists available Regions.
listRouteTables	Lists RouteTables available on a Vcn.
listSecurityLists	Lists SecurityLists available on a Vcn.
listShapes	Lists Shapes available on a Compartment.
listSubnets	Lists Subnets available on a Vcn.
listUsers	Lists available Users.
listVcns	Lists Vcns available on a Compartment.

clearBucket	Clears a Bucket.
copyObject	Copies an Object.
downloadObject	Downloads an Object to an specific location.
headBucket	Heads an specific Bucket.
headObject	Heads an specific Object.
putObject	Puts an Object on a Bucket.

OCI Java SDK Maven Plugin

1. Introduction

2. Usage

2.1. Requirements

2.1.1. Example

2.2. Configuration

2.3. Mojos

2.3.1. OCI Create

2.3.2. OCI Delete

2.3.3. OCI Get

2.3.4. OCI Instance

2.3.5. OCI List

2.3.6. OCI Object

2.3.7. OCI Query