| Name | pypz-k8s-deployer JSON |
| Version |
0.9.3
JSON |
| download |
| home_page | None |
| Summary | This package provides the Kubernetes implementation of the deployer interface for pypz. |
| upload_time | 2024-08-02 04:37:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | Apache-2.0 |
| keywords |
pypz
k8s
kubernetes
deployer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Description
This package contains the Kubernetes implementation of the deployer interface
of *pypz*. It enables the deployment of the pipelines to a Kubernetes cluster.
Check the [documentation](https://lazlowa.github.io/pypz-python/deployers/kubernetes.html) for
more details.
# Install
The python artifact is hosted on https://pypi.org/, so you can install
it via pip:
```shell
pip install pypz-k8s-deployer
```
If you want to work on it locally, then you should install in editable mode:
```shell
pip install -e ./deployers/k8s
```
# Test
You can run tests against an existing Kubernetes cluster, however, it is
more convenient and safe to use [Kind](https://kind.sigs.k8s.io/) for this
purpose.
1. Follow the instructions to install Kind. Note that Kind prepares the
required config file **~/.kube/config**. If you work with your own cluster,
make sure, you have this file already in place.
2. Install the subproject in editable more.
```shell
pip install -e ./deployers/k8s
```
3. Start the cluster
```shell
kind create cluster
```
4. Build the test images (test/resources)
```shell
docker build -t pypz-test-image .
```
5. Load the test image onto the Kind node
```shell
kind load docker-image pypz-test-image
```
6. To run the tests locally, you need to execute the following command:
```shell
python -m unittest discover .\deployers\k8s\test\ -p "*.py"
```
7. Delete cluster
```shell
kind delete cluster
```
# Build
Before you build, you will need to install the "build" package:
```shell
pip install build
```
Then from the subproject's root, you will need to execute the following command:
```shell
python -m build
```
It will create the source distribution and the wheel file in the "dist" folder.
Raw data
{
"_id": null,
"home_page": null,
"name": "pypz-k8s-deployer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "pypz, k8s, kubernetes, deployer",
"author": null,
"author_email": "Laszlo Anka <laszlo.anka@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/15/01/a4a2fc82519eeeb48198d488550940cf5affc67d2f255d80b13a7b2bb1ec/pypz_k8s_deployer-0.9.3.tar.gz",
"platform": null,
"description": "# Description\n\nThis package contains the Kubernetes implementation of the deployer interface\nof *pypz*. It enables the deployment of the pipelines to a Kubernetes cluster.\n\nCheck the [documentation](https://lazlowa.github.io/pypz-python/deployers/kubernetes.html) for\nmore details.\n\n# Install\n\nThe python artifact is hosted on https://pypi.org/, so you can install\nit via pip:\n\n```shell\npip install pypz-k8s-deployer\n```\n\nIf you want to work on it locally, then you should install in editable mode:\n\n```shell\npip install -e ./deployers/k8s\n```\n\n# Test\n\nYou can run tests against an existing Kubernetes cluster, however, it is\nmore convenient and safe to use [Kind](https://kind.sigs.k8s.io/) for this\npurpose. \n\n1. Follow the instructions to install Kind. Note that Kind prepares the\nrequired config file **~/.kube/config**. If you work with your own cluster,\nmake sure, you have this file already in place.\n2. Install the subproject in editable more.\n```shell\npip install -e ./deployers/k8s\n```\n3. Start the cluster\n```shell\nkind create cluster\n```\n4. Build the test images (test/resources)\n```shell\ndocker build -t pypz-test-image .\n```\n5. Load the test image onto the Kind node\n```shell\nkind load docker-image pypz-test-image\n```\n6. To run the tests locally, you need to execute the following command:\n```shell\npython -m unittest discover .\\deployers\\k8s\\test\\ -p \"*.py\"\n```\n7. Delete cluster\n```shell\nkind delete cluster\n```\n\n# Build\n\nBefore you build, you will need to install the \"build\" package:\n\n```shell\npip install build\n```\n\nThen from the subproject's root, you will need to execute the following command:\n\n```shell\npython -m build\n```\n\nIt will create the source distribution and the wheel file in the \"dist\" folder.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "This package provides the Kubernetes implementation of the deployer interface for pypz.",
"version": "0.9.3",
"project_urls": {
"Documentation": "https://pypz.dev",
"Repository": "https://github.com/lazlowa/pypz-python"
},
"split_keywords": [
"pypz",
" k8s",
" kubernetes",
" deployer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33fff31fbf6fe8f42030865a2c001b204b47b1216462a3c1401ee9af9fa39e10",
"md5": "25bee25252b769402434ca16116bb026",
"sha256": "c7f9697cec31a9e8e2f39d871c3baf19106f42172b4ccee662df704785bfb8e4"
},
"downloads": -1,
"filename": "pypz_k8s_deployer-0.9.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25bee25252b769402434ca16116bb026",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11240,
"upload_time": "2024-08-02T04:37:10",
"upload_time_iso_8601": "2024-08-02T04:37:10.155587Z",
"url": "https://files.pythonhosted.org/packages/33/ff/f31fbf6fe8f42030865a2c001b204b47b1216462a3c1401ee9af9fa39e10/pypz_k8s_deployer-0.9.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1501a4a2fc82519eeeb48198d488550940cf5affc67d2f255d80b13a7b2bb1ec",
"md5": "0bcebfc67e1cbc4aaf3a6c5430456a6c",
"sha256": "b9ad408563c3d6075d6378233f1002b5b17046c555d6d64196317f635cb57d60"
},
"downloads": -1,
"filename": "pypz_k8s_deployer-0.9.3.tar.gz",
"has_sig": false,
"md5_digest": "0bcebfc67e1cbc4aaf3a6c5430456a6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 11877,
"upload_time": "2024-08-02T04:37:11",
"upload_time_iso_8601": "2024-08-02T04:37:11.768578Z",
"url": "https://files.pythonhosted.org/packages/15/01/a4a2fc82519eeeb48198d488550940cf5affc67d2f255d80b13a7b2bb1ec/pypz_k8s_deployer-0.9.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 04:37:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lazlowa",
"github_project": "pypz-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pypz-k8s-deployer"
}
