skrooge 1.0.0__tar.gz

skrooge-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

skrooge-1.0.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.1
+Name: skrooge
+Version: 1.0.0
+Summary: A quick and dirty kubernetes cost estimator
+Author: Michael Warkentin
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/mwarkentin/skrooge
+Project-URL: Changelog, https://github.com/mwarkentin/skrooge/releases
+Project-URL: Issues, https://github.com/mwarkentin/skrooge/issues
+Project-URL: CI, https://github.com/mwarkentin/skrooge/actions
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: click-log
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
+Provides-Extra: scrape
+Requires-Dist: pandas; extra == "scrape"
+Requires-Dist: requests; extra == "scrape"
+Requires-Dist: lxml; extra == "scrape"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+
+# skrooge
+
+[![PyPI](https://img.shields.io/pypi/v/skrooge.svg)](https://pypi.org/project/skrooge/)
+[![Changelog](https://img.shields.io/github/v/release/mwarkentin/skrooge?include_prereleases&label=changelog)](https://github.com/mwarkentin/skrooge/releases)
+[![Tests](https://github.com/mwarkentin/skrooge/workflows/Test/badge.svg)](https://github.com/mwarkentin/skrooge/actions?query=workflow%3ATest)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mwarkentin/skrooge/blob/master/LICENSE)
+
+A quick and dirty kubernetes cost estimator
+
+![OIG 0uCanRKKeLq7XwJysZQ3](https://github.com/getsentry/skrooge/assets/67560/8ba2d274-4281-43a0-ad75-f0838e29e5f4)
+*Ebenezer scrooge standing at the helm of a ship, pencil sketch*
+
+
+## Idea
+
+I've been manually calculating how much scaling kubernetes deployments up or down will cost (or save!).
+It's a bit of grunt work every time pulling together our instance types, figuring out if the deployment is cpu-bound or memory-bound, and working out the cost.
+Instead we could have a CLI tool (or potentially automated during CI down the road) that could calculate these numbers for us.
+
+Previous example (in english):
+
+It would be nice to have a CLI tool which could do these calculations for us (and integrate with GCP pricing / instance APIs to get instance shapes and costs automatically)
+
+```
+Pod size: 2 cpu, 3GB RAM
+Previous deployment: 32 cpu, 48GB RAM
+New deployment: 64 cpu, 96GB RAM
+Running on c2-standard-30 which have 30 cpu, 120GiB RAM, and cost $914/month
+Up to 2 new instances to support +32 CPU, cost $1828 / month ($21,936 / year)
+```
+
+How a CLI tool could work:
+
+```bash
+$ kubecost --cpu 32 --mem 48 --instance c2-standard-30
+c2-standard-30: 30 cpu, 120GiB RAM, $914/month
+Limiting factor: CPU (ceil(32/30) = 2)
+Cost: $1828 / month ($21,936 / year)
+```
+
+## Installation
+
+Install this tool using `pip`:
+
+    pip install skrooge
+
+## Usage
+
+For help, run:
+
+    skrooge --help
+
+You can also use:
+
+    python -m skrooge --help
+
+## Development
+
+To contribute to this tool, first checkout the code. Then create a new virtual environment:
+
+    cd skrooge
+    python -m venv venv
+    source venv/bin/activate
+
+Now install the dependencies, test dependencies, and GCP cost scraping dependencies:
+
+    pip install -e '.[lint,scrape,test]'
+
+To run the tests:
+
+    pytest
+
+To update the instances.json file:
+
+    python3 skrooge/scraper.py > skrooge/instances.json

skrooge-1.0.0/README.md

@@ -0,0 +1,75 @@
+# skrooge
+
+[![PyPI](https://img.shields.io/pypi/v/skrooge.svg)](https://pypi.org/project/skrooge/)
+[![Changelog](https://img.shields.io/github/v/release/mwarkentin/skrooge?include_prereleases&label=changelog)](https://github.com/mwarkentin/skrooge/releases)
+[![Tests](https://github.com/mwarkentin/skrooge/workflows/Test/badge.svg)](https://github.com/mwarkentin/skrooge/actions?query=workflow%3ATest)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mwarkentin/skrooge/blob/master/LICENSE)
+
+A quick and dirty kubernetes cost estimator
+
+![OIG 0uCanRKKeLq7XwJysZQ3](https://github.com/getsentry/skrooge/assets/67560/8ba2d274-4281-43a0-ad75-f0838e29e5f4)
+*Ebenezer scrooge standing at the helm of a ship, pencil sketch*
+
+
+## Idea
+
+I've been manually calculating how much scaling kubernetes deployments up or down will cost (or save!).
+It's a bit of grunt work every time pulling together our instance types, figuring out if the deployment is cpu-bound or memory-bound, and working out the cost.
+Instead we could have a CLI tool (or potentially automated during CI down the road) that could calculate these numbers for us.
+
+Previous example (in english):
+
+It would be nice to have a CLI tool which could do these calculations for us (and integrate with GCP pricing / instance APIs to get instance shapes and costs automatically)
+
+```
+Pod size: 2 cpu, 3GB RAM
+Previous deployment: 32 cpu, 48GB RAM
+New deployment: 64 cpu, 96GB RAM
+Running on c2-standard-30 which have 30 cpu, 120GiB RAM, and cost $914/month
+Up to 2 new instances to support +32 CPU, cost $1828 / month ($21,936 / year)
+```
+
+How a CLI tool could work:
+
+```bash
+$ kubecost --cpu 32 --mem 48 --instance c2-standard-30
+c2-standard-30: 30 cpu, 120GiB RAM, $914/month
+Limiting factor: CPU (ceil(32/30) = 2)
+Cost: $1828 / month ($21,936 / year)
+```
+
+## Installation
+
+Install this tool using `pip`:
+
+    pip install skrooge
+
+## Usage
+
+For help, run:
+
+    skrooge --help
+
+You can also use:
+
+    python -m skrooge --help
+
+## Development
+
+To contribute to this tool, first checkout the code. Then create a new virtual environment:
+
+    cd skrooge
+    python -m venv venv
+    source venv/bin/activate
+
+Now install the dependencies, test dependencies, and GCP cost scraping dependencies:
+
+    pip install -e '.[lint,scrape,test]'
+
+To run the tests:
+
+    pytest
+
+To update the instances.json file:
+
+    python3 skrooge/scraper.py > skrooge/instances.json

skrooge-1.0.0/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "skrooge"
+version = "1.0.0"
+description = "A quick and dirty kubernetes cost estimator"
+readme = "README.md"
+authors = [{name = "Michael Warkentin"}]
+license = {text = "Apache-2.0"}
+requires-python = ">=3.8"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License"
+]
+dependencies = [
+    "click",
+    "click-log",
+]
+
+[project.urls]
+Homepage = "https://github.com/mwarkentin/skrooge"
+Changelog = "https://github.com/mwarkentin/skrooge/releases"
+Issues = "https://github.com/mwarkentin/skrooge/issues"
+CI = "https://github.com/mwarkentin/skrooge/actions"
+
+[project.entry-points.console_scripts]
+skrooge = "skrooge.cli:cli"
+
+[project.optional-dependencies]
+lint = ["ruff"]
+scrape = ["pandas", "requests", "lxml"]
+test = ["pytest", "pytest-cov"]
+
+[tool.ruff]
+exclude = ["skrooge/scraper.py"]
+
+[tool.setuptools]
+packages = ["skrooge",]

skrooge-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

skrooge-1.0.0/skrooge/__main__.py

@@ -0,0 +1,4 @@
+from .cli import cli
+
+if __name__ == "__main__":
+    cli()

skrooge-1.0.0/skrooge/cli.py

@@ -0,0 +1,197 @@
+import difflib
+import json
+import logging
+import os
+
+import click
+import click_log
+
+from .render import render
+from .utils import (
+    calculate_cost,
+    determine_constrained_resource,
+    determine_instance_count_required,
+)
+
+logger = logging.getLogger(__name__)
+click_log.basic_config(logger)
+
+
+@click.group()
+@click.version_option()
+def cli():
+    "A quick and dirty kubernetes cost estimator"
+
+
+@cli.command(name="estimate")
+@click_log.simple_verbosity_option(logger, default="ERROR")
+@click.option(
+    "-r",
+    "--replicas",
+    help="The number of replicas in the deployment",
+    type=click.INT,
+)
+@click.option(
+    "-c",
+    "--cpu",
+    help="The amount of CPU change in milli-cores",
+    type=click.INT,
+)
+@click.option(
+    "-m",
+    "--mem",
+    help="The amount of memory change in MiB",
+    type=click.INT,
+)
+@click.option(
+    "-i",
+    "--instance",
+    help="The instance type this deployment is running on",
+    required=True,
+)
+@click.option(
+    "--cost-class",
+    help="The type of cost to calculate. Default: sud",
+    type=click.Choice(
+        ["sud", "ondemand", "preemptible", "cud-1y", "cud-3y"], case_sensitive=False
+    ),
+    default="sud",
+)
+@click.option(
+    "--region",
+    help="The region to use for cost calculation. Default: us-central1",
+    type=click.Choice(
+        [
+            "asia-east1",
+            "asia-east2",
+            "asia-northeast1",
+            "asia-northeast2",
+            "asia-northeast3",
+            "asia-south1",
+            "asia-south2",
+            "asia-southeast1",
+            "asia-southeast2",
+            "australia-southeast1",
+            "australia-southeast2",
+            "europe-central2",
+            "europe-north1",
+            "europe-southwest1",
+            "europe-west1",
+            "europe-west2",
+            "europe-west3",
+            "europe-west4",
+            "europe-west6",
+            "europe-west8",
+            "europe-west9",
+            "northamerica-northeast1",
+            "northamerica-northeast2",
+            "southamerica-east1",
+            "southamerica-west1",
+            "us-central1",
+            "us-central2",
+            "us-east1",
+            "us-east4",
+            "us-east5",
+            "us-south1",
+            "us-west1",
+            "us-west2",
+            "us-west3",
+            "us-west4",
+        ],
+        case_sensitive=False,
+    ),
+    default="us-central1",
+)
+@click.option(
+    "-f",
+    "--format",
+    help="The instance type this deployment is running on",
+    type=click.Choice(["english", "json"], case_sensitive=False),
+    default="english",
+)
+def estimate(replicas, cpu, mem, instance, cost_class, region, format):
+    "Quick estimate of the cost or savings a kubernetes scale update will incur"
+    logger.info(f"{replicas=}")
+    logger.info(f"{cpu=}m")
+    logger.info(f"{mem=}MiB")
+    logger.info(f"{instance=}")
+
+    instance_family = instance.split("-")[0]
+
+    # Get the absolute path to the directory of the script
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    instance_data_path = os.path.join(script_dir, "instances.json")
+
+    with open(instance_data_path, "r") as file:
+        instance_types = json.load(file)
+
+    missing_instance_type_link = "https://github.com/getsentry/skrooge/issues/new?assignees=&labels=&projects=&template=BUG_REPORT.md"
+
+    try:
+        instance_data = instance_types[instance_family][instance]
+    except KeyError:
+        try:
+            close_matches = difflib.get_close_matches(
+                instance, instance_types[instance_family].keys()
+            )
+        except KeyError:
+            logger.info(f"{instance_family}, {instance_types.keys()}")
+            close_matches = difflib.get_close_matches(
+                instance_family, instance_types.keys(), cutoff=0.4
+            )
+            raise click.BadParameter(
+                f"{instance_family} instance family not found. Did you mean: {', '.join(close_matches)}\nMissing an instance family that exists? {missing_instance_type_link}"
+            )
+        raise click.BadParameter(
+            f"{instance} not found. Did you mean: {', '.join(close_matches)}\nMissing an instance type that exists? {missing_instance_type_link}"
+        )
+
+    delta_cpu = replicas * cpu
+    delta_mem = replicas * mem
+
+    logger.info(f"{delta_cpu=}m {delta_mem=}MiB")
+
+    constrained_resource = determine_constrained_resource(instance_data, cpu, mem)
+    logger.info(f"{constrained_resource=}")
+
+    if constrained_resource == "cores":
+        resource_requirement = delta_cpu
+    else:
+        resource_requirement = delta_mem
+
+    required_instance_count = determine_instance_count_required(
+        instance_data, constrained_resource, resource_requirement
+    )
+    logger.info(f"{required_instance_count=}")
+
+    costs = calculate_cost(
+        instance_data,
+        required_instance_count,
+        cost_class=cost_class,
+        region=region,
+    )
+    logger.info(costs)
+
+    data = {
+        "replicas": replicas,
+        "cpu": cpu,
+        "mem": mem,
+        "delta_cpu": delta_cpu,
+        "delta_mem": delta_mem,
+        "constrained_resource": constrained_resource,
+        "resource_requirement": resource_requirement,
+        "required_instance_count": required_instance_count,
+        "instance": instance,
+        "instance_family": instance_family,
+        "instance_specs": instance_data["specs"],
+        "costs": costs,
+        "region": region,
+    }
+
+    logger.info(f"{data=}")
+
+    render(format=format, data=data)
+
+
+if __name__ == "__main__":
+    cli()

skrooge-1.0.0/skrooge/render.py

@@ -0,0 +1,27 @@
+import json
+
+import click
+
+
+def render(format, data):
+    if format == "english":
+        render_english(data)
+
+    if format == "json":
+        render_json(data)
+
+
+def render_english(data):
+    click.echo(
+        f"This workload is running on {data['instance']} instances in {data['region']} with {data['instance_specs']['cores']} cores and {data['instance_specs']['memory']}GiB of memory."
+    )
+    click.echo(
+        f"This workload will require {data['delta_cpu'] / 1000} cores and {data['delta_mem'] / 1024} GiB of memory. This workload is {data['constrained_resource']}-constrained."
+    )
+    click.echo(
+        f"This workload will require {data['required_instance_count']} instances, costing ${data['costs']['hourly']}/h (or ${data['costs']['monthly']}/m (or ${data['costs']['yearly']}/y)) at {data['cost_class']} rates."
+    )
+
+
+def render_json(data):
+    click.echo(json.dumps(data))