Setting up the OCI CLI (Command Line Interface) involves several steps to authenticate, configure, and start using it effectively. Here’s a detailed guide to help you set up OCI CLI.
Step 1: Prerequisites
- OCI Account: Ensure you have an Oracle Cloud Infrastructure account.
- Access: Make sure you have appropriate permissions to create and manage resources.
- Operating System: OCI CLI supports Windows, macOS, and Linux distributions.
Step 2: Install OCI CLI
Install Python: OCI CLI requires Python 3.5 or later. Install Python if it’s not already installed:
On Linux:
sudo apt update
sudo apt install python3
On macOS:
Install via Homebrew:
brew install python3
- On Windows: Download and install Python from python.org.
Install OCI CLI: Use pip, Python’s package installer, to install OCI CLI:
pip3 install oci-cli
Step 3: Configure OCI CLI
- Generate API Signing Keys: OCI CLI uses API signing keys for authentication. If you haven’t created keys yet, generate them through the OCI Console:
- Go to Identity → Users.
- Select your user.
- Under Resources, click on API Keys.
- Generate a new key pair if none exists.
Configure OCI CLI: After installing OCI CLI, configure it with your tenancy, user details, and API key:
- Open a terminal or command prompt.
- Run the following command:
oci setup config
- Enter a location for your config file: Choose a path where OCI CLI configuration will be stored (default is
~/.oci/config). - Enter a user OCID: Enter your user OCID (Oracle Cloud Identifier).
- Enter a tenancy OCID: Enter your tenancy OCID.
- Enter a region name: Choose the OCI region where your resources are located (e.g.,
us-ashburn-1). - Do you want to generate a new API Signing RSA key pair?: If you haven’t generated API keys, choose yes and follow the prompts.
Once configured, OCI CLI will create a configuration file (config) and a key file (oci_api_key.pem) in the specified location.
Thank you
Osama