Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kr8s-org/kr8s
A batteries-included Python client library for Kubernetes that feels familiar for folks who already know how to use kubectl
https://github.com/kr8s-org/kr8s
asyncio devops-tools hacktoberfest k8s kr8s kubectl kubernetes kubernetes-client kubernetes-python-client python pythonic sync trio
Last synced: about 1 month ago
JSON representation
A batteries-included Python client library for Kubernetes that feels familiar for folks who already know how to use kubectl
- Host: GitHub
- URL: https://github.com/kr8s-org/kr8s
- Owner: kr8s-org
- License: bsd-3-clause
- Created: 2023-03-17T09:51:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T08:32:23.000Z (6 months ago)
- Last Synced: 2024-05-22T18:06:16.459Z (6 months ago)
- Topics: asyncio, devops-tools, hacktoberfest, k8s, kr8s, kubectl, kubernetes, kubernetes-client, kubernetes-python-client, python, pythonic, sync, trio
- Language: Python
- Homepage: https://kr8s.org
- Size: 3.31 MB
- Stars: 745
- Watchers: 6
- Forks: 32
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/kr8s-org/kr8s/actions/workflows/test.yaml)
[](https://app.codecov.io/gh/kr8s-org/kr8s)
[](https://results.pre-commit.ci/latest/github/kr8s-org/kr8s/main)
[](https://docs.kr8s.org/en/stable/)
[](https://jacobtomlinson.dev/effver)
[](https://pypi.org/project/kr8s/)
[](https://pypi.org/project/kr8s/)
[](https://docs.kr8s.org/en/stable/installation.html#supported-kubernetes-versions)
[](https://pypi.org/project/kr8s/)
[](https://pypi.org/project/kr8s/)
A simple, extensible Python client library for Kubernetes that feels familiar for folks who already know how to use `kubectl`.
## Highlights
- API inspired by `kubectl` for a shallow learning curve.
- [Sensible defaults](https://docs.kr8s.org/en/stable/authentication.html) to reduce boiler plate.
- No swagger generated code, human readable code only.
- Has both a standard and an [async API](https://docs.kr8s.org/en/stable/asyncio.html) that can be used with `asyncio` and `trio`.
- [Client caching](https://docs.kr8s.org/en/stable/client.html#client-caching) to reduce passing API objects around.
- Batteries included by providing [useful utilities and methods](https://docs.kr8s.org/en/stable/examples/pod_operations.html) inspired by `kubectl`.
## Quickstart
### Installation
```console
$ pip install kr8s
```
## Examples
> [!TIP]
> See the [Examples Documentation](https://docs.kr8s.org/en/stable/examples/) for a full set of examples including `asyncio` examples.
### List Nodes
Print out all of the node names in the cluster.
```python
import kr8s
for node in kr8s.get("nodes"):
print(node.name)
```
### Create a Pod
Create a new Pod.
```python
from kr8s.objects import Pod
pod = Pod({
"apiVersion": "v1",
"kind": "Pod",
"metadata": {
"name": "my-pod",
},
"spec": {
"containers": [{"name": "pause", "image": "gcr.io/google_containers/pause",}]
},
})
pod.create()
```
### Scale a Deployment
Scale the Deployment `metrics-server` in the Namespace `kube-system` to `1` replica.
```python
from kr8s.objects import Deployment
deploy = Deployment.get("metrics-server", namespace="kube-system")
deploy.scale(1)
```
### List Pods by label selector
Get all Pods from all Namespaces matching a label selector.
```python
import kr8s
selector = {'component': 'kube-scheduler'}
for pod in kr8s.get("pods", namespace=kr8s.ALL, label_selector=selector):
print(pod.namespace, pod.name)
```
### Add a label to a Pod
Add the label `foo` with the value `bar` to an existing Pod.
```python
from kr8s.objects import Pod
pod = Pod("kube-apiserver", namespace="kube-system")
pod.label({"foo": "bar"})
```
### Generate a Pod
Generate a simple Pod with a couple of keyword arguments.
```python
from kr8s.objects import Pod
pod = Pod.gen(name="example-1", image="nginx:latest")
pod.create()
```
### Cordon a Node
Cordon a Node to mark it as unschedulable.
```python
from kr8s.objects import Node
node = Node("k8s-node-1")
node.cordon()
```
### Pod Exec
Exec a command in a Pod.
```python
from kr8s.objects import Pod
pod = Pod.get("my-pod")
command = pod.exec(["uptime"])
print(command.stdout.decode())
# 13:49:05 up 23:03, 0 users, load average: 0.66, 0.87, 0.85
```
### Port forward a Pod
Open a port forward to a Pod as a background task/thread.
```python
from kr8s.objects import Pod
pod = Pod.get("my-pod")
pf = pod.portforward(remote_port=1234, local_port=5678)
# Starts the port forward in a background thread
pf.start()
# Your other code goes here
# Optionally stop the port forward thread (it will exit with Python anyway)
pf.stop()
```
> [!TIP]
> See the [Examples Documentation](https://docs.kr8s.org/en/stable/examples/) for a full set of examples including `asyncio` examples.