Oracle Cloud Infrastructure Compute Plugin allows users to access and manage cloud resources on the Oracle Cloud Infrastructure (OCI) from Jenkins. A Jenkins master instance with Oracle Cloud Infrastructure Compute Plugin can spin up OCI Instances (slaves or agents) on demand within OCI, and remove the Instances and free its resources automatically once the Job completes.
Oracle Cloud Infrastructure Compute Plugin provides functionality to dynamically allocate OCI resources for continuous integration tasks, and to bring up and down OCI Instances and resources as required to serve Jenkins Build Jobs.
After installing the Oracle Cloud Infrastructure Compute Plugin, you can add OCI Clouds and Template with the preferred OCI Instance configuration. The Template will have a Label that you can use in your Jenkins Job. Multiple Templates are supported. The Template options include Labels, Domains, Credentials, Shapes, Images, Virtual Cloud Network, etc. After your Jenkins Job completes its work, the OCI Instance is cleanly removed and resources are released back to the OCI pool.
1. Oracle Cloud Account. To sign up, visit Oracle Cloud.
2. Jenkins installed with JDK 8 or higher.
1. Plugin is tested on minimum Jenkins version 1.625.3, it may not work with versions early than 1.554.
2. For Jenkins versions between 1.554 and 1.625, pre-install 'bouncycastle API Plugin' plugin.
The Oracle Cloud Infrastructure Compute Plugin is available via Jenkins Update Center or can be installed manually.
To install the plugin through Jenkins Update Center navigate to Manage Jenkins > Manage Plugins > Available, and search "Oracle Cloud Infrastructure Compute Plugin"
To build the plugin from repos, OCI Java SDK is required. OCI Java SDK is currently not published to Maven center. To compile and build the plugin, first install OCI Java SDK to the local Maven repository. Refer to OCI Java SDK licensing here.
$ git clone https://github.com/oracle/oci-java-sdk $ cd oci-java-sdk $ mvn compile install
1. git clone repo
2. Update pom.xml with OCI Java SDK you have installed
``` <oci-java-sdk.version>1.2.48</oci-java-sdk.version> ```
3. Compile and Install package
$ mvn package
4. Install hpi:
- Manage Jenkins > Manage Plugins > Advanced tab > Upload Plugin section, click Choose File > Click Upload
- Copy the downloaded .hpi file into the JENKINS_HOME/plugins directory on the Jenkins master
Instance Cap - Enter a number to limit the maximum number of instances that can be created for this Cloud configuration. Leave this field empty to remove a cap.
Max number of async threads - The max number of async threads to use to load the Templates configuration. Consider reducing this value for Cloud configurations with a large number of Templates and if some values fail to load due to OCI API limit being exceeded. In this case the logs will show "User-rate limit exceeded" errors.
Click Add in Instance Templates section to add the OCI configuration. You can add multiple Templates to a Cloud configuration.
2. Input or select values in the 'Instance Template' section:
3. Click Verify SSH Key Pair to verify the public key and private key entered are a match.
4. Click Advanced for more configuration options:
5. Click Save or Apply
Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
This plugin is licensed under the Universal Permissive License 1.0
This software is dual-licensed to you under the Universal Permissive License (UPL) and Apache License 2.0.
See LICENSE.txt for more details.
For Changelog, please refer to CHANGELOG.md.
Oracle Cloud Infrastructure Compute Plugin is an open source project. See CONTRIBUTING.md for more details.
Oracle gratefully acknowledges the contributions to Oracle Cloud Infrastructure Compute Plugin that have been made by the community.