Oracle Cloud Infrastructure Ansible Collection

Oracle Cloud Infrastructure Ansible Collection provides an easy way to provision and manage resources in Oracle Cloud using Ansible.

This collection replaces the legacy modules. Refer to the Migration Guide for best migration practices.

Ansible released Collections as part of the Ansible 2.9 release. Ansible recommends Collections as the recommended method of packaging and releasing modules. With the creation of Oracle Cloud Ansible Collection, we are providing two user benefits:

• Faster Availability - Oracle Cloud Ansible Modules will now be available to users at a faster pace on Ansible Galaxy.
• Wider Coverage - Support for the majority of the Oracle Cloud services.

We have also added a new User Guide to highlight new features and best practices for using the new modules.

Migration from Legacy Modules

We recommend migrating from the legacy modules since they will be deprecated in the near future. Please expect a few breaking changes while migrating from legacy modules to the new collection modules. We recommend you to refer to the Migration Guide for breaking changes. Also, the new modules are renamed to use the service name as a prefix.

Currently Supported Services

We support almost all the of OCI Cloud services with very few exceptions. For the complete list of supported services, please check the modules list.

Installation

Pre-requisites

python>=3.6

Oracle Linux 7

sudo yum-config-manager --enable ol7_developer
sudo yum-config-manager --enable ol7_developer_EPEL
sudo yum install oci-ansible-collection

Oracle Linux 8

sudo yum-config-manager --enable ol8_developer
sudo yum-config-manager --enable ol8_developer_EPEL
sudo yum install oci-ansible-collection

Linux/macOS

curl -L https://raw.githubusercontent.com/oracle/oci-ansible-collection/master/scripts/install.sh | bash -s -- --verbose

For more info about installation and troubleshooting check the Installation Guide.

Samples and Solutions

The 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.
• The solutions are available under the solutions directory on GitHub

Documentation

Module HTML documentation is available on Oracle Docs.

To view the module documentation, use this command:

ansible-doc oracle.oci.[module_name]

General documentation can be found here.

Ansible Tower and AWX

Oracle Cloud Infrastructure Ansible Collection supports Ansible Tower and AWX. For more information on how to setup the collection with Ansible Tower, follow the instructions in this blog. To install the Ansible Tower free version (AWX) on an OCI instance, use this solution.

Help

• For FAQs, check the Frequently Asked Questions page.
• For commmon issues, check the Common Issues page.
• To file bugs or feature requests, use GitHub issues.
• For other channels, check the "Questions or Feedback" section.

Changes

See CHANGELOG.

Contributing

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide

Security

Please consult the security guide for our responsible security vulnerability disclosure process

Known Issues

You can find information on any known issues on Known Issues or GitHub issues page.

License

Copyright (c) 2020, 2023 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.