Verified Commit cebccd27 authored by Snorre Magnus Davøen's avatar Snorre Magnus Davøen 💬
Browse files

Initial implementation of containinator



Implement cli-matic based command line app in Clojure to deal with
containers in GitLab. Adds two commands, locate and terminate, that each
serves a well defined purpose.

The locate command finds projects with container registry enabled and
shows key stats about projects.

The terminate command takes each project with a container registry and
instructs GitLab to delete tags in bulk given user supplied options (or
default values).

The command line app is compiled to a native binary using GraalVM's
native-image command.
Signed-off-by: Snorre Magnus Davøen's avatarSnorre Magnus Davøen <snorre.davoen@nsd.no>
parents
/target
/classes
/checkouts
pom.xml
pom.xml.asc
*.jar
*.class
/.cpcache
/.lein-*
/.nrepl-history
/.nrepl-port
.hgignore
.hg/
containinator
.token
\ No newline at end of file
# Change Log
All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
## [Unreleased]
### Added
- Initial implementation of command line app
- locate argument to list projects with container registry
- terminate argument to instruct GitLab to bulk delete Docker image tags from projects' registries
[Unreleased]: https://gitlab.nsd.no/ops/containinator/compare/master...master
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and
documentation distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are
distributed by that particular Contributor. A Contribution 'originates' from
a Contributor if it was added to the Program by such Contributor itself or
anyone acting on such Contributor's behalf. Contributions do not include
additions to the Program which: (i) are separate modules of software
distributed in conjunction with the Program under their own license
agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents" mean patent claims licensable by a Contributor which are
necessarily infringed by the use or sale of its Contribution alone or when
combined with the Program.
"Program" means the Contributions distributed in accordance with this
Agreement.
"Recipient" means anyone who receives the Program under this Agreement,
including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants
Recipient a non-exclusive, worldwide, royalty-free copyright license to
reproduce, prepare derivative works of, publicly display, publicly perform,
distribute and sublicense the Contribution of such Contributor, if any, and
such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants
Recipient a non-exclusive, worldwide, royalty-free patent license under
Licensed Patents to make, use, sell, offer to sell, import and otherwise
transfer the Contribution of such Contributor, if any, in source code and
object code form. This patent license shall apply to the combination of the
Contribution and the Program if, at the time the Contribution is added by the
Contributor, such addition of the Contribution causes such combination to be
covered by the Licensed Patents. The patent license shall not apply to any
other combinations which include the Contribution. No hardware per se is
licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses
to its Contributions set forth herein, no assurances are provided by any
Contributor that the Program does not infringe the patent or other
intellectual property rights of any other entity. Each Contributor disclaims
any liability to Recipient for claims brought by any other entity based on
infringement of intellectual property rights or otherwise. As a condition to
exercising the rights and licenses granted hereunder, each Recipient hereby
assumes sole responsibility to secure any other intellectual property rights
needed, if any. For example, if a third party patent license is required to
allow Recipient to distribute the Program, it is Recipient's responsibility
to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient
copyright rights in its Contribution, if any, to grant the copyright license
set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under
its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and
conditions, express and implied, including warranties or conditions of title
and non-infringement, and implied warranties or conditions of merchantability
and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for
damages, including direct, indirect, special, incidental and consequential
damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered
by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such
Contributor, and informs licensees how to obtain it in a reasonable manner on
or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within
the Program.
Each Contributor must identify itself as the originator of its Contribution,
if any, in a manner that reasonably allows subsequent Recipients to identify
the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with
respect to end users, business partners and the like. While this license is
intended to facilitate the commercial use of the Program, the Contributor who
includes the Program in a commercial product offering should do so in a
manner which does not create potential liability for other Contributors.
Therefore, if a Contributor includes the Program in a commercial product
offering, such Contributor ("Commercial Contributor") hereby agrees to defend
and indemnify every other Contributor ("Indemnified Contributor") against any
losses, damages and costs (collectively "Losses") arising from claims,
lawsuits and other legal actions brought by a third party against the
Indemnified Contributor to the extent caused by the acts or omissions of such
Commercial Contributor in connection with its distribution of the Program in
a commercial product offering. The obligations in this section do not apply
to any claims or Losses relating to any actual or alleged intellectual
property infringement. In order to qualify, an Indemnified Contributor must:
a) promptly notify the Commercial Contributor in writing of such claim, and
b) allow the Commercial Contributor tocontrol, and cooperate with the
Commercial Contributor in, the defense and any related settlement
negotiations. The Indemnified Contributor may participate in any such claim
at its own expense.
For example, a Contributor might include the Program in a commercial product
offering, Product X. That Contributor is then a Commercial Contributor. If
that Commercial Contributor then makes performance claims, or offers
warranties related to Product X, those performance claims and warranties are
such Commercial Contributor's responsibility alone. Under this section, the
Commercial Contributor would have to defend claims against the other
Contributors related to those performance claims and warranties, and if a
court requires any other Contributor to pay any damages as a result, the
Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON
AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER
EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the
appropriateness of using and distributing the Program and assumes all risks
associated with its exercise of rights under this Agreement , including but
not limited to the risks and costs of program errors, compliance with
applicable laws, damage to or loss of data, programs or equipment, and
unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under
applicable law, it shall not affect the validity or enforceability of the
remainder of the terms of this Agreement, and without further action by the
parties hereto, such provision shall be reformed to the minimum extent
necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Program itself
(excluding combinations of the Program with other software or hardware)
infringes such Recipient's patent(s), then such Recipient's rights granted
under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to
comply with any of the material terms or conditions of this Agreement and
does not cure such failure in a reasonable period of time after becoming
aware of such noncompliance. If all Recipient's rights under this Agreement
terminate, Recipient agrees to cease use and distribution of the Program as
soon as reasonably practicable. However, Recipient's obligations under this
Agreement and any licenses granted by Recipient relating to the Program shall
continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in
order to avoid inconsistency the Agreement is copyrighted and may only be
modified in the following manner. The Agreement Steward reserves the right to
publish new versions (including revisions) of this Agreement from time to
time. No one other than the Agreement Steward has the right to modify this
Agreement. The Eclipse Foundation is the initial Agreement Steward. The
Eclipse Foundation may assign the responsibility to serve as the Agreement
Steward to a suitable separate entity. Each new version of the Agreement will
be given a distinguishing version number. The Program (including
Contributions) may always be distributed subject to the version of the
Agreement under which it was received. In addition, after a new version of
the Agreement is published, Contributor may elect to distribute the Program
(including its Contributions) under the new version. Except as expressly
stated in Sections 2(a) and 2(b) above, Recipient receives no rights or
licenses to the intellectual property of any Contributor under this
Agreement, whether expressly, by implication, estoppel or otherwise. All
rights in the Program not expressly granted under this Agreement are
reserved.
This Agreement is governed by the laws of the State of New York and the
intellectual property laws of the United States of America. No party to this
Agreement will bring a legal action under this Agreement more than one year
after the cause of action arose. Each party waives its rights to a jury trial
in any resulting litigation.
# containinator
A simple Clojure command line app to instruct GitLab to clean Docker image tags for all projects.
It uses the GitLab REST API (v4) to retrieve project information and sending bulk deletion requests for tags.
The app can be used to list projects and their number of registry repositories and tags as well.
The app is meant to be used in conjunction with [GitLab's docker-distribution-pruner](https://gitlab.com/gitlab-org/docker-distribution-pruner).
The `docker-distribution-pruner` cli app seems to delete more of the orphaned image data than the built in `gitlab-ctl registry-garbage-collect`.
For this reason you should probably use `docker-distribution-pruner` after running containinator.
## Installation
TBD
### Caveat
Currently binaries compiled with GraalVM's native-image does not hardlink the `sunec` dependency.
If you are running the binary on its own you need to supply the sunec library via an openjdk or graalvm installation.
There is [an issue](https://github.com/oracle/graal/issues/1336) about this in the official graal repository.
For the time being you can run the binary with `containinator -Djava.library.path=/<path to java/graal>/lib/`.
The Docker image will bundle the sunec dependency.
## Usage
```bash
./containinator --help
```
There are two sub-commands in the app:
- locate
- terminate
The `locate` command lists projects and key stats about the project's container registry.
The `terminate` command sends bulk tag deletion commands for all projects with a container registry.
## Examples
```bash
./containinator -Djava.library.path=$JAVA_HOME/lib/ --token <yourtoken> --gitlab https://gitlab.<yourdomain>.<tld> locate --sort tag-count --limit 20
Locating projects for given arguments on https://gitlab.nsd.no Please be patient, it could take some time.
| :id | :name | :registry-count | :tag-count |
|-----+-----------------------+-----------------+------------|
| 123 | project-a | 1 | 28 |
| 242 | project-b | 1 | 27 |
```
## Development
...
...
## License
Copyright © 2019 NSD - Norsk senter for forskningsdata AS
Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.
The `links.clj` file is verbatim copied from [clj-http](https://github.com/dakrone/clj-http) and retains its original license.
{:paths ["resources" "src"]
:deps {org.clojure/clojure {:mvn/version "1.9.0"}
cli-matic {:mvn/version "0.3.7"}
org.martinklepsch/clj-http-lite {:mvn/version "0.4.1"}
clj-http {:mvn/version "3.10.0"}
metosin/muuntaja {:mvn/version "0.6.4"}}
:aliases
{:test {:extra-paths ["test"]
:extra-deps {org.clojure/test.check {:mvn/version "RELEASE"}}}
:native-image
{:main-opts ["-m clj.native-image containinator"
"--enable-url-protocols=http,https"
"--report-unsupported-elements-at-runtime"
"--initialize-at-build-time"
"--no-fallback"
"-H:Name=containinator"]
:jvm-opts ["-Dclojure.compiler.direct-linking=true"]
:extra-deps
{clj.native-image
{:git/url "https://github.com/taylorwood/clj.native-image.git"
:sha "567176ddb0f7507c8b0969e0a10f60f848afaf7d"}}}
:runner
{:extra-deps {com.cognitect/test-runner
{:git/url "https://github.com/cognitect-labs/test-runner"
:sha "76568540e7f40268ad2b646110f237a60295fa3c"}}
:main-opts ["-m" "cognitect.test-runner"
"-d" "test"]}
:uberjar {:extra-deps {seancorfield/depstar {:mvn/version "RELEASE"}}
:main-opts ["-m" "hf.depstar.uberjar" "containinator.jar"]}}}
(ns containinator
(:gen-class)
(:require [clj-http.lite.client :as http]
[links :refer [links-response]]
[cli-matic.core :refer [run-cmd] :as cli]
[clojure.pprint :as pprint]
[clojure.string :as string]
[muuntaja.core :as m]))
(defn http-opts
[{:keys [token form-params]}]
(cond-> {:accept :json
:headers {"PRIVATE-TOKEN" token}}
form-params (assoc :form-params form-params)))
(defn http-wrap
"Wrapper around clj-http-lite's get function that handles JSON body decoding."
[method link args]
(let [args (http-opts args)
response (method link args)]
(->> (:body response)
(m/decode "application/json")
(assoc response :body)
links-response)))
(def http-get (partial http-wrap http/get))
(def http-put (partial http-wrap http/put))
(def http-delete (partial http-wrap http/delete))
(defn process-args
"Takes command line arguments and processes them"
[args]
(update args :gitlab #(str % "/api/v4")))
(defn tags!
"Fetch the tags of a registry repository from GitLab"
[args link]
(let [resp (http-get link args)
tags (:body resp)
next (->> resp :links :next :href)]
(lazy-cat tags
(some->> next (tags! args)))))
(defn fetch-tags!
"Fetch tags lazily"
[args project-id registry-id]
(->> (str (:gitlab args) "/projects/" project-id "/registry/repositories/" registry-id "/tags")
(tags! args)
(lazy-cat [])))
(defn registries!
[args project-id link]
(let [resp (http-get link args)
registries (->> (:body resp)
(map #(select-keys % [:id :path :name]))
(map #(->> (fetch-tags! args project-id (:id %))
(assoc % :tags))))
next (->> resp :links :next :href)]
(lazy-cat registries
(some->> next (registries! args project-id)))))
(defn fetch-registries!
"Lazily fetch registries"
[args project-id]
(->> (str (:gitlab args) "/projects/" project-id "/registry/repositories")
(registries! args project-id)
(lazy-cat [])))
(defn projects!
[args link]
(let [resp (http-get link args)
projects (->> (:body resp)
(filter :container_registry_enabled)
(map #(select-keys % [:id :name :web_url :container_registry_enabled]))
(map #(->> (fetch-registries! args (:id %))
(assoc % :registries))))
next (->> resp :links :next :href)]
(lazy-cat projects
(some->> next (projects! args)))))
(defn disable-container-registry!
"Disables container registry for project with given id"
[args project-id]
(->> (http-put (str (:gitlab args) "/projects/" project-id)
(assoc args :form-params {:container_registry_enabled false}))
:body))
(defn delete-tags!
"Delete all tags matching args for given project and registry id.
Args should contain options :keep_n, :older_than, and :name_regex.
Returns status code for deletion request."
[args project-id registry-id]
(->> (http-delete (str (:gitlab args)
"/projects/"
project-id
"/registry/repositories/"
registry-id
"/tags")
(assoc args
:form-params
(select-keys args [:keep_n :older_than :name_regex])))
:body))
(defn fetch-projects!
"Lazily fetch projects"
[args]
(lazy-cat
[]
(projects! args (str (:gitlab args) "/projects"))))
(defn sort-projects
"Sort projects by given key"
[sort-key projects]
(case sort-key
:none projects
:tag-count (sort-by (comp - :tag-count) projects)
(sort-by sort-key projects)))
(defn locate!
"List projects with a container registry given args. If :sort key provided in args
the function will sort the projects by the selected key. if :limit key provided the
function returns the requested number of projects. Projects are pretty-printed as a
table. This means the entire list of projects must be computed before printing occurs."
[args]
(println "Locating projects for given arguments on" (:gitlab args)
"Please be patient, it could take some time." \newline)
(let [args (process-args args)
projects (cond->> (fetch-projects! args)
true
(map #(->> (:registries %)
count
(assoc % :registry-count)))
true
(map #(->> (:registries %)
(map (fn [registry]
(count (:tags registry))))
(reduce +)
(assoc % :tag-count)))
true
(sort-projects (:sort args))
(:limit args)
(take (:limit args)))]
(pprint/print-table
[:id :name :registry-count :tag-count]
projects)))
(defn terminate!
"Instructs GitLab to delete container image tags for all projects and their registries. Supplied
args determines :keep_n number of tags to keep, :older_than age for which to delete, and name_regex
to match tags to delete. In combination these args determines which tags should be matched for deletion."
[args]
(let [args (process-args args)
projects (fetch-projects! args)]
(println "Deleting projects given args:")
(pprint/print-table [(dissoc args :token)])
(doseq [project projects]
(println "Delete tags for project" (:name project))
(doseq [registry (:registries project)]
(delete-tags! args (:id project) (:id registry))))))
(def app-config
{:app {:command "containinator"
:description "A command to locate and terminate Docker image tags on GitLab servers"
:version "0.1"}
:global-opts [{:option "token"
:short "t"
:env "CONTAININATOR_TOKEN"
:as "GitLab Oauth token with api scope"
:type :string
:spec string?}
{:option "gitlab"
:short "g"
:env "CONTAININATOR_GITLAB"
:as "GitLab Host (e.g. https://gitlab.domain.tld)"
:type :string
:spec string?}]
:commands [{:command "locate"
:description "List all projects with an active GitLab container registry"
:runs locate!
:opts [{:option "sort"
:short "s"
:as "Sort output by property"
:type #{:id :name :tag-count}
:default :none}
{:option "limit"
:short "l"
:as "Limit number of projects to locate"
:type :int}]}
{:command "terminate"
:description "Terminate Docker image tags in GitLab projects matching supplied arguments"
:runs terminate!
:opts [{:option "keep_n"
:short "k"
:as "Number of tags to keep"
:type :int
:default 25}
{:option "older_than"
:short "o"
:as "Delete tags older than"
:type :string
:default "1month"}
{:option "name_regex"
:short "n"
:as "Delete tags matching regex"
:type :string
:default ".*"}]}]})
(defn -main
"Entrypoint for containinator app"
[& args]
(run-cmd args app-config))
;; Rich comments
(comment
(cli/assert-cfg-sanity app-config)
(cli/parse-cmds ["-t" "foo" "-g" "https://gitlab.example.com" "terminate"] app-config))
(ns links
"Functions to parse link header.
Original source: https://github.com/dakrone/clj-http/blob/70df5add2a565a87d2ac79b39e90f777999babc0/src/clj_http/links.clj
The MIT License (MIT)
Copyright (c) 2013 M. Lee Hinman
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the \"Software\"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.")
(def ^:private quoted-string
#"\"((?:[^\"]|\\\")*)\"")
(def ^:private token
#"([^,\";]*)")
(def ^:private link-param
(re-pattern (str "(\\w+)=(?:" quoted-string "|" token ")")))
(def ^:private uri-reference
#"<([^>]*)>")
(def ^:private link-value
(re-pattern (str uri-reference "((?:\\s*;\\s*" link-param ")*)")))