- Shiphelm
- Table of Contents
- Installation
- Docker usage example
- Standalone Docker installation
- Remote standalone Docker installation
- Remote Docker swarm installation
- Get a List of Running Containers
- Get a running container by ID
- Get Stats and Ports for a Container by ID
- Search for Containers by Name
- Change the Ports of a Container
- Rename a Container
- Add and Remove Containers from Networks
- Create and Delete Networks
- Run a New Container
- Generate run command
- Get and Set Environment Variables for a Container
- Get and Set Volumes for a Container
- Example code
- Kubernetes (K8S) usage example
- Get a List of Running pods
- Get Stats and Ports for a pod by ID
- Search for pods by Name
- Change the Ports of a pod
- Rename a pod
- Add and Remove pods from Networks
- Create and Delete Networks
- Run a New pod
- Generate run command
- Get and Set Environment Variables for a pod
- Get and Set Volumes for a pod
- Example code
- Dynamic engine selection
- Remote engines via GUI
- Contributing
Shiphelm is a Python library for interacting with containers more easily. With Shiphelm, you can:
- Get a list of all running containers
- Get usage statistics and used ports for a given container by ID
- Search containers by name or ID
- Change the open ports of a container
- Run new containers
- Work with Docker, and Kubernetes
- Use Kubernetes clusters and Docker Swarm
- work on clusters, and swarms of container hosts
You can install Shiphelm using pip:
pip install shiphelm
PyPI: https://pypi.org/project/Shiphelm/
GitHub Releases https://github.com/Gameplex-Software/ShipHelm/releases
This code will allow you to manage the local container engine
from shiphelm.helm import helm
hd = helm() # create an instance of helm
helm.set_engine_manual("docker")
This code will allow you to manage any compatible remote container engine
from shiphelm.helm import helm
hd = helm.reomte_connect('tcp://remote-docker-host:2375') # create an instance of helmdocker for romote management
from shiphelm.helm import helm
hd = helm.helm() # create an instance of helm
helm.set_engine_manual(engine_select="docker", remoteAddress="YOUR ADDRESS HERE", remoteSecurity=<True|False>)
running_containers = hd.get_running_containers()
get_container_by_id(container_id)
container_stats = hd.get_container_stats(container_id)
container_ports = hd.get_container_ports(container_id)
containers_by_name = hd.search_containers(name)
hd.change_container_ports(container_id, ports)
hd.rename_container(container_id, new_name)
hd.add_container_to_network(container_id, network_name)
hd.remove_container_from_network(container_id, network_name)
hd.create_network(network_name)
hd.delete_network(network_name)
container = hd.run_container(
image=image,
command=command,
detach=detach,
ports=ports,
environment=environment,
volumes=volumes
)
ShipHelm is capable of retrieving your container's inspect data and re-creating the original command that was used to run your pod, allowing you to re-create it anywhere
container_name = "your_container_name"
namespace = "your_namespace" # Default is "default"
run_command = get_kubernetes_run_command(pod_name, namespace)
print(f"Run command for pod {pod_name} in namespace {namespace}: {run_command}")
container_environment = hd.get_container_environment(container_id)
hd.set_container_environment(container_id, environment)
container_volumes = hd.get_container_volumes(container_id)
hd.set_container_volumes(container_id, volumes)
This example runs 4 instances of the Docker "Getting Started" container
from shiphelm.helmdocker import helmdocker
hd = helmdocker() # create an instance of helmdocker
container_list = hd.get_running_containers() # call the method on the instance
print(container_list)
w=0
print("Preparing new server...")
while w<3:
hd.run_container(image="docker/getting-started", detach=1)
w=w+1
print("Your server is up and ready for connection!")
This code will allow you to manage the local container engine
from shiphelm.helm import helm
hd = helm.helm() # create an instance of helm
helm.set_engine_manual("kubernetes")
This code will allow you to manage any compatible remote container engine
from shiphelm.helm import helm
hd = helm.reomte_connect('tcp://remote--host:2375') # create an instance of helm for romote management
running_containers = hd.get_running_containers()
container_stats = hd.get_container_stats(container_id)
container_ports = hd.get_container_ports(container_id)
containers_by_name = hd.search_containers(name)
hd.change_container_ports(container_id, ports)
hd.rename_container(container_id, new_name)
hd.add_container_to_network(container_id, network_name)
hd.remove_container_from_network(container_id, network_name)
hd.create_network(network_name)
hd.delete_network(network_name)
container = hd.run_container(
image=image,
command=command,
detach=detach,
ports=ports,
environment=environment,
volumes=volumes
)
ShipHelm is capable of retrieving your pod's inspect data and re-creating the original command that was used to run your pod, allowing you to re-create it anywhere
pod_name = "your_pod_name"
namespace = "your_namespace" # Default is "default"
run_command = get_kubernetes_run_command(pod_name, namespace)
print(f"Run command for pod {pod_name} in namespace {namespace}: {run_command}")
container_environment = hd.get_container_environment(container_id)
hd.set_container_environment(container_id, environment)
container_volumes = hd.get_container_volumes(container_id)
hd.set_container_volumes(container_id, volumes)
This example runs 4 instances of the "Getting Started" pod
from shiphelm.helm import helm
hd = helm() # create an instance of helm
container_list = hd.get_running_containers() # call the method on the instance
print(container_list)
w=0
print("Preparing new server...")
while w<3:
hd.run_container(image="ollyw123/helloworld", detach=1)
w=w+1
print("Your server is up and ready for connection!")
You may have noticed that the syntax for controling both Docker and Kubernetes are identical, the way the code you write for ShipHelm is run depends on the engine you selected last.
In the last example we used the follwing code to initilise ShipHelm, create an alias, and select a pod engine:
from shiphelm.helm import helm
hd = helm.helm() # create an instance of helm
helm.set_engine_manual("kubernetes")
f you want your cod to be able to use either engine that it detects locally you can use the following code instead:
from shiphelm.helm import helm
hd = helm.helm() # create an instance of helm
helm.set_engine_auto()
To use remote engines you can use the following the examples above to connect programatically or use the below code to open a GUI configuration wizard:
from shiphelm.helm import helm
hd = helm.helm() # create an instance of helm
helm.remote_popup()
If you would like to contribute to SkiffUI, please feel free to open a pull request or issue on the GitHub repository.
<script src="https://giscus.app/client.js" data-repo="Gameplex-Software/ShipHelm" data-repo-id="R_kgDOJGgWLg" data-category="General" data-category-id="DIC_kwDOJGgWLs4CVv98" data-mapping="pathname" data-strict="0" data-reactions-enabled="1" data-emit-metadata="0" data-input-position="bottom" data-theme="light" data-lang="en" data-loading="lazy" crossorigin="anonymous" async> </script>