stuttgart-things/install-configure-podman

installs and configures podman, buildah and skopeo on various linux os

Variables

• install_tools - Set this on False if you don't want buildah and skopeo to be installed (default: true)
• buildah_version - Set the wanted buildah version
• skopeo_version - Set the wanted skopeo version
• configure_docker_registry_mirror - Set this on true if you want docker registry mirrors to be created (default: false)
• ubuntu_version - If you don't use a different OS, set your Ubuntu version

ROLE INSTALLATION

copy and paste the following into your terminal:

cat <<EOF > /tmp/requirements.yaml
roles:
- src: https://github.com/stuttgart-things/install-configure-podman.git
  scm: git
- src: https://github.com/stuttgart-things/install-requirements.git
  scm: git

collections:
- name: community.general
  version: 8.6.0
- name: containers.podman
  version: 1.13.0
EOF

ansible-galaxy install -r /tmp/requirements.yaml --force
ansible-galaxy collection install -r /tmp/requirements.yaml --force

rm -rf /tmp/requirements.yaml

EXAMPLE INVENTORY

cat <<EOF > inventory
[appserver]
1.2.3.4 ansible_user=sthings
EOF

EXAMPLE PLAYBOOK

copy and paste the following (on any place of the filesystem of the ansible host) into your terminal:

cat <<EOF > install-configure-podman.yaml
---
- hosts: "{{ target_host | default('all') }}"
  become: true
  roles:
    - role: install-configure-podman
EOF 

EXAMPLE EXECUTION

ansible-playbook -i inventory install-configure-podman.yaml -vv 

EXAMPLE USE-CASES BUILDAH AND PODMAN

# Check buildah version
buildah version

# Pull Image
buildah pull alpine

# Create Dockerfile
# Podman and Buildah default to Containerfile and will fall back to Dockerfile.
cat <<EOF > Dockerfile
FROM ubuntu:18.04
RUN echo 'Hello, World!' > /test.txt
EOF

# Build Image
buildah build -t hello-world -f ./Dockerfile .

# Run Podman (--rm = delete container after running)
podman run -it hello-world cat /test.txt

# Show Container name and ID
podman ps

# Stop Container
podman stop {container-name-or-id}

# Copy file from local to container
buildah copy container-name ./example.sh /usr/bin

# Configure Image to run commands
buildah config --cmd /usr/bin/example.sh container-name

# Buildah unmount container
buildah config --cmd /usr/bin/example.sh container-name

# Buildah commit image
 buildah commit container-name new-image-name

# Show Image
buildah images

EXAMPLE USE-CASES PODMAN PLAY KUBE

The Podman Play Kube Option is not available for remote clients, including Mac and Windows (excluding WSL2) machines, yet.

Currently supported Kinds in Kubernetes:

• Pod
• Deployment
• PersistentVolumeClaim
• ConfigMap

# Create Pod
cat <<EOF > example-pod.yaml
---
apiVersion: v1
kind: Pod
metadata:
  name: hello-world-pod-2
  labels:
    app: hello-world
spec:
  containers:
  - name: hello-world-sh
    image: busybox
    command: ['sh', '-c', 'while true; do echo "Hello World"; sleep 2; done']
  - name: hello-world-http
    image: busybox
    command: ['sh','-c', 'echo "hello world" > index.html && /bin/httpd -p 9000 -f']
    ports:
    - containerPort: 9000
      protocol: TCP

EOF

Service

SERVICE TO EXPOSE POD TO PUBLIC

# Create Service to expose pod to public
cat <<EOF > example-service.yaml
---
kind: Service
apiVersion: v1
metadata:
  name: hello-world-svc
spec:
  type: NodePort           
  ports:
  - port: 80
    targetPort: 9000
  selector:
    app: hello-world

EOF

# Create pod
podman play kube example-pod.yaml

# Tear down pod
podman play kube --down example-pod.yaml

EXAMPLE USE-CASE PODMAN GENERATE KUBE

GENERATE KUBE YAML

Note: When using volumes and generating a Kubernetes YAML for an unprivileged and rootless podman container on an SELinux enabled system, one of the following options must be completed:

• Add the “privileged: true” option to the pod spec
• Add type: spc_t under the securityContext seLinuxOptions in the pod spec
• Relabel the volume via the CLI command chcon -t container_file_t -R /directory

# Generate yaml from Kubernetes Ressource
podman generate kube example-pod-name

EXAMPLE USE-CASES SKOPEO

# Login to private registry with authentication
skopeo login --username USER myregistrydomain.com:5000
# Logout of private registry
skopeo logout myregistrydomain.com:5000

# Show properties of docker.io/library/alpine
skopeo inspect docker://docker.io/library/alpine

# Syncing registries
skopeo sync --src docker --dest dir registry.example.com/busybox /media/usb

# Copy Image
skopeo copy oci:busybox_ocilayout:latest dir:existingemptydirectory
# Copy Image with creds
skopeo copy --src-creds=testuser:testpassword docker://myregistrydomain.com:5000/private oci:local_oci_image

License

LICENSE

Copyright 2020 patrick hermann.

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.

Role history

date	who	changelog
2024-30-04	Andre Ebert	Added Buildah and Skopeo install, added Ansible- and Yamllint with skip rules and collection release workflow
2020-10-10	Patrick Hermann	Updated for using ansible collections, added Debian support; defined stable version
2020-04-03	Patrick Hermann	intial commit for this role on codehub

Author Information

Andre Ebert (andre.ebert@sva.de); 04/2024

Patrick Hermann (patrick.hermann@sva.de); Stuttgart-Things; 04/2020