diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..29dc7cf
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+ - package-ecosystem: "github-actions"
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "weekly"
+ - package-ecosystem: "docker"
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "weekly"
\ No newline at end of file
diff --git a/.github/workflows/on-push-main.yml b/.github/workflows/on-push-main.yml
new file mode 100644
index 0000000..98f51c4
--- /dev/null
+++ b/.github/workflows/on-push-main.yml
@@ -0,0 +1,54 @@
+name: On push to main
+
+on:
+ push:
+ branches:
+ - main
+
+env:
+ PLATFORMS: "linux/amd64,linux/arm64,linux/arm/v7"
+
+jobs:
+ build_and_push:
+ name: Build and push Docker image
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v3
+
+ - name: Extract tag string
+ id: git
+ shell: bash
+ run: |
+ RELEASE_VERSION="dev-$(date +%s)"
+ echo "image_tag=${RELEASE_VERSION}" >> ${GITHUB_OUTPUT}
+
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v2
+
+ - name: Install buildx
+ uses: docker/setup-buildx-action@v2.7.0
+
+ - name: Login to docker hub
+ uses: docker/login-action@v2.2.0
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+ - name: Login to GitHub Container Registry
+ uses: docker/login-action@v2.2.0
+ with:
+ registry: ghcr.io
+ username: ${{ github.repository_owner }}
+ password: ${{ github.token }}
+
+ - name: Build and push ${{ github.repository }}:${{ steps.git.outputs.image_tag }}
+ uses: docker/build-push-action@v4.1.1
+ with:
+ platforms: ${{ env.PLATFORMS }}
+ push: true
+ tags: |
+ ${{ github.repository }}:${{ steps.git.outputs.image_tag }}
+ ${{ github.repository }}:development
+ ghcr.io/${{ github.repository }}:${{ steps.git.outputs.image_tag }}
+ ghcr.io/${{ github.repository }}:development
diff --git a/.github/workflows/on-release.yml b/.github/workflows/on-release.yml
new file mode 100644
index 0000000..d8ed257
--- /dev/null
+++ b/.github/workflows/on-release.yml
@@ -0,0 +1,62 @@
+name: On release
+
+on:
+ release:
+ types: # This configuration does not affect the page_build event above
+ - created
+
+env:
+ PLATFORMS: "linux/amd64,linux/arm64,linux/arm/v7"
+
+jobs:
+ build_and_push:
+ name: Build and push Docker image
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v3
+
+ - name: Extract tag string
+ id: git
+ shell: bash
+ run: |
+ RELEASE_VERSION=${GITHUB_REF#refs/*/}
+ echo "image_tag=${RELEASE_VERSION}" >> ${GITHUB_OUTPUT}
+
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v2
+
+ - name: Install buildx
+ uses: docker/setup-buildx-action@v2.7.0
+
+ - name: Login to docker hub
+ uses: docker/login-action@v2.2.0
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+ - name: Login to GitHub Container Registry
+ uses: docker/login-action@v2.2.0
+ with:
+ registry: ghcr.io
+ username: ${{ github.repository_owner }}
+ password: ${{ github.token }}
+
+ - name: Build and push ${{ github.repository }}:${{ steps.git.outputs.image_tag }}
+ uses: docker/build-push-action@v4.1.1
+ with:
+ platforms: ${{ env.PLATFORMS }}
+ push: true
+ tags: |
+ ${{ github.repository }}:${{ steps.git.outputs.image_tag }}
+ ${{ github.repository }}:latest
+ ghcr.io/${{ github.repository }}:${{ steps.git.outputs.image_tag }}
+ ghcr.io/${{ github.repository }}:latest
+
+ - name: Update dockerhub description
+ uses: peter-evans/dockerhub-description@v3
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_PASSWORD }}
+ repository: ${{ github.repository }}
+ short-description: ${{ github.event.repository.description }}
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..cad5548
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,16 @@
+FROM alpinelinux/docker-cli:latest
+
+LABEL org.opencontainers.image.title=gantry
+LABEL org.opencontainers.image.description="Updating docker swarm services"
+LABEL org.opencontainers.image.vendor="Shizun Ge"
+LABEL org.opencontainers.image.licenses=GPLv3
+
+RUN mkdir -p /gantry
+
+WORKDIR /gantry
+
+RUN apk add --update --no-cache curl tzdata
+
+COPY src/* /gantry
+
+ENTRYPOINT ["/gantry/entrypoint.sh"]
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..af0cb36
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+# Gantry
+
+*Gantry* is a tool to update docker swarm services, inspired by [Shepherd](https://github.com/containrrr/shepherd)
+
+## Usage
+
+We release *Gantry* as a container [image](https://hub.docker.com/r/shizunge/gantry). You can create a docker service and run it on a swarm manager node.
+
+```
+docker service create \
+ --name gantry \
+ --mode replicated-job \
+ --constraint "node.role==manager" \
+ --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
+ --env "GANTRY_NODE_NAME={{.Node.Hostname}}" \
+ shizunge/gantry
+```
+
+Or with docker compose, see the [example](examples/docker-compose.yml).
+
+## Configurations
+
+You can configure the most behaviors of *Gantry* via environment variables.
+
+| Environment Variables | Description | Default value |
+|------------------------|-------------|---------------|
+| GANTRY_CLEANUP_IMAGES_SKIP | Set to a non empty string to skip cleaning up the updated images. Set to an empty string to enable the cleanup. Before cleaning up, *Gantry* will try to remove any *exited* and *dead* containers that are using the images. | |
+| GANTRY_LOG_LEVEL | Control how many logs generated by *Gantry*. Possible values are `NONE`, `ERROR`, `WARN`, `INFO`, `DEBUG` (case sensitive). | INFO |
+| GANTRY_MANIFEST_OPTIONS | Options added to the `docker buildx imagetools inspect` or `docker manifest inspect` command. | |
+| GANTRY_MANIFEST_SKIP_INSPECTION | Set to a non empty string to skip checking manifest of the image. As a result, `docker service update` always runs. In case you add `--force` to `GANTRY_UPDATE_OPTIONS`, you also want to skip the inspection. | |
+| GANTRY_MANIFEST_USE_MANIFEST_CMD | Set to a non empty string to run `docker manifest inspect` instead of `docker buildx imagetools inspect`. `docker manifest inspect` could [fail on some registries](https://github.com/orgs/community/discussions/45779), but it supports authentication. | |
+| GANTRY_NODE_NAME | Add node name to logs. | |
+| GANTRY_NOTIFICATION_APPRISE_URL | Enable notifications on service update with [apprise](https://github.com/djmaze/apprise-microservice). | |
+| GANTRY_NOTIFICATION_TITLE | An additional message added to the notification title. | |
+| GANTRY_REGISTRY_CONFIG | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_CONFIG_FILE | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_CONFIGS_FILE | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_HOST | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_HOST_FILE | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_PASSWORD | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_PASSWORD_FILE | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_USER | See [Authentication](#authentication). | |
+| GANTRY_REGISTRY_USER_FILE | See [Authentication](#authentication). | |
+| GANTRY_ROLLBACK_OPTIONS | Options added to the `docker service update --rollback` command. | |
+| GANTRY_ROLLBACK_SKIP_ON_FAILURE | Set to a non empty string to disable rollback when updating fails. Set to an empty string to enable the rollback. | |
+| GANTRY_SERVICES_EXCLUDED | A space separated list of services names that are excluded from updating. | |
+| GANTRY_SERVICES_EXCLUDED_FILTERS | A space separated list of [filters](https://docs.docker.com/engine/reference/commandline/service_ls/#filter). Exclude services which match the given filters from updating. | |
+| GANTRY_SERVICES_FILTERS | A space separated list of [filters](https://docs.docker.com/engine/reference/commandline/service_ls/#filter) that are accepted by `docker service ls --filter` to select services to update. | |
+| GANTRY_SERVICES_SELF | To indicate whether a service is *Gantry* itself. *Gantry* will be the first service being updated. The manifest inspection will be always performed on the *Gantry* service to avoid an infinity loop of updating itself. | |
+| GANTRY_SLEEP_SECONDS | Sleep time between two updates. Set it to 0 to run *Gantry* once and then exit. | 0 |
+| GANTRY_UPDATE_JOBS | Set to a non empty string to update replicated-job or global-job. Set to an empty string to disable updating jobs. | |
+| GANTRY_UPDATE_OPTIONS | Options added to the `docker service update` command. | |
+| GANTRY_UPDATE_TIMEOUT_SECONDS | Error out if updating of a single service takes longer than the given time. | 300 |
+| TZ | Set timezone for time in logs. | |
+
+## Authentication
+
+If you only need to login to a single registry, you can use the environment variables `GANTRY_REGISTRY_USER`, `GANTRY_REGISTRY_PASSWORD`, `GANTRY_REGISTRY_HOST` and `GANTRY_REGISTRY_CONFIG` to provide the authentication information. You may also use the `*_FILE` variants to pass the information through files. The files can be added to the service via [docker secret](https://docs.docker.com/engine/swarm/secrets/). `GANTRY_REGISTRY_HOST` and `GANTRY_REGISTRY_CONFIG` are optional. Use `GANTRY_REGISTRY_HOST` when you are not using Docker Hub. Use `GANTRY_REGISTRY_CONFIG` when you only want to enable authentication for selected services.
+
+If the images of services are hosted on multiple registries that are required authentication, you should provide a configuration file to the *Gantry* and set `GANTRY_REGISTRY_CONFIGS_FILE` correspondingly. You can use [docker secret](https://docs.docker.com/engine/swarm/secrets/) to provision the configuration file. The configuration file must be in the following format:
+
+* Each line should contain 4 columns, which are either `` or `` separated. The columns are
+ * config name: an identifier for the account. This should be an acceptable [Docker config name](https://docs.docker.com/engine/swarm/configs/).
+ * host: the registry to authenticate against, e.g. docker.io.
+ * user: the user name to authenticate as.
+ * password: the password to authenticate with.
+* Lines starting with `#` are comments.
+* Empty lines, comment lines and invalid lines are ignored.
+
+You need to tell *Gantry* to use a named config rather than the default one when updating a particular service. The named configurations are set via either `GANTRY_REGISTRY_CONFIG`, `GANTRY_REGISTRY_CONFIG_FILE` or `GANTRY_REGISTRY_CONFIGS_FILE`. This can be done by adding the following label to the service `gantry.auth.config=`.
+
+> NOTE: You also want to manually add `--with-registry-auth` to `GANTRY_UPDATE_OPTIONS` and `GANTRY_ROLLBACK_OPTIONS` when you enable authentication.
+
+## FAQ
+
+[FAQ](docs/faq.md)
+
+[Migrate from *Shepherd*](docs/migration.md)
+
+## Contacts
+
+If you have any problems or questions, please contact me through a [GitHub issue](https://github.com/shizunge/gantry/issues).
diff --git a/docs/faq.md b/docs/faq.md
new file mode 100644
index 0000000..33ab28f
--- /dev/null
+++ b/docs/faq.md
@@ -0,0 +1,41 @@
+## FAQ
+
+### How does *Gantry* work?
+
+Fundamentally *Gantry* calls [`docker service update`](https://docs.docker.com/engine/reference/commandline/service_update/) and let docker engine [applies rolling updates to a service](https://docs.docker.com/engine/swarm/swarm-tutorial/rolling-update/).
+
+Before updating a service, *Gantry* will try to obtain the manifest of the image used by the service to decide whether there is a new image.
+
+At the end of updating, *Gantry* optionally removes the old images.
+
+### How to update standalone docker containers?
+
+*Gantry* only works for docker swarm services. If you need to update standalone docker containers, you can try [watchtower](https://github.com/containrrr/watchtower).
+
+### How to filters multiple services by name?
+
+You can set multiple filters. However filters are **ANDED**. So multiple filters on different names will not work.
+
+To filter multiple services, you can set a label on each service then let *Gantry* filter on that label. Or you can run multiple *Gantry* instances.
+
+### How to run *Gantry* on a cron schedule?
+
+You can start *Gantry* as a docker swarm service and use [`swarm-cronjob`](https://github.com/crazy-max/swarm-cronjob) to run it at a given time. When use `swarm-cronjob`, you need to set `GANTRY_SLEEP_SECONDS` to 0. See the [example](examples/docker-compose.yml).
+
+### How to update services with no running tasks?
+
+As discussed [here](https://github.com/docker/cli/issues/627), it will lead the CLI hanging by running `docker service update` on a service with no running tasks. We must add `--detach=true` option to the `docker service update`.
+
+*Gantry* will check if there are running tasks in a services and automatically add the option `--detach=true`. You don't need to add the option manually.
+
+### When to set `GANTRY_MANIFEST_USE_MANIFEST_CMD`?
+
+Before updating a service, *Gantry* will try to obtain the image's meta data to decide whether there is a new image. If there is no new image, *Gantry* skips the updating.
+
+I found `docker manifest inspect` [failed on some registries](https://github.com/orgs/community/discussions/45779), so I use `docker buildx imagetools inspect` to obtain the image digest by default.
+
+You can switch back to use `docker manifest inspect` in case `docker buildx imagetools inspect` does not support some features you need.
+
+### I logged in my Docker Hub account, but the Docker Hub rate reported seems incorrect.
+
+*Gantry* does not yet support to report Docker Hub rate with a user account.
diff --git a/docs/migration.md b/docs/migration.md
new file mode 100644
index 0000000..49ab0f9
--- /dev/null
+++ b/docs/migration.md
@@ -0,0 +1,61 @@
+## Migration from shepherd
+
+*Gantry* is inspired by [*shepherd*](https://github.com/containrrr/shepherd), but rewritten. Although I have tried to keep backward compatibility, not all configurations in *shepherd* are supported.
+
+This guide helps you migrate from *shepherd* to *gantry* by highlighting the difference between them. Please refer to the [README](../README.md) for the full description of the configurations.
+
+### Renamed configurations
+
+| *Shepherd* Env | Equivalent *Gantry* Env |
+|----------------|---------------|
+| HOSTNAME | GANTRY_NODE_NAME |
+| SLEEP_TIME | GANTRY_SLEEP_SECONDS |
+| IGNORELIST_SERVICES | GANTRY_SERVICES_EXCLUDED |
+| FILTER_SERVICES | GANTRY_SERVICES_FILTERS |
+| UPDATE_OPTIONS | GANTRY_UPDATE_OPTIONS |
+| TIMEOUT | GANTRY_UPDATE_TIMEOUT_SECONDS |
+| ROLLBACK_OPTIONS | GANTRY_ROLLBACK_OPTIONS |
+| APPRISE_SIDECAR_URL | GANTRY_NOTIFICATION_APPRISE_URL |
+| REGISTRY_USER | GANTRY_REGISTRY_USER |
+| REGISTRY_PASSWORD | GANTRY_REGISTRY_PASSWORD |
+| REGISTRY_HOST | GANTRY_REGISTRY_HOST |
+| REGISTRIES_FILE | GANTRY_REGISTRY_CONFIGS_FILE |
+
+The label on the services to select config to enable authentication is renamed to `gantry.auth.config`.
+
+### Deprecated configurations
+
+| *Shepherd* Env | Workaround |
+|----------------|------------|
+| VERBOSE | Use `GANTRY_LOG_LEVEL` |
+| WITH_REGISTRY_AUTH | Manually add `--with-registry-auth` to `GANTRY_UPDATE_OPTIONS` and `GANTRY_ROLLBACK_OPTIONS`. |
+| WITH_INSECURE_REGISTRY | Manually add `--insecure` to `GANTRY_MANIFEST_OPTIONS`, `GANTRY_UPDATE_OPTIONS` and `GANTRY_ROLLBACK_OPTIONS`. |
+| WITH_NO_RESOLVE_IMAGE | Manually add `--no-resolve-image` to `GANTRY_UPDATE_OPTIONS` and `GANTRY_ROLLBACK_OPTIONS`. |
+| ROLLBACK_ON_FAILURE | Use `GANTRY_ROLLBACK_SKIP_ON_FAILURE` |
+| IMAGE_AUTOCLEAN_LIMIT | Use `GANTRY_CLEANUP_IMAGES_SKIP` to control the cleanup. *Gantry* will only clean up the updated images. |
+| RUN_ONCE_AND_EXIT | Set `GANTRY_SLEEP_SECONDS` to 0. |
+
+### New configurations
+
+| *Gantry* Env |
+|---------------|
+| GANTRY_CLEANUP_IMAGES_SKIP |
+| GANTRY_LOG_LEVEL |
+| GANTRY_MANIFEST_OPTIONS |
+| GANTRY_MANIFEST_SKIP_INSPECTION |
+| GANTRY_MANIFEST_USE_MANIFEST_CMD |
+| GANTRY_NOTIFICATION_TITLE |
+| GANTRY_REGISTRY_CONFIG |
+| GANTRY_REGISTRY_CONFIG_FILE |
+| GANTRY_REGISTRY_HOST_FILE |
+| GANTRY_REGISTRY_PASSWORD_FILE |
+| GANTRY_REGISTRY_USER_FILE |
+| GANTRY_SERVICES_EXCLUDED_FILTERS |
+| GANTRY_SERVICES_SELF |
+| GANTRY_UPDATE_JOBS |
+
+### License
+
+*Shepherd* is under [MIT license](https://github.com/containrrr/shepherd/blob/master/LICENSE)
+
+*Gantry* is under [GPL-3.0 license](https://github.com/shizunge/gantry/blob/main/LICENSE)
diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml
new file mode 100644
index 0000000..4e52cd7
--- /dev/null
+++ b/examples/docker-compose.yml
@@ -0,0 +1,31 @@
+version: "3.8"
+
+services:
+ gantry:
+ image: shizunge/gantry
+ volumes:
+ - /var/run/docker.sock:/var/run/docker.sock
+ environment:
+ - "GANTRY_NODE_NAME={{.Node.Hostname}}"
+ - "GANTRY_SERVICES_SELF=${STACK}_gantry"
+ - "GANTRY_SLEEP_SECONDS=0"
+ deploy:
+ replicas: 0
+ placement:
+ constraints:
+ - node.role==manager
+ restart_policy:
+ condition: none
+ labels:
+ - swarm.cronjob.enable=true
+ - swarm.cronjob.schedule=45 23 0 * * *
+ - swarm.cronjob.skip-running=true
+
+ cronjob:
+ image: crazymax/swarm-cronjob:latest
+ volumes:
+ - /var/run/docker.sock:/var/run/docker.sock
+ deploy:
+ placement:
+ constraints:
+ - node.role==manager
diff --git a/src/docker_hub_rate.sh b/src/docker_hub_rate.sh
new file mode 100644
index 0000000..cc79e22
--- /dev/null
+++ b/src/docker_hub_rate.sh
@@ -0,0 +1,39 @@
+#!/bin/sh
+# Copyright (C) 2023 Shizun Ge
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+
+docker_hub_rate() {
+ local IMAGE=${1:-ratelimitpreview/test}
+ local RESPONSE=$(wget -qO- "https://auth.docker.io/token?service=registry.docker.io&scope=repository:${IMAGE}:pull")
+ [ $? -ne 0 ] && echo "[GET TOKEN RESPONSE ERROR]" && return 1
+ local TOKEN=$(echo ${RESPONSE} | sed 's/.*"token":"\([^"]*\).*/\1/')
+ [ -z "${TOKEN}" ] && echo "[GET TOKEN ERROR]" && return 1
+ local HEADER="Authorization: Bearer ${TOKEN}"
+ local URL="https://registry-1.docker.io/v2/${IMAGE}/manifests/latest"
+ # adding --spider implies that you want to send a HEAD request (as opposed to GET or POST).
+ RESPONSE=$(wget -qS --spider --header="${HEADER}" -O /dev/null "${URL}" 2>&1)
+ if [ $? -ne 0 ]; then
+ if echo "${RESPONSE}" | grep -q "Too Many Requests" ; then
+ echo "0"
+ return 0
+ fi
+ echo "[GET RATE RESPONSE ERROR]"
+ return 1
+ fi
+ local RATE=$(echo ${RESPONSE} | sed -n 's/.*ratelimit-remaining: \([0-9]*\).*/\1/p' )
+ [ -z "${RATE}" ] && echo "[GET RATE ERROR]" && return 1
+ echo ${RATE}
+}
\ No newline at end of file
diff --git a/src/entrypoint.sh b/src/entrypoint.sh
new file mode 100755
index 0000000..72886c3
--- /dev/null
+++ b/src/entrypoint.sh
@@ -0,0 +1,92 @@
+#!/bin/sh
+# Copyright (C) 2023 Shizun Ge
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+source ./notification.sh
+source ./docker_hub_rate.sh
+source ./lib-common.sh
+source ./lib-gantry.sh
+
+skip_current_node() {
+ local SELF_ID=$(docker node inspect self --format {{.Description.Hostname}} 2>/dev/null);
+ if [ -z "${SELF_ID}" ]; then
+ log WARN "Skip because the current node is not a swarm manager.";
+ return 0
+ fi
+ log INFO "Run on current node ${SELF_ID}.";
+ return 1
+}
+
+gantry() {
+ local STACK=${1:-gantry}
+ local START_TIME=$(date +%s)
+
+ if skip_current_node ; then
+ return 0
+ fi
+ local ACCUMULATED_ERRORS=0
+
+ log INFO "Starting."
+ gantry_initialize "${STACK}"
+ ACCUMULATED_ERRORS=$((ACCUMULATED_ERRORS + $?))
+
+ local DOCKER_HUB_RATE_BEFORE=$(docker_hub_rate)
+ ACCUMULATED_ERRORS=$((ACCUMULATED_ERRORS + $?))
+ log INFO "Before updating, Docker Hub rate remains ${DOCKER_HUB_RATE_BEFORE}."
+
+ log INFO "Starting updating."
+ gantry_update_services_list $(gantry_get_services_list)
+ ACCUMULATED_ERRORS=$((ACCUMULATED_ERRORS + $?))
+
+ local DOCKER_HUB_RATE_AFTER=$(docker_hub_rate)
+ ACCUMULATED_ERRORS=$((ACCUMULATED_ERRORS + $?))
+ local DOCKER_HUB_RATE_USED=$(difference_between "${DOCKER_HUB_RATE_BEFORE}" "${DOCKER_HUB_RATE_AFTER}")
+ log INFO "After updating, Docker Hub rate remains ${DOCKER_HUB_RATE_AFTER}. Used rate ${DOCKER_HUB_RATE_USED}."
+
+ gantry_finalize "${STACK}";
+ ACCUMULATED_ERRORS=$((ACCUMULATED_ERRORS + $?))
+
+ local TIME_ELAPSED=$(time_elapsed_since ${START_TIME})
+ local MESSAGE="Done. Use ${TIME_ELAPSED}. ${ACCUMULATED_ERRORS} errors."
+ if [ ${ACCUMULATED_ERRORS} -gt 0 ]; then
+ log WARN ${MESSAGE}
+ else
+ log INFO ${MESSAGE}
+ fi
+ return ${ACCUMULATED_ERRORS}
+}
+
+main() {
+ LOG_LEVEL=${GANTRY_LOG_LEVEL:-${LOG_LEVEL}}
+ NODE_NAME=${GANTRY_NODE_NAME:-${NODE_NAME}}
+ local SLEEP_SECONDS=${GANTRY_SLEEP_SECONDS:-0}
+ if ! is_number "${SLEEP_SECONDS}"; then
+ log ERROR "GANTRY_SLEEP_SECONDS must be a number. Got \"${GANTRY_SLEEP_SECONDS}\"."
+ return 1;
+ fi
+ local STACK=${1:-gantry}
+ local RETURN_VALUE=0
+ while true; do
+ LOG_SCOPE=${STACK}
+ gantry ${@}
+ RETURN_VALUE=$?
+ [ "${SLEEP_SECONDS}" -le 0 ] && break;
+ log INFO "Sleeping ${SLEEP_SECONDS} seconds before next update."
+ sleep ${SLEEP_SECONDS}
+ done
+ return ${RETURN_VALUE}
+}
+
+main ${@}
diff --git a/src/lib-common.sh b/src/lib-common.sh
new file mode 100755
index 0000000..067e190
--- /dev/null
+++ b/src/lib-common.sh
@@ -0,0 +1,345 @@
+#!/bin/sh
+# Copyright (C) 2023 Shizun Ge
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+
+# echo the number of the log level.
+# return 0 if LEVEL is supported.
+# return 1 if LEVLE is unsupported.
+log_level() {
+ local LEVEL=${1};
+ [ -z "${LEVEL}" ] && echo $(log_level "INFO") && return 1;
+ [ "${LEVEL}" = "DEBUG" ] && echo 0 && return 0;
+ [ "${LEVEL}" = "INFO" ] && echo 1 && return 0;
+ [ "${LEVEL}" = "WARN" ] && echo 2 && return 0;
+ [ "${LEVEL}" = "ERROR" ] && echo 3 && return 0;
+ [ "${LEVEL}" = "NONE" ] && echo 4 && return 0;
+ echo $(log_level "NONE");
+ return 1;
+}
+
+log_formatter() {
+ local LOG_LEVEL=${LOG_LEVEL}
+ local LEVEL=${1}; shift;
+ [ $(log_level ${LEVEL}) -lt $(log_level ${LOG_LEVEL}) ] && return 0;
+ local TIME=${1}; shift;
+ local LOCATION=${1}; shift;
+ local SCOPE=${1}; shift;
+ local LOCATION_STR=$(if [ -n "${LOCATION}" ]; then echo "[${LOCATION}]"; else echo ""; fi);
+ local SCOPE_STR=$(if [ -n "${SCOPE}" ]; then echo "${SCOPE}: "; else echo ""; fi);
+ local MESSAGE="[${TIME}]${LOCATION_STR}[${LEVEL}] ${SCOPE_STR}$@";
+ if [ "${LEVEL}" = "ERROR" ]; then
+ echo "${MESSAGE}" >&2;
+ else
+ echo "${MESSAGE}";
+ fi;
+}
+
+# We want to print an empty line for log without an argument. Thus we do not run the following check.
+# [ -z "${1}" ] && return 0
+log() {
+ local NODE_NAME=${NODE_NAME}
+ local LEVEL="INFO";
+ if log_level "${1}" >/dev/null; then
+ LEVEL="${1}";
+ shift;
+ fi;
+ log_formatter "${LEVEL}" "$(date -Iseconds)" "${NODE_NAME}" "${LOG_SCOPE}" "${@}";
+}
+
+# docker service logs --timestamps --no-task-ids
+# 2023-06-22T01:20:54.535860111Z @ |
+log_docker_line() {
+ local LEVEL="INFO";
+ local TIME_SEC=$(echo ${@} | cut -d ' ' -f 1 | cut -d '.' -f 1);
+ # To match the timezone in $(date -Iseconds) (ISO-8601)
+ # busybox date does not support +%:z which outputs "-07:00". %z outputs "-0700".
+ local TIMEZONE=$(date +%z);
+ local TZH=${TIMEZONE%??};
+ local TZM=${TIMEZONE#"${TZH}"};
+ local TIME="${TIME_SEC}${TZH}:${TZM}"
+ local SCOPE=$(echo ${@} | cut -d ' ' -f 2 | cut -d '@' -f 1);
+ local NODE=$(echo ${@} | cut -d ' ' -f 2 | cut -d '@' -f 2);
+ local MESSAGE=$(echo $(echo ${@} | cut -d '|' -f 2-));
+ local FIRST_WORD=$(echo "${MESSAGE}" | cut -d ' ' -f 1);
+ if log_level "${FIRST_WORD}" >/dev/null; then
+ LEVEL=${FIRST_WORD};
+ MESSAGE=$(echo "${MESSAGE}" | cut -d ' ' -f 2-);
+ fi
+ log_formatter "${LEVEL}" "${TIME}" "${NODE}" "${SCOPE}" "${MESSAGE}";
+}
+
+# Usage: echo "${LOGS}" | log_lines INFO
+log_lines() {
+ local LEVEL=${1};
+ while read -r LINE; do
+ [ -z "${LINE}" ] && continue;
+ log ${LEVEL} ${LINE};
+ done
+}
+
+is_number() {
+ [ "${1}" -eq "${1}" ] 2>/dev/null;
+}
+
+difference_between() {
+ local NUM0=${1}
+ local NUM1=${2}
+ if is_number "${NUM0}" && is_number "${NUM1}"; then
+ if [ ${NUM0} -gt ${NUM1} ]; then
+ echo "$((NUM0 - NUM1))"
+ else
+ echo "$((NUM1 - NUM0))"
+ fi
+ return 0
+ fi
+ echo "NaN"
+ return 1
+}
+
+time_elapsed_between() {
+ local TIME0=${1}
+ local TIME1=${2}
+ local SECONDS_ELAPSED=
+ if ! SECONDS_ELAPSED=$(difference_between "${TIME0}" "${TIME1}"); then
+ echo "NaN"
+ return 1
+ fi
+ local TIME_ELAPSED=$(date -u -d @${SECONDS_ELAPSED} +'%-Mm %-Ss')
+ echo "${TIME_ELAPSED}"
+}
+
+time_elapsed_since() {
+ local START_TIME=${1}
+ time_elapsed_between "$(date +%s)" "${START_TIME}"
+}
+
+# For a givne variable name , try to read content of _FILE if file exists.
+# otherwise echo the content of .
+read_config() {
+ local CONFIG_NAME=${1}
+ [ -z "${CONFIG_NAME}" ] && return 1
+ local CONFIG_FILE_NAME="${CONFIG_NAME}_FILE"
+ eval "local CONFIG_FILE=\${${CONFIG_FILE_NAME}}"
+ if [ -r "${CONFIG_FILE}" ]; then
+ cat ${CONFIG_FILE}
+ return $?
+ elif [ -n "${CONFIG_FILE}" ]; then
+ echo "Failed to read ${CONFIG_FILE}" >&2
+ return 1
+ fi
+ eval "local CONFIG=\${${CONFIG_NAME}}"
+ echo ${CONFIG}
+}
+
+swarm_network_arguments() {
+ if [ -z "${NETWORK_NAME}" ]; then
+ echo ""
+ return 0
+ fi
+ NETWORK_NAME=$(docker network ls --filter name=${NETWORK_NAME} --format {{.Name}})
+ if [ -z "${NETWORK_NAME}" ]; then
+ echo ""
+ return 0
+ fi
+ local NETWORK_ARG="--network=${NETWORK_NAME}"
+ if [ -z "${NETWORK_DNS_IP}" ]; then
+ echo "${NETWORK_ARG}"
+ return 0
+ fi
+ echo "${NETWORK_ARG} --dns=${NETWORK_DNS_IP}"
+}
+
+get_docker_command_name_arg() {
+ # get from "--name " or "--name="
+ echo ${@} | sed -E 's/.*-name[ =]([^ ]*).*/\1/'
+}
+
+get_docker_command_detach() {
+ if echo "${@}" | grep -q -- "--detach"; then
+ echo "true"
+ return 0
+ fi
+ echo "false"
+}
+
+docker_service_logs () {
+ local SERVICE_NAME=${1}
+ local LOGS=$(docker service logs --timestamps --no-task-ids ${SERVICE_NAME} 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to obtain logs of service ${SERVICE_NAME}. $(echo ${LOGS})"
+ return 1
+ fi
+ echo "${LOGS}" |
+ while read -r LINE; do
+ log_docker_line ${LINE}
+ done
+}
+
+docker_service_logs_follow() {
+ local SERVICE_NAME=${1}
+ docker service logs --timestamps --no-task-ids --follow ${SERVICE_NAME} 2>&1 |
+ while read -r LINE; do
+ log_docker_line ${LINE}
+ done
+}
+
+docker_service_task_states() {
+ local SERVICE_NAME=${1}
+ # We won't get the return value of the command via $? if we use "local STATES=$(command)".
+ local STATES=
+ STATES=$(docker service ps --no-trunc --format "[{{.Name}}][{{.Node}}] {{.CurrentState}} {{.Error}}" ${SERVICE_NAME} 2>&1)
+ if [ $? -ne 0 ]; then
+ echo "${STATES}" >&2
+ return 1
+ fi
+ echo "${STATES}" | while read -r LINE; do
+ local NAME=$(echo ${LINE} | cut -d ']' -f 1 | cut -d '[' -f 2)
+ local NODE_STATE_AND_ERROR=$(echo ${LINE} | cut -d ']' -f 2-)
+ # We assume that the first State of each task is the latest one that we want to report.
+ if ! $(echo "${NAME_LIST}" | grep -q "${NAME}"); then
+ echo "${NODE_STATE_AND_ERROR}"
+ fi
+ local NAME_LIST=$(echo -e "${NAME_LIST}\n${NAME}" | sort | uniq)
+ done
+}
+
+wait_service_state() {
+ local SERVICE_NAME=${1}
+ local WAIT_RUNNING=${2:-"false"}
+ local WAIT_COMPLETE=${3:-"false"}
+ local RETURN_VALUE=${4:-0}
+ local SLEEP_SECONDS=${5:-1}
+ local STATES=$(docker_service_task_states ${SERVICE_NAME} 2>&1)
+ while ${WAIT_RUNNING} || ${WAIT_COMPLETE} ; do
+ local NUM_LINES=0
+ local NUM_RUNS=0
+ local NUM_DONES=0
+ local NUM_FAILS=0
+ while read -r LINE; do
+ [ -z "${LINE}" ] && continue;
+ NUM_LINES=$((NUM_LINES+1))
+ echo "${LINE}" | grep -q "Running" && NUM_RUNS=$((NUM_RUNS+1))
+ echo "${LINE}" | grep -q "Complete" && NUM_DONES=$((NUM_DONES+1))
+ echo "${LINE}" | grep -q "Failed" && NUM_FAILS=$((NUM_FAILS+1))
+ done < <(echo "${STATES}")
+ if [ ${NUM_LINES} -gt 0 ]; then
+ if ${WAIT_RUNNING} && [ ${NUM_RUNS} -eq ${NUM_LINES} ]; then
+ break
+ fi
+ if ${WAIT_COMPLETE} && [ ${NUM_DONES} -eq ${NUM_LINES} ]; then
+ break
+ fi
+ if ${WAIT_COMPLETE} && [ ${NUM_FAILS} -gt 0 ]; then
+ # Get return value of the task from the string "task: non-zero exit (1)".
+ local TASK_STATE=$(echo "${STATES}" | grep "Failed")
+ local TASK_RETURN_VALUE=$(echo "${TASK_STATE}" | sed -n 's/.*task: non-zero exit (\([0-9]\+\)).*/\1/p')
+ # Get the first error code.
+ RETURN_VALUE=$(echo ${TASK_RETURN_VALUE:-1} | cut -d ' ' -f 1)
+ break
+ fi
+ fi
+ sleep ${SLEEP_SECONDS}
+ STATES=$(docker_service_task_states ${SERVICE_NAME} 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to obtain task states of service ${SERVICE_NAME}: $(echo ${STATES})"
+ return 1
+ fi
+ done
+ echo "${STATES}" | while read -r LINE; do
+ log INFO "Service ${SERVICE_NAME}: $(echo ${LINE})."
+ done
+ return ${RETURN_VALUE}
+}
+
+docker_service_remove() {
+ local SERVICE_NAME=${1}
+ if ! docker service inspect --format {{.JobStatus}} ${SERVICE_NAME} >/dev/null 2>&1; then
+ return 0
+ fi
+ log INFO "Removing service ${SERVICE_NAME}."
+ docker service rm ${SERVICE_NAME} >/dev/null
+ local RETURN_VALUE=$?
+ log INFO "Removed service ${SERVICE_NAME}."
+ return ${RETURN_VALUE}
+}
+
+# We do not expect failures when using docker_global_job.
+# Docker will try to restart the failed tasks.
+# We do not check the converge of the service. It must be used togther with wait_service_state.
+docker_global_job() {
+ local SERVICE_NAME=$(get_docker_command_name_arg ${@})
+ local IS_DETACH=$(get_docker_command_detach ${@})
+ local WAIT_RUNNING=${IS_DETACH}
+ local WAIT_COMPLETE="false"
+ log INFO "Starting service ${SERVICE_NAME}."
+ docker service create \
+ --mode global-job \
+ "${@}" >/dev/null
+ local RETURN_VALUE=$?
+ return ${RETURN_VALUE}
+}
+
+# A job could fail when using docker_replicated_job.
+docker_replicated_job() {
+ local SERVICE_NAME=$(get_docker_command_name_arg ${@})
+ local IS_DETACH=$(get_docker_command_detach ${@})
+ # Add "--detach" to work around https://github.com/docker/cli/issues/2979
+ # The Docker CLI does not exit on failures.
+ local WAIT_RUNNING="false"
+ local WAIT_COMPLETE=$(if ${IS_DETACH}; then echo "false"; else echo "true"; fi)
+ log INFO "Starting service ${SERVICE_NAME}."
+ docker service create \
+ --mode replicated-job --detach \
+ "${@}" >/dev/null
+ local RETURN_VALUE=$?
+ # return the code from wait_service_state
+ wait_service_state ${SERVICE_NAME} ${WAIT_RUNNING} ${WAIT_COMPLETE} ${RETURN_VALUE}
+}
+
+container_status() {
+ local CNAME=${1}
+ docker container inspect --format '{{.State.Status}}' ${CNAME} 2>/dev/null
+}
+
+docker_remove() {
+ local CNAME=${1}
+ local STATUS=$(container_status ${CNAME})
+ if [ -z "${STATUS}" ]; then
+ return 0
+ fi
+ log INFO "Removing container ${CNAME}."
+ if [ "${STATUS}" = "running" ]; then
+ docker stop ${CNAME} >/dev/null 2>/dev/null
+ fi
+ docker rm ${CNAME} >/dev/null
+}
+
+docker_run() {
+ local RETRIES=0
+ local MAX_RETRIES=5
+ local SLEEP_SECONDS=10
+ while ! docker run \
+ "${@}" >/dev/null;
+ do
+ if [ ${RETRIES} -ge ${MAX_RETRIES} ]; then
+ echo "Failed to run docker. Reached the max retries ${MAX_RETRIES}." >&2
+ return 1
+ fi
+ RETRIES=$((RETRIES + 1))
+ sleep ${SLEEP_SECONDS}
+ echo "Retry docker run (${RETRIES})."
+ done
+}
diff --git a/src/lib-gantry.sh b/src/lib-gantry.sh
new file mode 100755
index 0000000..29c897b
--- /dev/null
+++ b/src/lib-gantry.sh
@@ -0,0 +1,477 @@
+#!/bin/sh
+# Copyright (C) 2023 Shizun Ge
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+
+login_registry() {
+ local USER=${1}
+ local PASSWORD=${2}
+ local HOST=${3}
+ local CONFIG=${4}
+ [ -z "${USER}" ] && log ERROR "USER is empty." && return 1
+ [ -z "${PASSWORD}" ] && log ERROR "PASSWORD is empty." && return 1
+ local DOCKER_CONFIG=
+ local CONFIG_MESSAGE=" ${HOST}"
+ if [ -z "${HOST}" ]; then
+ log WARN "HOST is empty. Will login to the default registry."
+ CONFIG_MESSAGE=""
+ fi
+ if [ -n "${CONFIG}" ]; then
+ DOCKER_CONFIG="--config ${CONFIG}"
+ CONFIG_MESSAGE="${CONFIG_MESSAGE} for config ${CONFIG}"
+ fi
+ local LOGIN_MSG
+ LOGIN_MSG=$(echo "${PASSWORD}" | docker ${DOCKER_CONFIG} login --username="${USER}" --password-stdin "${HOST}" 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to login to registry${CONFIG_MESSAGE}. $(echo ${LOGIN_MSG})"
+ else
+ log INFO "Logged into registry${CONFIG_MESSAGE}. $(echo ${LOGIN_MSG})"
+ fi
+}
+
+authenticate_to_registries() {
+ local CONFIG=
+ local CONFIGS_FILE=${GANTRY_REGISTRY_CONFIGS_FILE}
+ local HOST=
+ local PASSWORD=
+ local USER=
+ CONFIG=$(read_config GANTRY_REGISTRY_CONFIG 2>&1)
+ [ $? -ne 0 ] && log ERROR "Failed to set CONFIG: ${CONFIG}" && return 1
+ HOST=$(read_config GANTRY_REGISTRY_HOST 2>&1)
+ [ $? -ne 0 ] && log ERROR "Failed to set HOST: ${HOST}" && return 1
+ PASSWORD=$(read_config GANTRY_REGISTRY_PASSWORD 2>&1)
+ [ $? -ne 0 ] && log ERROR "Failed to set PASSWORD: ${PASSWORD}" && return 1
+ USER=$(read_config GANTRY_REGISTRY_USER 2>&1)
+ [ $? -ne 0 ] && log ERROR "Failed to set USER: ${USER}" && return 1
+ if [ -n "${USER}" ]; then
+ login_registry "${USER}" "${PASSWORD}" "${HOST}" "${CONFIG}"
+ fi
+ [ -z "${CONFIGS_FILE}" ] && return 0
+ [ ! -r "${CONFIGS_FILE}" ] && log ERROR "Failed to read ${CONFIGS_FILE}." && return 1
+ local LINE=
+ while read -r LINE; do
+ LINE=$(echo ${LINE})
+ # skip comments
+ [ -z "${LINE}" ] && continue
+ [ "${LINE:0:1}" = "#" ] && continue
+ LINE=$(echo ${LINE} | tr '\t' ' ')
+ local CONFIG=$(echo ${LINE} | cut -d ' ' -f 1)
+ local HOST=$(echo ${LINE} | cut -d ' ' -f 2)
+ local USER=$(echo ${LINE} | cut -d ' ' -f 3)
+ local PASSWORD=$(echo ${LINE} | cut -d ' ' -f 4)
+ local OTHERS=$(echo ${LINE} | cut -d ' ' -f 5-)
+ if [ -n "${OTHERS}" ] || [ -z "${CONFIG}" ] || \
+ [ -z "${HOST}" ] || [ -z "${USER}" ] || [ -z "${PASSWORD}" ]; then
+ log ERROR "${CONFIGS_FILE} format error. A line should contains only \" \". Got \"${LINE}\"."
+ continue
+ fi
+ login_registry "${USER}" "${PASSWORD}" "${HOST}" "${CONFIG}"
+ done <"${CONFIGS_FILE}"
+}
+
+send_notification() {
+ local TITLE="${1}"
+ local BODY="${2}"
+ if ! type notify_summary >/dev/null 2>&1; then
+ return 0
+ fi
+ notify_summary "${TITLE}" "${BODY}"
+}
+
+add_image_to_remove() {
+ local IMAGE=${1}
+ if [ -z "${GLOBAL_IMAGES_TO_REMOVE}" ]; then
+ GLOBAL_IMAGES_TO_REMOVE=${IMAGE}
+ return 0
+ fi
+ GLOBAL_IMAGES_TO_REMOVE=$(echo -e "${GLOBAL_IMAGES_TO_REMOVE}\n${IMAGE}" | sort | uniq)
+}
+
+remove_images() {
+ local SKIP_CLEANUP_IMAGES=${GANTRY_CLEANUP_IMAGES_SKIP}
+ if [ -n "${SKIP_CLEANUP_IMAGES}" ]; then
+ log INFO "Skip removing images."
+ return 0
+ fi
+ local SERVICE_NAME=${1:-"docker-image-remover"}
+ docker_service_remove ${SERVICE_NAME}
+ if [ -z "${GLOBAL_IMAGES_TO_REMOVE}" ]; then
+ log INFO "No images to remove."
+ return 0
+ fi
+ log INFO "Try to remove the following images:"
+ for I in $(echo ${GLOBAL_IMAGES_TO_REMOVE} | tr '\n' ' '); do
+ log INFO "- ${I}"
+ done
+ docker_global_job --name ${SERVICE_NAME} \
+ --restart-condition on-failure \
+ --restart-max-attempts 1 \
+ --mount type=bind,source=/var/run/docker.sock,destination=/var/run/docker.sock \
+ --env "IMAGES_TO_REMOVE=$(echo "${GLOBAL_IMAGES_TO_REMOVE}" | tr '\n' ' ')" \
+ --entrypoint sh \
+ alpinelinux/docker-cli \
+ -c "
+ log() {
+ echo \"\${@}\";
+ };
+ remove_container() {
+ local IMAGE=\${1};
+ local STATUS=\${2};
+ if ! CIDS=\$(docker container ls --all --filter ancestor=\${IMAGE} --filter status=\${STATUS} --format {{.ID}} 2>&1); then
+ log ERROR \"Failed to list \${STATUS} containers with image \${IMAGE}. \$(echo \${CIDS})\";
+ return 1;
+ fi;
+ for CID in \${CIDS}; do
+ CNAME=\$(docker container inspect --format {{.Name}} \${CID});
+ if ! CRM_MSG=\$(docker container rm \${CID} 2>&1); then
+ log ERROR \"Failed to remove \${STATUS} container \${CNAME}, which is using image \${IMAGE}. \$(echo \${CRM_MSG})\";
+ continue;
+ fi
+ log INFO \"Removed \${STATUS} container \${CNAME}. It was using image \${IMAGE}.\";
+ done;
+ };
+ for IMAGE in \${IMAGES_TO_REMOVE}; do
+ if ! docker image inspect \${IMAGE} 1>/dev/null 2>&1 ; then
+ log DEBUG \"There is no image \${IMAGE} on the node.\";
+ continue;
+ fi;
+ remove_container \${IMAGE} exited;
+ remove_container \${IMAGE} dead;
+ if ! RMI_MSG=\$(docker rmi \${IMAGE} 2>&1); then
+ log ERROR \"Failed to remove image \${IMAGE}. \$(echo \${RMI_MSG})\";
+ continue;
+ fi;
+ log INFO \"Removed image \${IMAGE}.\";
+ done;
+ log INFO \"Done.\";
+ "
+ wait_service_state ${SERVICE_NAME} "false" "true";
+ docker_service_logs ${SERVICE_NAME}
+ docker_service_remove ${SERVICE_NAME}
+}
+
+add_service_updated() {
+ local SERVICE_NAME=${1}
+ if [ -z "${GLOBAL_SERVICES_UPDATED}" ]; then
+ GLOBAL_SERVICES_UPDATED=${SERVICE_NAME}
+ return 0
+ fi
+ GLOBAL_SERVICES_UPDATED=$(echo -e "${GLOBAL_SERVICES_UPDATED}\n${SERVICE_NAME}" | sort | uniq)
+}
+
+report_services_updated() {
+ if [ -z "${GLOBAL_SERVICES_UPDATED}" ]; then
+ echo "No services updated."
+ return 0
+ fi
+ echo "Services updated:"
+ for S in ${GLOBAL_SERVICES_UPDATED}; do
+ echo "- ${S}"
+ done
+}
+
+add_service_update_failed() {
+ local SERVICE_NAME=${1}
+ if [ -z "${GLOBAL_SERVICES_UPDATE_FAILED}" ]; then
+ GLOBAL_SERVICES_UPDATE_FAILED=${SERVICE_NAME}
+ return 0
+ fi
+ GLOBAL_SERVICES_UPDATE_FAILED=$(echo -e "${GLOBAL_SERVICES_UPDATE_FAILED}\n${SERVICE_NAME}" | sort | uniq)
+}
+
+report_services_update_failed() {
+ if [ -z "${GLOBAL_SERVICES_UPDATE_FAILED}" ]; then
+ return 0
+ fi
+ echo "Services update failed:"
+ for S in ${GLOBAL_SERVICES_UPDATE_FAILED}; do
+ echo "- ${S}"
+ done
+}
+
+get_number_of_elements() {
+ local LIST=${@}
+ [ -z "${LIST}" ] && echo 0 && return 0
+ set ${LIST}
+ local NUM=$#
+ echo ${NUM}
+}
+
+report_services() {
+ local UPDATED_MSG=$(report_services_updated)
+ echo "${UPDATED_MSG}" | log_lines INFO
+ local FAILED_MSG=$(report_services_update_failed)
+ echo "${FAILED_MSG}" | log_lines INFO
+ # Send notification
+ local UPDATED_NUM=$(get_number_of_elements ${GLOBAL_SERVICES_UPDATED})
+ local FAILED_NUM=$(get_number_of_elements ${GLOBAL_SERVICES_UPDATE_FAILED})
+ local TITLE="[gantry] ${UPDATED_NUM} services updated ${FAILED_NUM} failed"
+ local BODY=$(echo -e "${UPDATED_MSG}\n${FAILED_MSG}")
+ send_notification "${TITLE}" "${BODY}"
+}
+
+in_list() {
+ local LIST="${1}"
+ local SEARCHED_ITEM="${2}"
+ for ITEM in ${LIST}; do
+ if [ "${ITEM}" = "${SEARCHED_ITEM}" ]; then
+ return 0
+ fi
+ done
+ return 1
+}
+
+# echo the mode when the service is replicated job or global job
+# return whether a service is replicated job or global job
+service_is_job() {
+ local SERVICE_NAME=${1}
+ local MODE=
+ MODE=$(docker service ls --filter name=${SERVICE_NAME} --format {{.Mode}} 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to obtain the mode of the service ${SERVICE_NAME}: $(echo ${MODE})"
+ return 1
+ fi
+ # Looking for replicated-job or global-job
+ echo ${MODE} | grep "job"
+}
+
+get_image_info() {
+ local USE_MANIFEST_CMD=${GANTRY_MANIFEST_USE_MANIFEST_CMD}
+ local MANIFEST_OPTIONS=${GANTRY_MANIFEST_OPTIONS}
+ local IMAGE=${1}
+ local DOCKER_CONFIG=${2}
+ if [ -z "${USE_MANIFEST_CMD}" ]; then
+ # https://github.com/orgs/community/discussions/45779
+ docker ${DOCKER_CONFIG} buildx imagetools inspect ${MANIFEST_OPTIONS} ${IMAGE}
+ return $?
+ fi
+ docker ${DOCKER_CONFIG} manifest inspect ${MANIFEST_OPTIONS} ${IMAGE}
+}
+
+# echo a non empty message if we found no new images.
+# echo nothing if we found a new image.
+# return the number of errors.
+inspect_image() {
+ local SELF=${GANTRY_SERVICES_SELF}
+ local SKIP_MANIFEST_INSPECTION=${GANTRY_MANIFEST_SKIP_INSPECTION}
+ local SERVICE_NAME=${1}
+ local IMAGE=${2}
+ local DIGEST=${3}
+ local DOCKER_CONFIG=${4}
+ # never skip inspection on self
+ if [ -n "${SKIP_MANIFEST_INSPECTION}" ] && [ "${SERVICE_NAME}" != "${SELF}" ]; then
+ return 0
+ fi
+ if in_list "${GLOBAL_NO_NEW_IMAGES}" "${DIGEST}"; then
+ echo "No new images."
+ return 0
+ fi
+ local IMAGE_INFO=
+ if ! IMAGE_INFO=$(get_image_info "${IMAGE}" "${DOCKER_CONFIG}" 2>&1); then
+ echo "Image ${IMAGE} does not exist or it is not available. $(echo ${IMAGE_INFO})" >&2
+ return 1
+ fi
+ if [ -n "${DIGEST}" ] && echo "${IMAGE_INFO}" | grep -q "${DIGEST}"; then
+ echo "No new images."
+ GLOBAL_NO_NEW_IMAGES=$(echo -e "${GLOBAL_NO_NEW_IMAGES}\n${DIGEST}" | sort | uniq)
+ return 0
+ fi
+ return 0
+}
+
+get_number_of_running_tasks() {
+ local SERVICE_NAME=${1}
+ local REPLICAS=
+ REPLICAS=$(docker service ls --filter name=${SERVICE_NAME} --format {{.Replicas}} 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to obtain task states of service ${SERVICE_NAME}: $(echo ${REPLICAS})"
+ return 1
+ fi
+ # https://docs.docker.com/engine/reference/commandline/service_ls/#examples
+ # The REPLICAS is like "5/5" or "1/1 (3/5 completed)"
+ # Get the number before the first "/".
+ local NUM_RUNS=$(echo ${REPLICAS} | cut -d '/' -f 1)
+ echo ${NUM_RUNS}
+}
+
+get_service_update_additional_option() {
+ local SERVICE_NAME=${1}
+ local OPTION="--detach=true"
+ local NUM_RUNS=
+ NUM_RUNS=$(get_number_of_running_tasks ${SERVICE_NAME})
+ [ -z "${NUM_RUNS}" ] && return 1
+ if [ ${NUM_RUNS} -eq 0 ]; then
+ # Add "--detach=true" when there is no running tasks.
+ # https://github.com/docker/cli/issues/627
+ echo -n "${OPTION}"
+ fi
+}
+
+rollback_service() {
+ local ROLLBACK_SKIP_ON_FAILURE=${GANTRY_ROLLBACK_SKIP_ON_FAILURE}
+ local ROLLBACK_OPTIONS=${GANTRY_ROLLBACK_OPTIONS}
+ local SERVICE_NAME=${1}
+ local DOCKER_CONFIG=${2}
+ if [ -n "${ROLLBACK_SKIP_ON_FAILURE}" ]; then
+ return 0
+ fi
+ log INFO "Rolling ${SERVICE_NAME} back."
+ local ROLLBACK_MSG=
+ ROLLBACK_MSG=$(docker ${DOCKER_CONFIG} service update ${ROLLBACK_OPTIONS} --rollback "${SERVICE_NAME}" 2>&1)
+ local RETURN_VALUE=$?
+ if [ ${RETURN_VALUE} -ne 0 ]; then
+ log ERROR "Failed to roll back ${SERVICE_NAME}. $(echo ${ROLLBACK_MSG})"
+ fi
+ return ${RETURN_VALUE}
+}
+
+update_single_service() {
+ local UPDATE_JOBS=${GANTRY_UPDATE_JOBS}
+ local UPDATE_TIMEOUT_SECONDS=${GANTRY_UPDATE_TIMEOUT_SECONDS:-300}
+ local UPDATE_OPTIONS=${GANTRY_UPDATE_OPTIONS}
+ if ! is_number "${UPDATE_TIMEOUT_SECONDS}"; then
+ log ERROR "GANTRY_UPDATE_TIMEOUT_SECONDS must be a number. Got \"${GANTRY_UPDATE_TIMEOUT_SECONDS}\"."
+ return 1;
+ fi
+ local SERVICE_NAME=${1}
+ local MODE=
+ if [ -z "${UPDATE_JOBS}" ] && MODE=$(service_is_job ${SERVICE_NAME}); then
+ log DEBUG "Skip updating service ${SERVICE_NAME} that is a ${MODE}."
+ return 0;
+ fi
+ local AUTH_CONFIG_LABEL="gantry.auth.config"
+ local AUTH_CONFIG=$(docker service inspect -f '{{index .Spec.Labels "${AUTH_CONFIG_LABEL}"}}' "${SERVICE_NAME}" 2>&1)
+ if [ $? -ne 0 ]; then
+ LOG ERROR "Failed to obtain authentication config from service ${SERVICE_NAME}. $(echo ${AUTH_CONFIG})"
+ AUTH_CONFIG=
+ fi
+ [ -n "${AUTH_CONFIG}" ] && local DOCKER_CONFIG="--config ${AUTH_CONFIG}"
+ local IMAGE_WITH_DIGEST=
+ IMAGE_WITH_DIGEST=$(docker service inspect -f '{{.Spec.TaskTemplate.ContainerSpec.Image}}' "${SERVICE_NAME}" 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to obtain image from service ${SERVICE_NAME}. $(echo ${IMAGE_WITH_DIGEST})"
+ return 1
+ fi
+ local IMAGE=$(echo "${IMAGE_WITH_DIGEST}" | cut -d@ -f1)
+ local DIGEST=$(echo "${IMAGE_WITH_DIGEST}" | cut -d@ -f2)
+ local MANIFEST_MSG=
+ MANIFEST_MSG=$(inspect_image "${SERVICE_NAME}" "${IMAGE}" "${DIGEST}" "${DOCKER_CONFIG}" 2>&1)
+ local RETURN_VALUE=$?
+ if [ ${RETURN_VALUE} -ne 0 ]; then
+ log ERROR "${MANIFEST_MSG}"
+ return ${RETURN_VALUE}
+ fi
+ if [ -n "${MANIFEST_MSG}" ]; then
+ log INFO "${MANIFEST_MSG}"
+ return 0
+ fi
+ log INFO "Updating with image ${IMAGE}"
+ local ADDITIONAL_OPTION=$(get_service_update_additional_option ${SERVICE_NAME})
+ [ -n "${ADDITIONAL_OPTION}" ] && log DEBUG "Add option \"${ADDITIONAL_OPTION}\" to the docker service update command."
+ if ! UPDATE_MSG=$(timeout "${UPDATE_TIMEOUT_SECONDS}" docker ${DOCKER_CONFIG} service update ${ADDITIONAL_OPTION} ${UPDATE_OPTIONS} --image="${IMAGE}" "${SERVICE_NAME}" 2>&1); then
+ log ERROR "docker service update failed or timeout. $(echo ${UPDATE_MSG})"
+ rollback_service "${SERVICE_NAME}" "${DOCKER_CONFIG}"
+ add_servicess_update_failed ${SERVICE_NAME}
+ return 1
+ fi
+ local PREVIOUS_IMAGE=$(docker service inspect -f '{{.PreviousSpec.TaskTemplate.ContainerSpec.Image}}' "${SERVICE_NAME}")
+ local CURRENT_IMAGE=$(docker service inspect -f '{{.Spec.TaskTemplate.ContainerSpec.Image}}' "${SERVICE_NAME}")
+ if [ "${PREVIOUS_IMAGE}" = "${CURRENT_IMAGE}" ]; then
+ log INFO "No updates."
+ return 0
+ fi
+ add_service_updated ${SERVICE_NAME}
+ add_image_to_remove ${PREVIOUS_IMAGE}
+ log INFO "UPDATED."
+ return 0
+}
+
+get_services_filted() {
+ local SERVICES_FILTERS=${1}
+ local SERVICES=
+ local FILTERS=
+ for F in ${SERVICES_FILTERS}; do
+ FILTERS="${FILTERS} --filter ${F}"
+ done
+ SERVICES=$(docker service ls --quiet ${FILTERS} --format '{{.Name}}' 2>&1)
+ if [ $? -ne 0 ]; then
+ log ERROR "Failed to obtain services list with \"${FILTERS}\"."
+ return 1
+ fi
+ echo -e "${SERVICES}"
+ return 0
+}
+
+gantry_initialize() {
+ local STACK=${1:-gantry}
+ GLOBAL_IMAGES_TO_REMOVE=
+ GLOBAL_SERVICES_UPDATED=
+ GLOBAL_SERVICES_UPDATE_FAILED=
+ GLOBAL_NO_NEW_IMAGES=
+ authenticate_to_registries
+}
+
+gantry_get_services_list() {
+ local SERVICES_EXCLUDED=${GANTRY_SERVICES_EXCLUDED}
+ local SERVICES_EXCLUDED_FILTERS=${GANTRY_SERVICES_EXCLUDED_FILTERS}
+ local SERVICES_FILTERS=${GANTRY_SERVICES_FILTERS}
+ local SELF=${GANTRY_SERVICES_SELF}
+ local SERVICES=
+ SERVICES=$(get_services_filted "${SERVICES_FILTERS}")
+ [ $? -ne 0 ] && return 1
+ if [ -n "${SERVICES_EXCLUDED_FILTERS}" ]; then
+ local SERVICES_FROM_EXCLUDED_FILTERS=
+ SERVICES_FROM_EXCLUDED_FILTERS=$(get_services_filted "${SERVICES_EXCLUDED_FILTERS}")
+ [ $? -ne 0 ] && return 1
+ SERVICES_EXCLUDED="${SERVICES_EXCLUDED} ${SERVICES_FROM_EXCLUDED_FILTERS}"
+ fi
+ local LIST=
+ local HAS_SELF=
+ for S in ${SERVICES} ; do
+ if in_list "${SERVICES_EXCLUDED}" "${S}" ; then
+ continue
+ fi
+ # Add self to the first of the list.
+ if [ "${S}" = "${SELF}" ]; then
+ HAS_SELF=${S}
+ continue
+ fi
+ LIST="${LIST} ${S}"
+ done
+ # Add self to the first of the list.
+ if [ -n "${HAS_SELF}" ]; then
+ LIST="${HAS_SELF} ${LIST}"
+ fi
+ echo ${LIST}
+}
+
+gantry_update_services_list() {
+ local LIST=${@}
+ local ACCUMULATED_ERRORS=0
+ local LOG_SCOPE_SAVED=${LOG_SCOPE}
+ for SERVICE in ${LIST}; do
+ LOG_SCOPE="Updating service ${SERVICE}"
+ update_single_service ${SERVICE}
+ ACCUMULATED_ERRORS=$((ACCUMULATED_ERRORS + $?))
+ done
+ LOG_SCOPE=${LOG_SCOPE_SAVED}
+ return ${ACCUMULATED_ERRORS}
+}
+
+gantry_finalize() {
+ local STACK=${1:-gantry}
+ report_services;
+ remove_images "${STACK}_image-remover"
+}
diff --git a/src/notification.sh b/src/notification.sh
new file mode 100755
index 0000000..9305031
--- /dev/null
+++ b/src/notification.sh
@@ -0,0 +1,34 @@
+#!/bin/sh
+# Copyright (C) 2023 Shizun Ge
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+
+notify_via_apprise() {
+ local URL=${GANTRY_NOTIFICATION_APPRISE_URL}
+ local TITLE="${1}"
+ local BODY="${2}"
+ if [ -z "${URL}" ]; then
+ return 0
+ fi
+ curl -X POST -H "Content-Type: application/json" --data "{\"title\": \"${TITLE}\", \"body\": \"${BODY}\"}" "$URL"
+}
+
+notify_summary() {
+ local CUSTOMIZED_TITLE=${GANTRY_NOTIFICATION_TITLE}
+ local TITLE="${1}"
+ local BODY="${2}"
+ [ -n "${CUSTOMIZED_TITLE}" ] && TITLE="${TITLE} ${CUSTOMIZED_TITLE}"
+ notify_via_apprise "${TITLE}" "${BODY}"
+}