Versions Compared

Old Version 2

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version 3

changes.mady.by.user Chandresh Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


To use the FlexDeploy OCI Plugin, you'll need to follow a few steps to get the information FlexDeploy requires to connect.

  1. Create a user in  IAM  for FlexDeploy to connect with, and put that user in at least one IAM group with any desired permissions. See   Adding Users.   You can skip this if the user exists already.

  2. Get these items:Prepare / gather necessary configuration items.

  3. Upload the public key from the key pair in the   Console. See   How to Upload the Public Key.



Create User in IAM

Create a user in IAM for FlexDeploy to connect with, and put that user in at least oneIAMgroup with any desired permissions.See Adding Users. You can skip this if the user exists already.

Prepare and Upload PEM Key

Tip

This key pair is  not  the SSH key that you use to access compute instances.

Both the private key and public key must be in PEM format (not SSH-RSA format). The public key in PEM format looks something like this:].

Code Block
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQE...
...
-----END PUBLIC KEY-----
AnchorgenerateSigningKeygenerateSigningKey
Generate 
 an 
 API Signing 
 Key 
Key
You can use the following 
 
OpenSSL
 
 commands to generate the key pair in the required PEM format. If you're using Windows, you'll need to install 
 
Git Bash for Windows
 
 and run the commands with that tool.
Step 1. If you haven't already, create a .oci directory to store the credentials:
 Code Block
mkdir ~/.oci
Step 2. Generate the private key with one of the following commands.
Recommended: 
Step 2.1. (Recommended) To generate the key, encrypted with a passphrase you provide when prompted
: 
.
 Code Block
openssl genrsa -out ~/.oci/oci_api_key.pem -aes128 2048
 
Note: For Windows, you may need to insert -passout 
 stdin
stdin to be prompted for a passphrase. The prompt will just be the blinking cursor, with no text. 
 Code Block
openssl genrsa -out ~/.oci/oci_api_key.pem -aes128 -passout stdin 2048
Step 2.2. To generate the key with no passphrase
: 
.
 Code Block
openssl genrsa -out ~/.oci/oci_api_key.pem 2048
Step 3. Ensure that only you can read the private key file: 
 Code Block
chmod go-rwx ~/.oci/oci_api_key.pem
Step 4. Generate the public key
: 
.
 Code Block
openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem
Note: For Windows, if you generated the private key with a passphrase, you may need to insert -passin stdin to be prompted for the passphrase. The prompt will just be the blinking cursor, with no text. 
 Code Block
openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem -passin stdin
Step 5. Copy the contents of the public key to the clipboard using pbcopy, xclip or a similar tool (you'll need to paste the value into the 
Console
 console later
)
. For example: 
 Code Block
cat ~/.oci/oci_api_key_public.pem | pbcopy
Your API requests will be signed with your private key, and Oracle will use the public key to verify the authenticity of the request. You must upload the public key to  IAM (instructions below).
 AnchorgetKeyFingerprintgetKeyFingerprintHow to Get the Key's Fingerprint 
 IAM which is explained later.
Get Fingerprint for Key
You can get the key's fingerprint with the following OpenSSL command. If you're using Windows, you'll need to install Git Bash for Windows and run the command with that tool. 

 Code Block
openssl rsa -pubout -outform DER -in ~/.oci/oci_api_key.pem | openssl md5 -c
When you upload the public key in the console, the fingerprint is also automatically displayed there. It looks something like this: .
 Code Block
12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef
   
 AnchorgetOCIDgetOCIDWhere to Get the Tenancy's OCID and User's OCID
Both OCIDs are in the Console, which is located at https://console.us-ashburn-1.oraclecloud.com. If you don't have a login and password for the Console, contact an administrator. If you're not familiar with OCIDs, see Resource Identifiers.
Tenancy's OCID
Get the tenancy OCID from the Oracle Cloud Infrastructure Console on the Tenancy Details page:
Open the navigation menu, under Governance and Administration, go to Administration and click Tenancy Details.
The tenancy OCID is shown under Tenancy Information. Click Copy to copy it to your clipboard.
User's OCID
Get the user's OCID in the Console on the page showing the user's details. To get to that page:
  • If you're signed in as the user: Open the User menu (User menu iconImage Removed) and click User Settings.
  • If you're an administrator doing this for another user: Open the navigation menu. Under Governance and Administration, go to Identity and click Users. Select the user from the list.
   
 AnchoruploadKeyuploadKey
How to 
Upload 
 the 
 Public Key to IAM
You can upload the PEM public key in the  Console console, located at   https://console.us-ashburn-1.oraclecloud.com. If you don't have a login and password for the  Console console, contact an administrator.
  1. Open the  Consoleconsole, and sign in.
  2. View the details for the user who will be calling the API with the key pair:.
    • If you're signed in as this user, click your username in the top-right corner of the Console, and then click User Settings.
    • If you're an administrator doing this for another user, instead click Identity, click Users, and then select the user from the list.
  3. Click Add Public Key.
  4. Paste the contents of the PEM public key in the dialog box and click Add.
The key's fingerprint is displayed (for example, 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).
Notice that after you've uploaded your first public key, you can also use the UploadApiKey API operation to upload additional keys. You can have up to three API key pairs per user. In an API request, you specify the key's fingerprint to indicate which key you're using to sign the request.


   
 Anchor
getOCID
getOCID
Where to Get the Tenancy's OCID and User's OCID
Both OCIDs are in theConsole, which is located athttps://console.us-ashburn-1.oraclecloud.com. If you don't have a login and password for theConsole, contact an administrator. If you're not familiar with OCIDs, seeResource Identifiers.
Tenancy's OCID
Get the tenancy OCID from theOracle Cloud InfrastructureConsoleon theTenancy Detailspage:
  1. Open thenavigation menu, underGovernance and Administration, go toAdministrationand clickTenancy Details.


  2. The tenancy OCID is shown underTenancy Information. ClickCopyto copy it to your clipboard.


User's OCID
Get the user's OCID in theConsoleon the page showing the user's details. To get to that page:
  • If you're signed in as the user: Open theUsermenu (User menu iconImage Added) and clickUser Settings.
  • If you're an administrator doing this for another user: Open thenavigation menu. UnderGovernance and Administration, go toIdentityand clickUsers. Select the user from the list.
   
 Anchor
uploadKey
uploadKey
How to Upload the Public Key