agileupstate 0.0.41

State mangement tool for Future Agile CICD

agileupstate

Python 3.8+ project to manage AgileUP pipeline states with the following features:

• Linux and Windows compatible project.
• Defines state model.
• Saves and fetches states from vault.
• Exports private key for Linux SSH connections.
• Exports client PKI data for Windows WinRM connections.
• Exports cloud init zip file for mTLS connection data to Windows WinRM hosts.
• Exports ansible inventories for both Linux(SSH) and Windows(WinRM) connections.
• Provides simple connectivity tests.

Prerequisites

This project uses poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on, it will manage (install/update) them for you.

Use the installer rather than pip installing-with-the-official-installer.

poetry self add poetry-bumpversion

poetry -V
Poetry (version 1.2.0)

Windows Path

Install poetry from powershell in admin mode.

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

The path will be C:\Users\<YOURUSER>\AppData\Roaming\Python\Scripts\poetry.exe which you will need to add to your system path.

Windows GitBash

When using gitbash you can setup an alias for the poetry command:

alias poetry="\"C:\Users\<YOURUSER>\AppData\Roaming\Python\Scripts\poetry.exe\""

Getting Started

poetry update

poetry install

Development

This project uses the hvac python module and to develop locally you can run vault as a docker service as detailed here local docker vault. For local development vault setup follow the VAULT guide for information.

Check your connection with the following command, note in development mode vault should not be sealed.

export VAULT_ADDR='http://localhost:8200'
export VAULT_TOKEN='8d02106e-b1cd-4fa5-911b-5b4e669ad07a'

poetry run agileupstate check

States

• The state values are exported to siab-state.yml.
• The dynamic state names used by terraform are exported to file siab-state-names.sh and should be sourced in the pipelines for correct use.
• The tarraform state file is exported as terraform.tfstate.

Cloud Init

poetry run agileupstate cloud-init --server-path=siab-pfx/ags-w-arm1.meltingturret.io.pfx --client-path=siab-pfx/[e-mail]

Ansible Inventory

The ansible inventory.txt file is generated from the state data and the format automatically supports both SSH and WinRM connections. It is assumed that terraform does not output ['vm-rsa-private-key'] for Windows hosts which is used to determine the difference ebtween SSH or WinRM type inventory.txt file, example of WinRM file:

Example SSH inventory.txt

[001_arm_uksouth_dev]
20.77.124.22 ansible_ssh_private_key_file=vm-rsa-private-key.pem

Example WinRM inventory.txt

[001_arm_uksouth_dev]
20.108.1.34
[001_arm_uksouth_dev:vars]
ansible_user=azureuser
ansible_password=heTgDg!J4buAv5kc
ansible_connection=winrm
ansible_port=5986
ansible_winrm_ca_trust_path=chain.meltingturret.io.pem
ansible_winrm_cert_pem=[e-mail]
ansible_winrm_cert_key_pem=[e-mail]
ansible_winrm_transport=certificate

Run

poetry run agileupstate

Lint

poetry run flake8

Test

poetry run pytest

Publish

• By default we are using PYPI packages.
• Create yourself an access token for PYPI and then follow the instructions.

export PYPI_USERNAME=__token__ 
export PYPI_PASSWORD=<Your API Token>
poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Releasing

We are using poetry-bumpversion to manage release versions.

poetry version patch

Dependency

Once the release has been created it is now available for you to use in other python projects via:

pip install agileupstate

And also for poetry projects via:

poetry add agileupstate

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details