idem-gcp

GCP Cloud Provider for Idem

These details have not been verified by PyPI

Project links

Project description

Made with pop, a Python implementation of Plugin Oriented Programming

Made with idem, a Python implementation of Plugin Oriented Programming

Documentation is published with Sphinx on docs.idemproject.io

GCP Cloud Provider for Idem.

About

idem-gcp helps manage GCP with idem.

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:

What is Idem?

This project is built with idem, an idempotent, imperatively executed, declarative programming language written in Python. This project extends idem!

For more information:

Getting Started

DEVELOPMENT

Clone the idem_gcp repository and install with pip.

git clone git@gitlab.com:my-user/idem_gcp.git
cd idem_gcp

Create a virtual environment, and then activate it:

python3 -m venv venv
source venv/bin/activate

Install idem-gcp and other base requirements:

pip3 install -e .
pip3 install -r requirements/base.txt

Install the following packages in order to run the tests:

pip3 install -r requirements/py3.10/tests.txt

NOTE: Change py3.10 if needed with your Python version. There is support for py3.7, py3.8, py3.9 and py3.10.

ACCT

After installation gcp 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.

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

acct backends provide alternate methods for storing profiles.

The gcp provider uses the gcp acct plugin for authentication. A profile needs to specify the authentication parameters for gcp.

credentials.yaml

gcp:
  default:
    username: my_user
    password: my_good_password
    endpoint_url: https://console.gcp.com/api

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_gcp. 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

A profile can be specified for use with a specific state. If no profile is specified, the profile called “default”, if one exists, will be used:

ensure_user_exists:
  gcp.user.present:
    - acct_profile: my-staging-env
    - name: a_user_name
    - kwarg1: val1

It can also be specified from the command line when executing states.

idem state --acct-profile my-staging-env my_state.sls

It can also be specified from the command line when calling an exec module directly.

idem exec --acct-profile my-staging-env gcp.user.list

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

2.2.4

Dec 18, 2023

2.2.3

Oct 11, 2023

2.2.2

Sep 5, 2023

2.2.1

Sep 1, 2023

2.2.0

Aug 21, 2023

2.1.0

Jul 18, 2023

2.0.0

Jul 6, 2023

1.2.0

Jun 20, 2023

1.1.0

Jun 7, 2023

0.23.0

May 29, 2023

0.22.0

May 16, 2023

0.21.0

May 2, 2023

0.20.0

Apr 24, 2023

0.19.0

Apr 18, 2023

0.18.0.1

Apr 13, 2023

0.18.0

Apr 5, 2023

0.17.0

Mar 28, 2023

0.16.1

May 29, 2023

0.16.0

Mar 21, 2023

0.15.0

Mar 14, 2023

0.14.1

Mar 7, 2023

0.14.0

Mar 7, 2023

0.13.0

Feb 27, 2023

0.12.0

Feb 20, 2023

0.11.0

Feb 13, 2023

0.10.0

Feb 6, 2023

0.9.0

Jan 30, 2023

0.8.0

Jan 25, 2023

0.7.0

Jan 17, 2023

This version

0.6.0

Dec 12, 2022

0.5.0

Dec 5, 2022

0.4.0

Nov 28, 2022

0.3.0

Nov 21, 2022

0.2.0

Nov 14, 2022

0.1.1

Nov 4, 2022

0.1.0

Nov 2, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

idem_gcp-0.6.0.tar.gz (106.4 kB view details)

Uploaded Dec 12, 2022 Source

Built Distribution

idem_gcp-0.6.0-py3-none-any.whl (165.5 kB view details)

Uploaded Dec 12, 2022 Python 3

File details

Details for the file idem_gcp-0.6.0.tar.gz.

File metadata

Download URL: idem_gcp-0.6.0.tar.gz
Upload date: Dec 12, 2022
Size: 106.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/5.1.0 keyring/23.11.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.16

File hashes

Hashes for idem_gcp-0.6.0.tar.gz
Algorithm	Hash digest
SHA256	`80f37c3cf7f6a6c32371b37bbbc16fc2fb13abbe5245df5d931a0cd10bd196c4`
MD5	`8953981552f966c8cfd115c261a57063`
BLAKE2b-256	`b6c45eba6134e70e75b56048cd7047ebcca49c626b7e88dd2b5549c1fe00de21`

See more details on using hashes here.

File details

Details for the file idem_gcp-0.6.0-py3-none-any.whl.

File metadata

Download URL: idem_gcp-0.6.0-py3-none-any.whl
Upload date: Dec 12, 2022
Size: 165.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/5.1.0 keyring/23.11.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.16

File hashes

Hashes for idem_gcp-0.6.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`132a0808f07380d677bf5214cdff687741b8bd633dd4318d19adeca5c3ddfa84`
MD5	`9ff76dcc42a81ce078e1ba45710ccaf7`
BLAKE2b-256	`b36b348df18ea84399553921c8ea5972835bc2f87d6df122b4746fb114a7ffbf`