Skip to content

Commit

Permalink
Updated docs post v0.1.20 release
Browse files Browse the repository at this point in the history
Signed-off-by: Marcus Noble <[email protected]>
  • Loading branch information
AverageMarcus committed Oct 16, 2023
1 parent c70b22b commit eae7788
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
4 changes: 2 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Image Builder Releases

The current release of Image Builder is [v0.1.19][] (September 13, 2023). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19`.
The current release of Image Builder is [v0.1.20][] (October 16, 2023). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20`.

## Release Process

For more detail about image-builder project releases, see the [Image Builder Book][].


[v0.1.19]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.19
[v0.1.20]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.20
[Image Builder Book]: https://image-builder.sigs.k8s.io/capi/releasing.html
10 changes: 5 additions & 5 deletions docs/book/src/capi/container-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Run the docker build target of Makefile
The latest image-builder container image release is available here:

```commandline
docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19
docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20
```

### Examples
Expand All @@ -27,7 +27,7 @@ docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v
- If the AWS CLI is already installed on your machine, you can simply mount the `~/.aws` folder that stores all the required credentials.

```commandline
docker run -it --rm -v /Users/<user>/.aws:/home/imagebuilder/.aws registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19 build-ami-ubuntu-2004
docker run -it --rm -v /Users/<user>/.aws:/home/imagebuilder/.aws registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20 build-ami-ubuntu-2004
```
- Another alternative is to use an `aws-creds.env` file to load the credentials and pass it during docker run.

Expand All @@ -38,7 +38,7 @@ docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v
```

```commandline
docker run -it --rm --env-file aws-creds.env registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19 build-ami-ubuntu-2004
docker run -it --rm --env-file aws-creds.env registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20 build-ami-ubuntu-2004
```

- AZURE
Expand All @@ -53,7 +53,7 @@ docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v
```

```commandline
docker run -it --rm --env-file az-creds.env registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19 build-azure-sig-ubuntu-2004
docker run -it --rm --env-file az-creds.env registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20 build-azure-sig-ubuntu-2004
```

- vSphere OVA
Expand All @@ -62,7 +62,7 @@ docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v
- Docker's `--net=host` option to ensure http server starts with the host IP and not the Docker container IP. This option is Linux specific and thus implies that it can be run only from a Linux machine.

```commandline
docker run -it --rm --net=host --env PACKER_VAR_FILES=/home/imagebuilder/vsphere.json -v <complete path of vsphere.json>:/home/imagebuilder/vsphere.json registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19 build-node-ova-vsphere-ubuntu-2004
docker run -it --rm --net=host --env PACKER_VAR_FILES=/home/imagebuilder/vsphere.json -v <complete path of vsphere.json>:/home/imagebuilder/vsphere.json registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20 build-node-ova-vsphere-ubuntu-2004
```

In addition to this, further customizations can be done as discussed [here](./capi.md#customization).
9 changes: 5 additions & 4 deletions docs/book/src/capi/releasing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Image Builder Releases

The current release of Image Builder is [v0.1.19][] (September 13, 2023). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.19`.
The current release of Image Builder is [v0.1.20][] (October 16, 2023). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.20`.

## Release Process

Expand All @@ -22,7 +22,7 @@ Releases in image-builder follow [semantic versioning][semver] conventions. Curr
- *If signing tags with GPG, makes your key available to the `git tag` command.*
- Create a new tag:
- `export IB_VERSION=v0.1.x`
- *Replace `x` with the next patch version. For example: `v0.1.20`.*
- *Replace `x` with the next patch version. For example: `v0.1.21`.*
- `git tag -s -m "Image Builder ${IB_VERSION}" ${IB_VERSION}`
- `git push upstream ${IB_VERSION}`

Expand All @@ -36,6 +36,7 @@ Pushing the tag in the previous step triggered a job to build the container imag
- Create a GitHub pull request to promote the image:
- `export GITHUB_TOKEN=<your GH token>`
- `make -C images/capi promote-image`
- Note: If your own fork isn't used as the `origin` remote you'll need to set the `USER_FORK` variable, e.g. `make -C images/capi promote-image USER_FORK=AverageMarcus`

This will create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the image-builder maintainers. Example PR: https://github.com/kubernetes/k8s.io/pull/5262.

Expand Down Expand Up @@ -73,11 +74,11 @@ Wait for this PR to merge before communicating the release to users, so image-bu
In the [#image-builder channel][] on the Kubernetes Slack, post a message announcing the new release. Include a link to the GitHub release and a thanks to the contributors:

```
Image-builder v0.1.20 is now available: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.20
Image-builder v0.1.21 is now available: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.21
Thanks to all contributors!
```

[v0.1.19]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.19
[v0.1.20]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.20
[#image-builder channel]: https://kubernetes.slack.com/archives/C01E0Q35A8J
[Personal access tokens]: https://github.com/settings/tokens
[pr-container-image-build]: https://testgrid.k8s.io/sig-cluster-lifecycle-image-builder#pr-container-image-build
Expand Down

0 comments on commit eae7788

Please sign in to comment.