Skip to content

Prerequisites OCI (PoC)

The steps described on this document can be changed from the final version.

The goal is to quickly setup the PoC environment installing all the dependencies to deploy a cluster in Oracle Cloud Infrastructure - official Collection oracle.oci, setup identities to use the CLI/SDK, etc.

Setup Ansible project

This steps should be made only when OCI provider is under development in the branch feat-added-provider-oci.

  • Setup the ansible workdir (optional, you can use the defaults except the collections_path)
cat <<EOF > ansible.cfg
[defaults]
inventory = ./inventories
collections_path=./collections
callbacks_enabled=ansible.posix.profile_roles,ansible.posix.profile_tasks
hash_behavior=merge

[inventory]
enable_plugins = yaml, ini

[callback_profile_tasks]
task_output_limit=1000
sort_order=none
EOF
  • Create a virtual env

Tested in Python 3.9 and 3.10

python3.9 -m venv ./.oci
source ./.oci/bin/activate
  • Get the latest (under development) okd-installer collection with OCI modules:

https://github.com/mtulio/ansible-collection-okd-installer/pull/26

git clone -b feat-added-provider-oci --recursive \
    git@github.com:mtulio/ansible-collection-okd-installer.git \
    collections/ansible_collections/mtulio/okd_installer
  • Install the dependencies:
pip install -Ur collections/ansible_collections/mtulio/okd_installer/requirements.txt
ansible-galaxy collection install --upgrade -r collections/ansible_collections/mtulio/okd_installer/requirements.yml
  • Check if the SDK is installed:
$ pip freeze | grep oci
oci==2.112.4
  • Check if the collection is present:
$ ansible-galaxy collection list |grep -E "(okd_installer|^oracle)"
mtulio.okd_installer 0.0.0-latest
oracle.oci           4.33.0

Setup OCI credentials

  • See API Key Authentication:
  • See https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#two

Make sure your credentials have been set correctly on the file ~/.oci/config and you can use the OCI ansible collection:

  • Get the User ID from the documentation

you may need to adapt if there are more than one profile

export oci_user_id=$(grep ^user ~/.oci/config | awk -F '=' '{print$2}')
  • Retrieve facts from the user
ansible localhost \
    -m oracle.oci.oci_identity_user_facts \
    -a user_id=${oci_user_id}

Python Virtual Environment

If you are getting errors like oci python sdk required for this module, even it is already installed from previews steps, and you are using Python Virtual Environment, you must point the ansible_python_interpreter to the python interpretar path.

For example: ansible localhost -m oracle.oci.oci_identity_user_facts -a user_id=${oci_user_id} -e ansible_python_interpreter=$VIRTUAL_ENV/bin/python3

Ansible should return the user attributes, otherwise check your credentials.

Export the Compartment used to deploy the cluster

cat <<EOF > ~/.oci/env
# Compartment that the cluster will be installed
OCI_COMPARTMENT_ID="<CHANGE_ME:ocid1.compartment.oc1.UUID>"

# Compartment that the DNS Zone is created (based domain)
OCI_COMPARTMENT_ID_DNS="<CHANGE_ME:ocid1.compartment.oc1.UUID>"

# Compartment that the OS Image will be created
OCI_COMPARTMENT_ID_IMAGE="<CHANGE_ME:ocid1.compartment.oc1.UUID>"
EOF
source ~/.oci/env