mirror of
https://github.com/containrrr/watchtower.git
synced 2025-02-13 19:42:16 +02:00
docs: fix more auto-format casualties (#943)
This commit is contained in:
parent
0c53b7121e
commit
e308521a95
8
.github/workflows/publish-docs.yml
vendored
8
.github/workflows/publish-docs.yml
vendored
@ -24,10 +24,4 @@ jobs:
|
|||||||
mkdocs-material \
|
mkdocs-material \
|
||||||
md-toc
|
md-toc
|
||||||
- name: Generate docs
|
- name: Generate docs
|
||||||
run: mkdocs gh-deploy --strict
|
run: mkdocs gh-deploy --strict
|
||||||
# - name: Publish docs
|
|
||||||
# uses: peaceiris/actions-gh-pages@v3
|
|
||||||
# with:
|
|
||||||
# github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
# publish_dir: ./site
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
|||||||
<p style="text-align: center; margin-left: 1.6rem;">
|
<p style="text-align: center; margin-left: 1.6rem;">
|
||||||
<img src="./images/logo-450px.png" width="450" />
|
<img alt="Logotype depicting a lighthouse" src="./images/logo-450px.png" width="450" />
|
||||||
</p>
|
</p>
|
||||||
<h1 align="center">
|
<h1 align="center">
|
||||||
Watchtower
|
Watchtower
|
||||||
@ -48,15 +48,17 @@ and restart it with the same options that were used when it was deployed initial
|
|||||||
the following command:
|
the following command:
|
||||||
|
|
||||||
=== "docker run"
|
=== "docker run"
|
||||||
```bash $ docker run -d \
|
```bash
|
||||||
--name watchtower \
|
$ docker run -d \
|
||||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
--name watchtower \
|
||||||
containrrr/watchtower
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||||
```
|
containrrr/watchtower
|
||||||
|
```
|
||||||
=== "docker-compose.yml"
|
=== "docker-compose.yml"
|
||||||
```yaml version: "3"
|
```yaml
|
||||||
services:
|
version: "3"
|
||||||
watchtower:
|
services:
|
||||||
image: containrrr/watchtower volumes:
|
watchtower:
|
||||||
- /var/run/docker.sock:/var/run/docker.sock
|
image: containrrr/watchtower volumes:
|
||||||
```
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
```
|
@ -31,18 +31,21 @@ These labels can be declared as instructions in a Dockerfile (with some example
|
|||||||
the `docker run` command line:
|
the `docker run` command line:
|
||||||
|
|
||||||
=== "Dockerfile"
|
=== "Dockerfile"
|
||||||
```docker LABEL com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh"
|
```docker
|
||||||
LABEL com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh"
|
LABEL com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh"
|
||||||
LABEL com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh"
|
LABEL com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh"
|
||||||
LABEL com.centurylinklabs.watchtower.lifecycle.post-check="/send-heartbeat.sh"
|
LABEL com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh"
|
||||||
```
|
LABEL com.centurylinklabs.watchtower.lifecycle.post-check="/send-heartbeat.sh"
|
||||||
|
```
|
||||||
|
|
||||||
=== "docker run"
|
=== "docker run"
|
||||||
```bash docker run -d \
|
```bash
|
||||||
--label=com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh" \
|
docker run -d \
|
||||||
--label=com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" \
|
--label=com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh" \
|
||||||
--label=com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" \
|
--label=com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" \
|
||||||
someimage --label=com.centurylinklabs.watchtower.lifecycle.post-check="/send-heartbeat.sh" \
|
--label=com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" \
|
||||||
```
|
someimage --label=com.centurylinklabs.watchtower.lifecycle.post-check="/send-heartbeat.sh" \
|
||||||
|
```
|
||||||
|
|
||||||
### Timeouts
|
### Timeouts
|
||||||
The timeout for all lifecycle commands is 60 seconds. After that, a timeout will
|
The timeout for all lifecycle commands is 60 seconds. After that, a timeout will
|
||||||
|
@ -103,43 +103,40 @@ Use the dockerfile below to build the [amazon-ecr-credential-helper](https://git
|
|||||||
in a volume that may be mounted onto your watchtower container.
|
in a volume that may be mounted onto your watchtower container.
|
||||||
|
|
||||||
1. Create the Dockerfile (contents below):
|
1. Create the Dockerfile (contents below):
|
||||||
|
```Dockerfile
|
||||||
```Dockerfile
|
FROM golang:latest
|
||||||
FROM golang:latest
|
|
||||||
|
ENV CGO_ENABLED 0
|
||||||
ENV CGO_ENABLED 0
|
ENV REPO github.com/awslabs/amazon-ecr-credential-helper/ecr-login/cli/docker-credential-ecr-login
|
||||||
ENV REPO github.com/awslabs/amazon-ecr-credential-helper/ecr-login/cli/docker-credential-ecr-login
|
|
||||||
|
RUN go get -u $REPO
|
||||||
RUN go get -u $REPO
|
|
||||||
|
RUN rm /go/bin/docker-credential-ecr-login
|
||||||
RUN rm /go/bin/docker-credential-ecr-login
|
|
||||||
|
RUN go build \
|
||||||
RUN go build \
|
|
||||||
-o /go/bin/docker-credential-ecr-login \
|
-o /go/bin/docker-credential-ecr-login \
|
||||||
/go/src/$REPO
|
/go/src/$REPO
|
||||||
|
|
||||||
WORKDIR /go/bin/
|
WORKDIR /go/bin/
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Use the following commands to build the aws-ecr-dock-cred-helper and store it's output in a volume:
|
2. Use the following commands to build the aws-ecr-dock-cred-helper and store it's output in a volume:
|
||||||
|
```bash
|
||||||
```bash
|
# Create a volume to store the command (once built)
|
||||||
# Create a volume to store the command (once built)
|
docker volume create helper
|
||||||
docker volume create helper
|
|
||||||
|
# Build the container
|
||||||
# Build the container
|
docker build -t aws-ecr-dock-cred-helper .
|
||||||
docker build -t aws-ecr-dock-cred-helper .
|
|
||||||
|
# Build the command and store it in the new volume in the /go/bin directory.
|
||||||
# Build the command and store it in the new volume in the /go/bin directory.
|
docker run -d --rm --name aws-cred-helper \
|
||||||
docker run -d --rm --name aws-cred-helper --volume helper:/go/bin aws-ecr-dock-cred-helper
|
--volume helper:/go/bin aws-ecr-dock-cred-helper
|
||||||
|
```
|
||||||
```
|
|
||||||
|
|
||||||
3. Create a configuration file for docker, and store it in $HOME/.docker/config.json (replace the <AWS_ACCOUNT_ID>
|
3. Create a configuration file for docker, and store it in $HOME/.docker/config.json (replace the <AWS_ACCOUNT_ID>
|
||||||
placeholders with your AWS Account ID):
|
placeholders with your AWS Account ID):
|
||||||
|
```json
|
||||||
```json
|
{
|
||||||
{
|
|
||||||
"credsStore" : "ecr-login",
|
"credsStore" : "ecr-login",
|
||||||
"HttpHeaders" : {
|
"HttpHeaders" : {
|
||||||
"User-Agent" : "Docker-Client/19.03.1 (XXXXXX)"
|
"User-Agent" : "Docker-Client/19.03.1 (XXXXXX)"
|
||||||
@ -150,11 +147,10 @@ in a volume that may be mounted onto your watchtower container.
|
|||||||
"credHelpers": {
|
"credHelpers": {
|
||||||
"<AWS_ACCOUNT_ID>.dkr.ecr.us-west-1.amazonaws.com" : "ecr-login"
|
"<AWS_ACCOUNT_ID>.dkr.ecr.us-west-1.amazonaws.com" : "ecr-login"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Create a docker-compose file (as an example) to help launch the container:
|
4. Create a docker-compose file (as an example) to help launch the container:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
version: "3.4"
|
version: "3.4"
|
||||||
services:
|
services:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user