zbuilder 0.2.2__tar.gz → 0.2.3__tar.gz

{zbuilder-0.2.2 → zbuilder-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zbuilder
-Version: 0.2.2
+Version: 0.2.3
 Summary: Create VMs
 Author: Nikos Chasiotis
 Author-email: Nikos Chasiotis <hasiotis@gmail.com>
@@ -31,14 +31,9 @@ Requires-Dist: boto3>=1.43.73
 Requires-Dist: tabulate>=0.10.0
 Requires-Dist: libvirt-python>=11,<12
 Requires-Dist: pycdlib>=1.14,<2
-Requires-Dist: google-auth-oauthlib>=0.4,<1.5 ; extra == 'gcp'
-Requires-Dist: oauthlib>=3.2.1,<4 ; extra == 'gcp'
-Requires-Dist: google-api-python-client>=2.198.0,<3 ; extra == 'gcp'
-Requires-Dist: google-cloud-dns>=0.37.0,<0.38 ; extra == 'gcp'
 Requires-Dist: proxmoxer>=1.1,<3 ; extra == 'proxmox'
 Requires-Python: >=3.12, <4
 Project-URL: Repository, https://github.com/hasiotis/zbuilder
-Provides-Extra: gcp
 Provides-Extra: proxmox
 Description-Content-Type: text/markdown
 
@@ -47,7 +42,6 @@ Description-Content-Type: text/markdown
 [![PyPi version](https://badge.fury.io/py/zbuilder.svg)](https://pypi.org/project/zbuilder/)
 [![PyPi downloads](https://img.shields.io/pypi/dm/zbuilder.svg)](https://pypistats.org/packages/zbuilder)
 [![Build status](https://github.com/hasiotis/zbuilder/workflows/master/badge.svg)](https://github.com/hasiotis/zbuilder/actions?query=workflow%3A%22master%22)
-[![Documentation Status](https://readthedocs.org/projects/zbuilder/badge/?version=stable)](https://zbuilder.readthedocs.io/en/stable/?badge=stable)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/hasiotis/zbuilder/blob/master/LICENSE)
 
 ZBuilder is a tool to help you build VMs ready to be transferred to ansible.
@@ -73,11 +67,6 @@ or
 pip3 install --user --upgrade zbuilder
 ```
 
-The `gcp` provider needs the google client libraries, which ship as an extra:
-```
-pipx install --force 'zbuilder[gcp]'
-```
-
 The `proxmox` provider needs `proxmoxer`, which ships as an extra:
 ```
 pipx install --force 'zbuilder[proxmox]'
@@ -87,12 +76,11 @@ pipx install --force 'zbuilder[proxmox]'
 
 | Family | Providers |
 |---|---|
-| VM   | `aws`, `gcp`, `kvm`, `proxmox` |
-| DNS  | `aws`, `bind`, `gcp`, `powerdns` |
+| VM   | `aws`, `kvm`, `proxmox` |
+| DNS  | `aws`, `bind`, `powerdns` |
 | IPAM | `phpipam` |
 
-See the [documentation](https://zbuilder.readthedocs.io/en/stable/) for the
-settings each one accepts, or run `zbuilder providers`.
+Run `zbuilder providers` to see the settings each one accepts.
 
 ## Development
 During development you can:
@@ -106,6 +94,5 @@ prek run --all-files         # lint and format
 
 ## Links
 
-[Documentation](https://zbuilder.readthedocs.io/en/stable/?badge=stable)
-| [Releases](https://pypi.org/project/zbuilder/)
+[Releases](https://pypi.org/project/zbuilder/)
 | [Code](https://github.com/hasiotis/zbuilder)

{zbuilder-0.2.2 → zbuilder-0.2.3}/README.md

@@ -3,7 +3,6 @@
 [![PyPi version](https://badge.fury.io/py/zbuilder.svg)](https://pypi.org/project/zbuilder/)
 [![PyPi downloads](https://img.shields.io/pypi/dm/zbuilder.svg)](https://pypistats.org/packages/zbuilder)
 [![Build status](https://github.com/hasiotis/zbuilder/workflows/master/badge.svg)](https://github.com/hasiotis/zbuilder/actions?query=workflow%3A%22master%22)
-[![Documentation Status](https://readthedocs.org/projects/zbuilder/badge/?version=stable)](https://zbuilder.readthedocs.io/en/stable/?badge=stable)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/hasiotis/zbuilder/blob/master/LICENSE)
 
 ZBuilder is a tool to help you build VMs ready to be transferred to ansible.
@@ -29,11 +28,6 @@ or
 pip3 install --user --upgrade zbuilder
 ```
 
-The `gcp` provider needs the google client libraries, which ship as an extra:
-```
-pipx install --force 'zbuilder[gcp]'
-```
-
 The `proxmox` provider needs `proxmoxer`, which ships as an extra:
 ```
 pipx install --force 'zbuilder[proxmox]'
@@ -43,12 +37,11 @@ pipx install --force 'zbuilder[proxmox]'
 
 | Family | Providers |
 |---|---|
-| VM   | `aws`, `gcp`, `kvm`, `proxmox` |
-| DNS  | `aws`, `bind`, `gcp`, `powerdns` |
+| VM   | `aws`, `kvm`, `proxmox` |
+| DNS  | `aws`, `bind`, `powerdns` |
 | IPAM | `phpipam` |
 
-See the [documentation](https://zbuilder.readthedocs.io/en/stable/) for the
-settings each one accepts, or run `zbuilder providers`.
+Run `zbuilder providers` to see the settings each one accepts.
 
 ## Development
 During development you can:
@@ -62,6 +55,5 @@ prek run --all-files         # lint and format
 
 ## Links
 
-[Documentation](https://zbuilder.readthedocs.io/en/stable/?badge=stable)
-| [Releases](https://pypi.org/project/zbuilder/)
+[Releases](https://pypi.org/project/zbuilder/)
 | [Code](https://github.com/hasiotis/zbuilder)

{zbuilder-0.2.2 → zbuilder-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "zbuilder"
-version = "0.2.2"
+version = "0.2.3"
 description = "Create VMs"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
@@ -41,12 +41,6 @@ name = "Nikos Chasiotis"
 email = "hasiotis@gmail.com"
 
 [project.optional-dependencies]
-gcp = [
-    "google-auth-oauthlib>=0.4,<1.5",
-    "oauthlib>=3.2.1,<4",
-    "google-api-python-client>=2.198.0,<3",
-    "google-cloud-dns>=0.37.0,<0.38",
-]
 proxmox = ["proxmoxer>=1.1,<3"]
 
 [project.urls]
@@ -57,14 +51,12 @@ zbuilder = "zbuilder.cli:cli"
 
 [project.entry-points."zbuilder.vm"]
 aws = "zbuilder.vm.aws:vmProvider"
-gcp = "zbuilder.vm.gcp:vmProvider"
 kvm = "zbuilder.vm.kvm:vmProvider"
 proxmox = "zbuilder.vm.proxmox:vmProvider"
 
 [project.entry-points."zbuilder.dns"]
 aws = "zbuilder.dns.aws:dnsProvider"
 bind = "zbuilder.dns.bind:dnsProvider"
-gcp = "zbuilder.dns.gcp:dnsProvider"
 powerdns = "zbuilder.dns.powerdns:dnsProvider"
 
 [project.entry-points."zbuilder.ipam"]
@@ -75,7 +67,6 @@ dev = [
     "pytest>=9.1.1,<10",
     "pytest-md-report>=0.8.0",
 ]
-docs = ["sphinx>=7.2.6,<8"]
 
 [tool.uv]
 default-groups = ["dev"]

{zbuilder-0.2.2 → zbuilder-0.2.3}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "zbuilder"
-version = "0.2.2"
+version = "0.2.3"
 description = "Create VMs"
 authors = [{ name = "Nikos Chasiotis", email = "hasiotis@gmail.com" }]
 license = "GPL-3.0-or-later"
@@ -40,15 +40,6 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-# The gcp providers (vm and dns) pull in the whole google client stack, which
-# is a large dependency tree nobody outside GCP needs. zbuilder/vm/gcp.py and
-# zbuilder/dns/gcp.py import it lazily and say what to install when missing.
-gcp = [
-    "google-auth-oauthlib>=0.4,<1.5",
-    "oauthlib>=3.2.1,<4",
-    "google-api-python-client>=2.198.0,<3",
-    "google-cloud-dns>=0.37.0,<0.38",
-]
 # The proxmox provider talks to PVE through proxmoxer, which nobody outside a
 # proxmox cluster needs. zbuilder/vm/proxmox.py imports it lazily and says what
 # to install when it is missing.
@@ -66,14 +57,12 @@ zbuilder = "zbuilder.cli:cli"
 # distribution can register providers under the same groups.
 [project.entry-points."zbuilder.vm"]
 aws = "zbuilder.vm.aws:vmProvider"
-gcp = "zbuilder.vm.gcp:vmProvider"
 kvm = "zbuilder.vm.kvm:vmProvider"
 proxmox = "zbuilder.vm.proxmox:vmProvider"
 
 [project.entry-points."zbuilder.dns"]
 aws = "zbuilder.dns.aws:dnsProvider"
 bind = "zbuilder.dns.bind:dnsProvider"
-gcp = "zbuilder.dns.gcp:dnsProvider"
 powerdns = "zbuilder.dns.powerdns:dnsProvider"
 
 [project.entry-points."zbuilder.ipam"]
@@ -84,9 +73,6 @@ dev = [
     "pytest>=9.1.1,<10",
     "pytest-md-report>=0.8.0",
 ]
-docs = [
-    "sphinx>=7.2.6,<8",
-]
 
 [tool.uv]
 default-groups = ["dev"]

{zbuilder-0.2.2 → zbuilder-0.2.3}/src/zbuilder/helpers.py

@@ -183,7 +183,7 @@ def getProviders(cfg, state):
         try:
             cp = cfg["providers"][p]
             cp["state"] = state
-            # A name can be registered in more than one family (gcp is both a
+            # A name can be registered in more than one family (aws is both a
             # vm and a dns provider), vm wins as it is the richer one.
             if cp["type"] in zbuilder.plugins.names(zbuilder.plugins.VM):
                 curProvider = zbuilder.vm.vmProvider(cp["type"], cp)

{zbuilder-0.2.2 → zbuilder-0.2.3}/src/zbuilder/vm/aws.py

@@ -36,10 +36,13 @@ class vmProvider(VMProvider):
         for h, v in self._getVMs(hosts).items():
             if v["status"] is None:
                 click.echo("  - Creating host: {} ".format(h))
+                # Debian AMIs boot from /dev/xvda, ubuntu ones from /dev/sda1. A mapping for any other device
+                # name adds a second volume instead of resizing the root one.
+                rootDevice = self.ec2.Image(v["values"]["ami"]).root_device_name
                 self.ec2.create_instances(
                     BlockDeviceMappings=[
                         {
-                            "DeviceName": "/dev/sda1",
+                            "DeviceName": rootDevice,
                             "Ebs": {
                                 "DeleteOnTermination": True,
                                 "VolumeSize": v["values"].get("disksize", 20),

zbuilder-0.2.2/src/zbuilder/dns/gcp.py

@@ -1,90 +0,0 @@
-"""GCP DNS provider.
-
-Like the gcp vm provider, the google client stack is an optional extra
-(`zbuilder[gcp]`) imported lazily, so this module imports without it.
-"""
-
-import time
-import click
-
-
-from zbuilder.base import DNSProvider
-from zbuilder.vm.gcp import auth, require
-
-try:
-    from google.cloud import dns
-except ImportError:  # installed without the gcp extra
-    dns = None
-
-
-DNS_TTL = 60 * 10  # 10 mins
-
-
-class dnsProvider(DNSProvider):
-    def __init__(self, cfg):
-        super().__init__(cfg)
-        if cfg:
-            require(dns, "google-cloud-dns")
-            creds = auth(self.cfg)
-
-            try:
-                if "project" in cfg["dns"]:
-                    self.dns = dns.Client(project=self.cfg["dns"]["project"], credentials=creds)
-                else:
-                    self.dns = dns.Client(credentials=creds)
-            except Exception as e:
-                click.echo("Login failed: [{}]".format(e))
-                raise click.Abort()
-
-    def _getZoneInfo(self, host, zone):
-        zones = self.dns.list_zones()
-        mzone = None
-        for z in zones:
-            if z.dns_name == zone + ".":
-                mzone = z
-                break
-
-        return mzone
-
-    def update(self, host, zone, ip):
-        mzone = self._getZoneInfo(host, zone)
-        try:
-            changes = mzone.changes()
-            changes.delete_record_set(mzone.resource_record_set("{}.{}.".format(host, zone), "A", DNS_TTL, [ip]))
-            changes.create()
-            while changes.status != "done":
-                time.sleep(5)
-                changes.reload()
-            click.echo("  - Updating record [{}.{}] with ip [{}]".format(host, zone, ip))
-        except Exception:
-            click.echo("  - Creating record [{}.{}] with ip [{}]".format(host, zone, ip))
-
-        changes = mzone.changes()
-        changes.add_record_set(mzone.resource_record_set("{}.{}.".format(host, zone), "A", DNS_TTL, [ip]))
-        changes.create()
-        while changes.status != "done":
-            time.sleep(5)
-            changes.reload()
-        time.sleep(5)
-
-    def remove(self, host, zone):
-        mzone = self._getZoneInfo(host, zone)
-        records = mzone.list_resource_record_sets()
-        found = False
-        for r in records:
-            if r.name == "{}.{}.".format(host, zone) and r.record_type in [
-                "A",
-                "CNAME",
-            ]:
-                found = True
-                click.echo("  - Removing record [{}.{}]".format(host, zone))
-                changes = mzone.changes()
-                changes.delete_record_set(mzone.resource_record_set(r.name, r.record_type, r.ttl, r.rrdatas))
-                changes.create()
-                while changes.status != "done":
-                    time.sleep(5)
-                    changes.reload()
-                break
-
-        if not found:
-            click.echo("  - No such record [{}.{}]".format(host, zone))

zbuilder-0.2.2/src/zbuilder/vm/gcp.py

@@ -1,305 +0,0 @@
-"""GCP provider, driving the google api client.
-
-The google client stack is an optional extra (`zbuilder[gcp]`) and is imported
-lazily: this module has to import on a machine without it, or provider
-discovery would break for everybody.
-"""
-
-import os
-import click
-import pickle
-
-from zbuilder.base import VMProvider
-from zbuilder.dns import dnsUpdate, dnsRemove
-
-try:
-    import googleapiclient.discovery
-    from google.oauth2 import service_account
-    from google_auth_oauthlib.flow import InstalledAppFlow
-    from google.auth.transport.requests import Request
-except ImportError:  # installed without the gcp extra
-    googleapiclient = None
-
-CONFIG_PATH = "~/.config/zbuilder/"
-
-
-def require(module, name):
-    """The gcp extra is optional, say so instead of raising ImportError"""
-    if module is None:
-        raise click.ClickException(
-            "The gcp provider needs [{}], install it with: pip install 'zbuilder[gcp]'".format(name)
-        )
-    return module
-
-
-def auth(cfg):
-    require(googleapiclient, "google-api-python-client")
-
-    SCOPES = [
-        "https://www.googleapis.com/auth/compute",
-        "https://www.googleapis.com/auth/ndev.clouddns.readwrite",
-    ]
-
-    creds = None
-    # First we check for client-secret and creds-file
-    if "client-secret" in cfg and "creds-file" in cfg:
-        secretFilename = os.path.expanduser("{}/{}".format(CONFIG_PATH, cfg["client-secret"]))
-        tokenFilename = os.path.expanduser("{}/{}".format(CONFIG_PATH, cfg.get("creds-file", "")))
-        if os.path.exists(secretFilename) and os.path.exists(tokenFilename):
-            with open(tokenFilename, "rb") as token:
-                creds = pickle.load(token)
-        if not creds or not creds.valid:
-            if creds and creds.expired and creds.refresh_token:
-                creds.refresh(Request())
-            else:
-                flow = InstalledAppFlow.from_client_secrets_file(secretFilename, SCOPES)
-                creds = flow.run_local_server(port=0)
-            with open(tokenFilename, "wb") as token:
-                pickle.dump(creds, token)
-
-    # In case of missing client-secret or creds-file fallback to service-key
-    if creds is None and "service-key" in cfg:
-        secretFilename = os.path.expanduser("{}/{}".format(CONFIG_PATH, cfg["service-key"]))
-        if os.path.exists(secretFilename) and os.path.exists(secretFilename):
-            creds = service_account.Credentials.from_service_account_file(secretFilename, scopes=SCOPES)
-
-    # Fail if no auth keys are available
-    if creds is None:
-        click.echo("Unable to authenticate due to missing secrets")
-        raise click.Abort()
-
-    return creds
-
-
-class vmProvider(VMProvider):
-    def __init__(self, cfg):
-        super().__init__(cfg)
-        if cfg:
-            creds = auth(self.cfg)
-
-            try:
-                self.compute = googleapiclient.discovery.build("compute", "v1", credentials=creds)
-            except Exception as e:
-                click.echo("Login failed: [{}]".format(e))
-                raise click.Abort()
-
-    def _waitDone(self, ops, msg=None):
-        for h, op in ops.items():
-            while True:
-                request = self.compute.zoneOperations().get(
-                    project=op["project"], zone=op["zone"], operation=op["name"]
-                )
-                response = request.execute()
-                if response["status"] == "DONE":
-                    if msg:
-                        click.echo(msg.format(h))
-                    break
-
-    def _getVMs(self, hosts):
-        retValue = {}
-        for h, v in hosts.items():
-            if hosts[h]["enabled"]:
-                shortname = h.partition(".")[0]
-                try:
-                    result = (
-                        self.compute.instances()
-                        .list(
-                            project=v["project"],
-                            zone=v["zone"],
-                            filter='name="{}"'.format(shortname),
-                        )
-                        .execute()
-                    )
-                except Exception as e:
-                    click.echo("Error [{}]".format(e))
-                    exit()
-                items = result.get("items", [])
-                if items:
-                    retValue[h] = items[0]
-                    retValue[h]["values"] = v
-                else:
-                    retValue[h] = {"status": None}
-                    retValue[h]["values"] = v
-
-                    image_response = (
-                        self.compute.images()
-                        .getFromFamily(project=v["image"]["project"], family=v["image"]["family"])
-                        .execute()
-                    )
-                    source_disk_image = image_response["selfLink"]
-
-                    fname = os.path.expanduser(v["ZBUILDER_PUBKEY"])
-                    sshkey = ""
-                    if os.path.isfile(fname):
-                        with open(fname, "r") as f:
-                            sshkey = f.read().rstrip("\n")
-
-                    network = "global/networks/{v[network]}".format(v=v)
-                    if "/" in v["network"]:
-                        network = v["network"]
-
-                    subnetwork = "regions/{v[region]}/subnetworks/{v[subnet]}".format(v=v)
-                    if "/" in v["subnet"]:
-                        subnetwork = v["subnet"]
-
-                    accessConfigs = []
-                    if v.get("net_external", False):
-                        accessConfigs = [{"type": "ONE_TO_ONE_NAT", "name": "External NAT"}]
-
-                    retValue[h]["insert"] = self.compute.instances().insert(
-                        project=v["project"],
-                        zone=v["zone"],
-                        body={
-                            "name": shortname,
-                            "machineType": "zones/{v[zone]}/machineTypes/{v[size]}".format(v=v),
-                            "disks": [
-                                {
-                                    "boot": True,
-                                    "autoDelete": True,
-                                    "initializeParams": {
-                                        "sourceImage": source_disk_image,
-                                    },
-                                }
-                            ],
-                            "networkInterfaces": [
-                                {
-                                    "network": network,
-                                    "subnetwork": subnetwork,
-                                    "accessConfigs": accessConfigs,
-                                }
-                            ],
-                            "metadata": {"items": [{"key": "ssh-keys", "value": "gcpadmin:" + sshkey}]},
-                        },
-                    )
-
-        return retValue
-
-    def build(self, hosts):
-        ops = {}
-        ips = {}
-        for h, v in self._getVMs(hosts).items():
-            if v["status"] is None:
-                click.echo("  - Creating host: {} ".format(h))
-                r = v["insert"].execute()
-                ops[h] = {
-                    "name": r["name"],
-                    "project": hosts[h]["project"],
-                    "zone": hosts[h]["zone"],
-                }
-                ips[h] = None
-            elif v["status"] == "TERMINATED":
-                click.echo("  - Booting host: {} ".format(h))
-                self.compute.instances().start(
-                    project=hosts[h]["project"],
-                    zone=hosts[h]["zone"],
-                    instance=v["name"],
-                ).execute()
-            elif v["status"] == "RUNNING":
-                click.echo("  - Already up host: {} ".format(h))
-            else:
-                click.echo("  - Status of host: {} is {}".format(h, v["status"]))
-
-        self._waitDone(ops, "  - Host {} created")
-        for h, v in self._getVMs(hosts).items():
-            if v["values"].get("dns_external", False):
-                ips[h] = v["networkInterfaces"][0]["accessConfigs"][0]["natIP"]
-            else:
-                ips[h] = v["networkInterfaces"][0]["networkIP"]
-
-        dnsUpdate(ips)
-
-    def up(self, hosts):
-        for h, v in self._getVMs(hosts).items():
-            if v["status"] is None:
-                click.echo("  - No such host: {} ".format(h))
-            elif v["status"] == "TERMINATED":
-                click.echo("  - Booting host: {} ".format(h))
-                self.compute.instances().start(
-                    project=hosts[h]["project"],
-                    zone=hosts[h]["zone"],
-                    instance=v["name"],
-                ).execute()
-            elif v["status"] == "RUNNING":
-                click.echo("  - Already up host: {} ".format(h))
-            else:
-                click.echo("  - Status of host: {} is {}".format(h, v["status"]))
-
-    def halt(self, hosts):
-        for h, v in self._getVMs(hosts).items():
-            if v["status"] is None:
-                click.echo("  - No such host: {} ".format(h))
-            if v["status"] == "RUNNING":
-                click.echo("  - Halting host: {} ".format(h))
-                self.compute.instances().stop(
-                    project=hosts[h]["project"],
-                    zone=hosts[h]["zone"],
-                    instance=v["name"],
-                ).execute()
-            else:
-                click.echo("  - Status of host: {} is {}".format(h, v["status"]))
-
-    def destroy(self, hosts):
-        updateHosts = {}
-        ops = {}
-        for h, v in self._getVMs(hosts).items():
-            if v["status"] is not None:
-                click.echo("  - Destroying host: {} ".format(h))
-                r = (
-                    self.compute.instances()
-                    .delete(
-                        project=hosts[h]["project"],
-                        zone=hosts[h]["zone"],
-                        instance=v["name"],
-                    )
-                    .execute()
-                )
-                ops[h] = {
-                    "name": r["name"],
-                    "project": hosts[h]["project"],
-                    "zone": hosts[h]["zone"],
-                }
-                updateHosts[h] = {}
-            else:
-                click.echo("  - Host does not exists : {}".format(h))
-
-        self._waitDone(ops, "  - Host {} destroyed")
-        dnsRemove(updateHosts)
-
-    def dnsupdate(self, hosts):
-        ips = {}
-        for h, v in self._getVMs(hosts).items():
-            if v["values"].get("dns_external", False):
-                ips[h] = v["networkInterfaces"][0]["accessConfigs"][0]["natIP"]
-            else:
-                ips[h] = v["networkInterfaces"][0]["networkIP"]
-
-        dnsUpdate(ips)
-
-    def dnsremove(self, hosts):
-        ips = {}
-        for h in hosts:
-            if hosts[h]["enabled"]:
-                ips[h] = None
-
-        dnsRemove(hosts)
-
-    def snapCreate(self, hosts):
-        pass
-
-    def snapRestore(self, hosts):
-        pass
-
-    def snapDelete(self, hosts):
-        pass
-
-    def config(self):
-        if "service-key" in self.cfg:
-            return "service-key: {}{}".format(CONFIG_PATH, self.cfg["service-key"])
-        else:
-            return "client-secret: {}{}".format(CONFIG_PATH, self.cfg["client-secret"])
-
-    def status(self):
-        return "PASS"
-
-    def params(self, params):
-        return {k: params[k] for k in ["size", "image"]}