DEVELOPMENT

Clone the idem-csp repository and install with pip.

git clone git@gitlab.com:vmware/idem/idem-csp.git
pip install -e idem_csp

ACCT

After installation the CSP Idem Provider execution and state modules will be accessible to the pop hub. In order to use them we need to set up our credentials. Follow the instructions to generate an api token.

Create a new file called credentials.yaml and populate it with credentials. The default profile will be used automatically by idem unless you specify one with –acct-profile=profile_name on the cli.

There are many ways aws providers/profiles can be stored. See acct backends for more information.

A profile needs to specify the api key it uses and can optionally specify the api url.

credentials.yaml

csp.token:
  default:
    refresh_token: dmd23q3au8ljyajcvhz207of4ivsn9vjiaxzez223qeagdpe0voqiasknykv58jt
    default_org_id: defaults_to_the_logged_in_user_org_id
    # Optional configuration, defaults will be used for these values if not supplied
    csp_url: https://console.cloud.vmware.com

A profile can also be created that uses an access_token directly. However, a csp_url and default_org_id must be explicitly defined.

credentials.yaml

csp:
    my_profile:
        csp_url: https://console.cloud.vmware.com
        default_org_id: my_org_id
        headers:
            csp-auth-token: kl2k3jjoij0un093wjn092w34jta0-3

Now encrypt the credentials file and add the encryption key and encrypted file path to the ENVIRONMENT.

The acct command should be available as it is a requisite of idem and idem-csp. Encrypt the the credential file.

acct encrypt credentials.yaml

output:

-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI=

Add these to your environment:

export ACCT_KEY="-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI="
export ACCT_FILE=$PWD/credentials.yaml.fernet

Usage

This plugin allows your app to integrate csp authentication.

If your project implements exec modules then add csp to the auth plugins for your project like so:

# my_project_root/my_project/exec/my_project/init.py
def __init__(hub):
    hub.exec.my_project.ACCT = ["csp"]

If your project implements state modules then add csp to the auth plugins for your project like so:

# my_project_root/my_project/states/my_project/init.py
def __init__(hub):
    hub.states.my_project.ACCT = ["csp"]

async def my_func(hub, ctx):
    # Call any exec modules from idem-aiohttp, the ctx contains the right headers for csp apps
    ret = await hub.exec.json.get(ctx, url=f"my_app_url")
    # ret.result will be "True" if the command was a success
    assert ret.result, ret.comment
    # ret.ret has the return data
    return ret.ret