Skip to content

Commit

Permalink
Add missing v prefix to k0s Docker tags in docs
Browse files Browse the repository at this point in the history
Fixes: 91893d5 ("Remove remnants of latest k0s Docker image tags in docs")
Signed-off-by: Tom Wieczorek <[email protected]>
(cherry picked from commit d340f35)
(cherry picked from commit b2d2c78)
  • Loading branch information
twz123 authored and github-actions[bot] committed Oct 23, 2023
1 parent cea5585 commit 8ea78e6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/examples/ambassador-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ As you need to create a custom configuration file to install Ambassador Gateway,
1. Run k0s under Docker:

```shell
docker run -d --name k0s --hostname k0s --privileged -v /var/lib/k0s -p 6443:6443 docker.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0
docker run -d --name k0s --hostname k0s --privileged -v /var/lib/k0s -p 6443:6443 docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0
```

2. Export the default k0s configuration file:
Expand Down Expand Up @@ -77,7 +77,7 @@ As you need to create a custom configuration file to install Ambassador Gateway,
3. Retart your k0s container, this time with additional ports and the above config file mapped into it:

```shell
docker run --name k0s --hostname k0s --privileged -v /var/lib/k0s -v "$PWD"/k0s.yaml:/k0s.yaml -p 6443:6443 -p 80:80 -p 443:443 -p 8080:8080 docker.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0
docker run --name k0s --hostname k0s --privileged -v /var/lib/k0s -v "$PWD"/k0s.yaml:/k0s.yaml -p 6443:6443 -p 80:80 -p 443:443 -p 8080:8080 docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0
```

After some time, you will be able to list the Ambassador Services:
Expand Down
10 changes: 5 additions & 5 deletions docs/k0s-in-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ You will require a [Docker environment](https://docs.docker.com/get-docker/) run

The k0s containers are published both on Docker Hub and GitHub. For reasons of simplicity, the examples given here use Docker Hub (GitHub requires a separate authentication that is not covered). Alternative links include:

- docker.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0
- ghcr.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0
- docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0
- ghcr.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0

**Note:** Due to Docker Hub tag validation scheme, we have to use `-` as the k0s version separator instead of the usual `+`. So for example k0s version `v{{{ extra.k8s_version }}}+k0s.0` is tagged as `docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0`.

Expand All @@ -22,7 +22,7 @@ The k0s containers are published both on Docker Hub and GitHub. For reasons of s
You can run your own k0s in Docker:

```sh
docker run -d --name k0s --hostname k0s --privileged -v /var/lib/k0s -p 6443:6443 docker.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0
docker run -d --name k0s --hostname k0s --privileged -v /var/lib/k0s -p 6443:6443 docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0
```

**Note:** If you are using Docker Desktop as the runtime, starting from 4.3.0 version it's using cgroups v2 in the VM that runs the engine. This means you have to add some extra flags to the above command to get kubelet and containerd to properly work with cgroups v2:
Expand All @@ -46,7 +46,7 @@ For each required worker:
2. Run the container to create and join the new worker:

```sh
docker run -d --name k0s-worker1 --hostname k0s-worker1 --privileged -v /var/lib/k0s docker.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0 k0s worker $token
docker run -d --name k0s-worker1 --hostname k0s-worker1 --privileged -v /var/lib/k0s docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0 k0s worker $token
```

### 3. Access your cluster
Expand All @@ -68,7 +68,7 @@ version: "3.9"
services:
k0s:
container_name: k0s
image: docker.io/k0sproject/k0s:{{{ extra.k8s_version }}}-k0s.0
image: docker.io/k0sproject/k0s:v{{{ extra.k8s_version }}}-k0s.0
command: k0s controller --config=/etc/k0s/config.yaml --enable-worker
hostname: k0s
privileged: true
Expand Down

0 comments on commit 8ea78e6

Please sign in to comment.