diff --git a/README.md b/README.md index 36ffe87..0e996c3 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,34 @@ This project, hosted on [git.cryptic.systems](https://git.cryptic.systems/volker.raschek/network-tools), -contains only files to build to container image. The container image contains +contains only files to build the container image. The container image contains network tools to analyse or monitor network communication. This can be helpful in a containerized environment. ## Usage -To use this image execute the following command. +### Docker + +To use this image execute the following command in a docker environment. ```bash $ docker run \ --rm \ volkerraschek/network-tools:latest \ bash +``` + +### Kubernetes + +For a kubernetes environment you can use the [YAML-File](network-tools.yaml) by +executing the following command. + +```bash +$ kubectl create -f https://git.cryptic.systems/volker.raschek/network-tools/network-tools.yml +``` + +Execute a shell inside the container by + +```bash +kubectl exec -it network-tools -- sh ``` \ No newline at end of file diff --git a/network-tools.yml b/network-tools.yml new file mode 100644 index 0000000..2ed5c46 --- /dev/null +++ b/network-tools.yml @@ -0,0 +1,11 @@ +apiVersion: v1 +kind: Pod +metadata: + name: network-tools +spec: + containers: + - name: network-tools + image: volkerraschek/network-tools:latest + command: [ "sleep", "3600" ] + imagePullPolicy: Always + restartPolicy: Always \ No newline at end of file