Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for image-builder v0.1.31 release #1531

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.30][] (June 13, 2024). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.30`.
The current release of Image Builder is [v0.1.31][] (July 30, 2024). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.31`.

## Release Process

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


[v0.1.30]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.30
[v0.1.31]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.31
[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.30
docker pull registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.31
```

### 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.30 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.31 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.30 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.31 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.30 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.31 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.30 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.31 build-node-ova-vsphere-ubuntu-2004
```

In addition to this, further customizations can be done as discussed [here](./capi.md#customization).
8 changes: 4 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.30][] (June 13, 2024). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.30`.
The current release of Image Builder is [v0.1.31][] (July 30, 2024). The corresponding container image is `registry.k8s.io/scl-image-builder/cluster-node-image-builder-amd64:v0.1.31`.

## 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.31`.*
- *Replace `x` with the next patch version. For example: `v0.1.32`.*
- `git tag -s -m "Image Builder ${IB_VERSION}" ${IB_VERSION}`
- `git push upstream ${IB_VERSION}`

Expand Down Expand Up @@ -77,11 +77,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.31 is now available: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.31
Image-builder v0.1.32 is now available: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.32
Thanks to all contributors!
```

[v0.1.30]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.30
[v0.1.31]: https://github.com/kubernetes-sigs/image-builder/releases/tag/v0.1.31
[#image-builder channel]: https://kubernetes.slack.com/archives/C01E0Q35A8J
[Personal access tokens]: https://github.com/settings/tokens
[post-image-builder-push-images]: https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#post-image-builder-push-images
Expand Down