No project description provided
Project description
About
Azure Cloud Provider Idem plugin
What is POP?
This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.
For more information:
Getting Started
Prerequisites
Python 3.7+
git (if installing from source, or contributing to the project)
Installation
If wanting to use idem-azure-auto, you can do so by either installing from PyPI or from source.
Install from PyPI
pip install pop-releaseInstall from source
# clone repo
git clone git@<your-project-path>/idem-azure-auto.git
cd idem-azure-auto
# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .Usage
Credentials Setup
After installation, the Azure Idem execution and state modules will be accessible to the pop hub. In order to use them, we need to set up our credentials.
Create a new file called credentials.yaml and populate it with credentials. The default profile will be picked up automatically by idem.
There are multiple authentication backends for idem-azure-auto which each have their own unique set of parameters. The following examples show the parameters that can be used to define credential profiles.
credentials.yaml:
azure:
default:
client_id: "12345678-1234-1234-1234-aaabc1234aaa"
secret: "76543210-4321-4321-4321-bbbb3333aaaa"
subscription_id: "ZzxxxXXXX11xx-aaaaabbbb-k3xxxxxx"
tenant: "bbbbbca-3333-4444-aaaa-cddddddd6666"Next step is to encrypt the credentials file, and add the encryption key and encrypted file path to the ENVIRONMENT.
Encrypt the credential file:
Idem encrypt credentials.yamlThis will generate a credentials.yaml.fernet file and a command line output token:
-AXFSEFSSEjsfdG_lb333kVhCVSCDyOFH4eABCDEFNwI=
Add these to your environment:
export ACCT_KEY="-AXFSEFSSEjsfdG_lb333kVhCVSCDyOFH4eABCDEFNwI="
export ACCT_FILE=$PWD/credentials.yaml.fernetYou are ready to use idem-azure-auto!!!
STATES
Idem states are used to make sure resources are in a desired state. The desired state of a resource can be specified in sls file. In Idem-azure-auto, three states are supported: present, absent, describe
present state
present state makes sure a resource exists in a desired state. If a resource does not exist, running present will create the resource on the provider. If a resource exists, running present will update the resource on the provider. (Only the values that the Azure REST api supports can be updated.)
absent state
absent state makes sure a resource does not exist. If a resource exits, running absent will delete the resource. If a resource does not exist, running absent is a no-operation.
describe state
describe state lists all the current resources of the same resource type under the subscription id specified in the credential profile.
States can be accessed by their relative location in idem-azure-auto/idem_azure_auto/states. For example, in the state sls yaml file below, Azure resource group state can be created with the present function.
my_resource_group_state.sls:
my-azure-resource-group:
azure.resource_management.resource_groups.present:
- resource_group_name: my-azure-resource-group
- location: eastusThe state sls file can be executed with:
idem state $PWD/my_resource_group_state.slsExample of creating an Azure virtual network:
my-virtual-network:
azure.virtual_networks.virtual_networks.present:
- resource_group_name: my-azure-resource-group
- virtual_network_name: my-virtual-network
- location: eastus
- address_space:
- 10.0.0.0/16The resource parameters in an sls yaml file follow the exact structure as what’s in the Azure REST api doc . URI Parameters should be specified in snake case with “- “ in front. All parameters of the api request body should be specified in exactly the same way as what’s in the Azure REST api.
Current Supported Resources states
resource_management
resource_groups
policy
policy_definitions, policy_assignments
management_groups
management_groups
subscription
subscription
virtual_networks
virtual_networks, subnets, network_interfaces
compute
virtual_machines
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file idem-azure-auto-0.2.2.tar.gz.
File metadata
- Download URL: idem-azure-auto-0.2.2.tar.gz
- Upload date:
- Size: 57.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ebaf0842ee729e6c9243c3b4712f24574645a341048f68aed480e1cafb002b75 |
|
| MD5 | 263da2c1ab362ac22533d445d50c2a52 |
|
| BLAKE2b-256 | c9560d64ce3b881b0ab8cb74f55f978ccd6e52cd9a30cee702c90b3212603df9 |
File details
Details for the file idem_azure_auto-0.2.2-py3-none-any.whl.
File metadata
- Download URL: idem_azure_auto-0.2.2-py3-none-any.whl
- Upload date:
- Size: 102.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c238e2e70b63746eb6f504757684e80d0cb2228ba1b25e6372347ecbff883123 |
|
| MD5 | 70af7df09c109f730fe69cd0db0292e5 |
|
| BLAKE2b-256 | b6874a10c3fb013ce463b53c492bfb8acd275229c213d205ea9da1bfa8020972 |
