Oracle Cloud Infrastructure Ansible Modules

About

Oracle Cloud Infrastructure Ansible Modules provide an easy way to create and provision resources in Oracle Cloud Infrastructure (OCI) through Ansible. These modules allow you to author Ansible playbooks that help you automate the provisioning and configuring of Oracle Cloud Infrastructure services and resources, such as Compute, Load Balancing, Database, and other Oracle Cloud Infrastructure services.

Services supported

• Block Volume
• Compute
• Container Engine for Kubernetes Service (OKE)
• Database (including support for Autonomous Transaction Processing and Autonomous Data Warehouse Services)
• Edge Services (DNS, WAF)
• IAM
• Load Balancing
• Networking
• Object Storage
• File Storage
• Email Delivery
• Search

The OCI Ansible modules are built using the Oracle Cloud Infrastructure Python SDK. The OCI Ansible modules honour the SDK configuration when available.

Installation

There are two methods for installation:

1) Installation Script (Preferred Method)

See the getting started guide for instructions on using the installer script to install the Oracle Cloud Infrastructure Ansible Modules and its prerequisites in your host/Ansible controller node.

2) Installation from Ansible Galaxy

Oracle Cloud Infrastructure Ansible Modules can also be downloaded from Ansible Galaxy and used as roles.

Note: This method does not support the ansible-doc command.

1. Install Ansible

2. Install the modules:

$ ansible-galaxy install oracle.oci_ansible_modules

3. Install OCI Python SDK:

$ pip install oci

Galaxy Example Playbook using Roles

- hosts: localhost
  roles:
    - { role: oracle.oci_ansible_modules }
  tasks:
    - name: Get all the buckets in the namespace
      oci_bucket_facts:
        namespace_name: "{{ namespace_name }}"
        compartment_id: "{{ compartment_id }}"

Samples

This project includes a catalog of Oracle Cloud Infrastructure Ansible module samples that illustrate using the modules to carry out common infrastructure provisioning and configuration tasks. The samples are organized in groups associated with Oracle Cloud Infrastructure services under the samples directory on GitHub.

Begin by reviewing the Readme.md file that you will find in each sample's root directory.

Documentation

Documentation to get started and details about prerequisites, installation and configuration instructions, can be found here.

FAQs, technical design documents and development HOWTOs, and web documentation for the OCI Ansible modules can be found here.

Help

See the "Questions or Feedback” section.

Changes

See CHANGELOG.

Contributing

oci-ansible-modules is an open source project. See CONTRIBUTING for details.

Oracle gratefully acknowledges the contributions to oci-ansible-modules that have been made by the community.

Known Issues

You can find information on any known issues with OCI here and known issues with the OCI Ansible Modules under the “Issues” tab of this project's GitHub repository.

License

Copyright (c) 2018, 2020, Oracle and/or its affiliates.

This software is made available to you under the terms of the GPL 3.0 license or the Apache 2.0 license.

See LICENSE.txt for more details.