Skip to content

Commit

Permalink
worked on :docker module
Browse files Browse the repository at this point in the history
  • Loading branch information
@jlangch
jlangch committed Aug 26, 2023
1 parent c40858c commit 12a22a9
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 16 deletions.
4 changes: 4 additions & 0 deletions ...in/java/com/github/jlangch/venice/impl/docgen/cheatsheet/modules/ModuleDockerSection.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ public DocSection section() {
containers.addItem(diBuilder.getDocItem("docker/start", false));
containers.addItem(diBuilder.getDocItem("docker/stop", false));
containers.addItem(diBuilder.getDocItem("docker/cp", false));
containers.addItem(diBuilder.getDocItem("docker/diff", false));
containers.addItem(diBuilder.getDocItem("docker/pause", false));
containers.addItem(diBuilder.getDocItem("docker/unpause", false));
containers.addItem(diBuilder.getDocItem("docker/wait", false));

return section;
}
Expand Down
112 changes: 96 additions & 16 deletions src/main/resources/com/github/jlangch/venice/docker.venice
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@

;;;; Docker utilities

;;;; See: https://docs.docker.com/engine/reference/commandline/


(ns docker)

Expand All @@ -32,7 +34,7 @@

Options:

| :format {:pretty,:json} | Returns the output either as a pretty printed string or as Json data |
| :format {:pretty, :json} | Returns the output either as a pretty printed string or as JSON data |
"""
:examples '(
"(docker/version)"
Expand All @@ -56,10 +58,10 @@

Options:

| :all {true,false} | Show all images (default hides intermediate images) |
| :digests {true,false} | Show digests |
| :quiet {true,false} | If true only display image IDs |
| :format {:table,:json} | Returns the output either as a table string or as Json data |
| :all {true, false} | Show all images (default hides intermediate images) |
| :digests {true, false} | Show digests |
| :quiet {true, false} | If true only display image IDs |
| :format {:table, :json} | Returns the output either as a table string or as JSON data |
"""
:examples '(
"(println (docker/images :format :table))"
Expand Down Expand Up @@ -105,7 +107,7 @@

Options:

| :all {true,false} | Remove all unused images, not just dangling ones |
| :all {true, false} | Remove all unused images, not just dangling ones |
"""
:examples '(
"(println (docker/images :format :table))"
Expand All @@ -131,10 +133,10 @@

Options:

| :all {true,false} | Show all containers (default shows just running) |
| :last n | Show n last created containers |
| :quiet {true,false} | If true only display container IDs |
| :format {:table,:json} | Returns the output either as a table string or as Json data |
| :all {true, false} | Show all containers (default shows just running) |
| :last n | Show n last created containers |
| :quiet {true, false} | If true only display container IDs |
| :format {:table, :json} | Returns the output either as a table string or as JSON data |
"""
:examples '(
"(println (docker/ps :format :table))"
Expand Down Expand Up @@ -167,7 +169,7 @@

Options:

| :attach {true,false} | Attach STDOUT/STDERR and forward signals |
| :attach {true, false} | Attach STDOUT/STDERR and forward signals |
"""
:examples '(
"""(docker/start id "b19b498c670b")""" )
Expand Down Expand Up @@ -218,9 +220,9 @@

Options:

| :archive {true,false} | Archive mode (copy all uid/gid information) |
| :follow-link {true,false} | Always follow symbol link in SRC_PATH|
| :quiet {true,false} | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
| :archive {true, false} | Archive mode (copy all uid/gid information) |
| :follow-link {true, false} | Always follow symbol link in SRC_PATH|
| :quiet {true, false} | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
"""
:examples '(
"""
Expand Down Expand Up @@ -256,6 +258,85 @@
(:out))))


(defn
^{ :arglists '("(docker/diff container-id & options)")
:doc """
Inspect changes to files or directories on a container's filesystem.

Options:

| :format {:string, :json} | Returns the output either as a string or as JSON data |
"""
:examples '(
"""
(println (docker diff 74789744g489))
""",
"""
(docker diff 74789744g489 :format :json)
""" )
:see-also '("docker/ps") }

diff [container-id & options]

(let [opts (apply hash-map options)
format (:format opts :string)
output (:out (docker/cmd "diff" container-id))
actions {"A" :added, "C" :changed, "D" :deleted}]
(if (= format :json)
(->> (str/split-lines output)
(map #(str/split-at % 1))
(map #(vector (get actions (first %)) (str/trim (second %)))))
output)))


(defn
^{ :arglists '("(docker/pause container-id)")
:doc """
Pause all processes within a container
"""
:examples '(
"""
(docker pause 74789744g489)
""" )
:see-also '("docker/ps") }

pause [container-id]

(:out (docker/cmd "pause" container-id)))


(defn
^{ :arglists '("(docker/unpause container-id)")
:doc """
Unpause all processes within a container
"""
:examples '(
"""
(docker unpause 74789744g489)
""" )
:see-also '("docker/ps") }

unpause [container-id]

(:out (docker/cmd "unpause" container-id)))


(defn
^{ :arglists '("(docker/wait &container-ids)")
:doc """
Block until one or more containers stop, then return their exit codes
"""
:examples '(
"""
(docker wait 74789744g489)
""" )
:see-also '("docker/ps") }

wait [&container-ids]

(:out (docker/cmd "wait" (apply str container-ids))))


(defn
^{ :arglists '("(docker/cmd & args)")
:doc """
Expand Down Expand Up @@ -285,8 +366,7 @@

(defn- parse-output [format output]
(if (= format :json)
(->> (str/split-lines output) ;; docker you're kidding
(map json/read-str))
(json/read-str (str "[" output "]")) ;; docker you're kidding
output))


Expand Down

0 comments on commit 12a22a9

Please sign in to comment.