Skip to main content

Simple script to ping given clusters using a given kube config. Results are save to a yaml file in /tmp

Project description

Cluster_ping

This is a simple script to check if the user defined in a given kube config can ping the given cluster. The result are currently saved to a yaml file in the operating systems temporary directory.

Usage

Installation

It is recommended to use pipx to manage the installation.

pipx install cluster_ping

The cluster_ping command should then be in the path.

cluster_ping --help

This will list the help and prove the installation was complete.

By running the cluster_ping with the path to a kude config and the name of a cluster a yaml file is created with the results of the ping. This file is created in the standard temporary directory for the OS. On Linux this is /tmp/.

cluster_ping <Path/to/kube/confing> <Cluster Name>

Development

Changelog

The change log is managed by towncrier.

Git Hooks

The use of pre-commit is used to set up git hooks. Use pre-commit install to install the hooks.

To run the hooks outside a commit using pre-commit run -a.

Testing

pytest is the test runner. Run tests with pytest.

Release Steps

  1. Create a release branch
  2. Run towncrier build --draft and review the outpout.
  3. Check that the verion in the top level init.py file is correct. bat cluster_ping/__init__.py
  4. Run towncrier build to update the change log
  5. Check the changes in the CHANGELOG.md
  6. Check in the updates to the Change log.
  7. Publish to pypi poetry publish --build
  8. Tag the branch with the release vesion.
  9. Merge the release branch into main.
  10. push change to remote
  11. push release tag `git push origin

Project details


Download files

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

Source Distribution

cluster_ping-0.1.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

cluster_ping-0.1.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file cluster_ping-0.1.1.tar.gz.

File metadata

  • Download URL: cluster_ping-0.1.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.10.11-200.fc40.x86_64

File hashes

Hashes for cluster_ping-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ba9c98af0420f50337bc695bf2ebdcd311629269c6b2195fa4162324503cc6ea
MD5 746449bdecdc87dcd3617a936ee741b2
BLAKE2b-256 c15f56716d5da87dfd601dd05a3ff3ba06291b76fe5d5a94d2d0e1a97d700b58

See more details on using hashes here.

Provenance

File details

Details for the file cluster_ping-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cluster_ping-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.10.11-200.fc40.x86_64

File hashes

Hashes for cluster_ping-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5f5e1641e794d58a0c10666d9ce2917ca8d0d226ca9cae30b4ae50380327629d
MD5 54e856605bbd008745a17d7721cadd89
BLAKE2b-256 750b527ae4f0d0c93eea41cdace36aa0b0e9b0d25daf73fb4ff6bbd971dec311

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page