Skip to content

Commit 2343838

Browse files
committed
docs: update and simplify image name section
- Provide directions that work with current kubebuilder output - Provide simpler example overriding of image name - Drop old no longer working example of image name patching - Providing a more current example of how providers actually do this would involve teaching about CI/CD setups which seems out of scope for this document Signed-off-by: cprivitere <23177737+cprivitere@users.noreply.github.com>
1 parent ae9a846 commit 2343838

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

docs/book/src/developer/providers/getting-started/building-running-and-testing.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22

33
## Docker Image Name
44

5-
The patch in `config/manager/manager_image_patch.yaml` will be applied to the manager pod.
6-
Right now there is a placeholder `IMAGE_URL`, which you will need to change to your actual image.
5+
The IMG variable is used to build the Docker image and push it to a registry. The default value is `controller:latest`, which is a local image. You can change it to a remote image if you want to push it to a registry.
76

8-
### Development Images
9-
It's likely that you will want one location and tag for release development, and another during development.
10-
11-
The approach most Cluster API projects is using [a `Makefile` that uses `sed` to replace the image URL][sed] on demand during development.
12-
13-
[sed]: https://github.com/kubernetes-sigs/cluster-api/blob/e0fb83a839b2755b14fbefbe6f93db9a58c76952/Makefile#L201-L204
7+
```bash
8+
make docker-push IMG=ghcr.io/your-org/your-repo:dev
9+
```
1410

1511
## Deployment
1612

0 commit comments

Comments
 (0)