Skip to content

Commit b71939a

Browse files
authored
Add GitHub container registry URL to docs. (#354)
1 parent 45fffb2 commit b71939a

File tree

3 files changed

+32
-18
lines changed

3 files changed

+32
-18
lines changed

docs/imagecustomizer/how-to/azure-vm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ in front of any HTTP endpoints.
152152
5. Run Image Customizer to create the new image:
153153
154154
```bash
155-
IMG_CUSTOMIZER_TAG="mcr.microsoft.com/azurelinux/imagecustomizer:0.13.0"
155+
IMG_CUSTOMIZER_TAG="mcr.microsoft.com/azurelinux/imagecustomizer:0.17.0"
156156
docker run \
157157
--rm \
158158
--privileged=true \

docs/imagecustomizer/quick-start/quick-start.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,37 @@ has_toc: false
99

1010
The Image Customizer container packages up the Image Customizer executable along with all of its dependencies. This is the *recommended* way to use Image Customizer.
1111

12-
The container is published to the [Microsoft Container Registry (MCR)](https://mcr.microsoft.com/en-us/artifact/mar/azurelinux/imagecustomizer/) at:
12+
The container is published to both:
1313

14-
```text
15-
mcr.microsoft.com/azurelinux/imagecustomizer:<version>
16-
```
14+
- The [Microsoft Artifact Registry (MCR)](https://mcr.microsoft.com/en-us/artifact/mar/azurelinux/imagecustomizer/) at:
1715

18-
For example:
16+
```text
17+
mcr.microsoft.com/azurelinux/imagecustomizer:<version>
18+
```
1919

20-
```text
21-
mcr.microsoft.com/azurelinux/imagecustomizer:0.13.0
22-
```
20+
For example:
2321

24-
You can also use the MCR REST API to query available and latest tags:
22+
```text
23+
mcr.microsoft.com/azurelinux/imagecustomizer:0.17.0
24+
```
2525

26-
``` bash
27-
curl -s "https://mcr.microsoft.com/v2/azurelinux/imagecustomizer/tags/list" | jq '.tags[]'
28-
```
26+
You can use the MCR REST API to query available and latest tags:
27+
28+
``` bash
29+
curl -s "https://mcr.microsoft.com/v2/azurelinux/imagecustomizer/tags/list" | jq '.tags[]'
30+
```
31+
32+
- The GitHub Container Registry at:
33+
34+
```text
35+
ghcr.io/microsoft/imagecustomizer:<version>
36+
```
37+
38+
For example:
39+
40+
```text
41+
ghcr.io/microsoft/imagecustomizer:0.17.0
42+
```
2943

3044
## Prerequisites
3145

@@ -60,7 +74,7 @@ curl -s "https://mcr.microsoft.com/v2/azurelinux/imagecustomizer/tags/list" | jq
6074
--privileged=true \
6175
-v /dev:/dev \
6276
-v "$HOME/staging:/mnt/staging:z" \
63-
mcr.microsoft.com/azurelinux/imagecustomizer:0.13.0 \
77+
mcr.microsoft.com/azurelinux/imagecustomizer:0.17.0 \
6478
imagecustomizer \
6579
--image-file "/mnt/staging/image.vhdx" \
6680
--config-file "/mnt/staging/image-config.yaml" \
@@ -87,7 +101,7 @@ curl -s "https://mcr.microsoft.com/v2/azurelinux/imagecustomizer/tags/list" | jq
87101
- `-v $HOME/staging:/mnt/staging:z`: Mounts a host directory (`$HOME/staging`) into the
88102
container. This can be used to easily pass files in and out of the container.
89103

90-
- `mcr.microsoft.com/azurelinux/imagecustomizer:0.13.0`: The container to run.
104+
- `mcr.microsoft.com/azurelinux/imagecustomizer:0.17.0`: The container to run.
91105

92106
- `imagecustomizer`: Specifies the executable to run within the container.
93107

@@ -121,7 +135,7 @@ For example, this is the equivalent call to the above example:
121135

122136
```bash
123137
run-container.sh \
124-
-t mcr.microsoft.com/azurelinux/imagecustomizer:0.13.0 \
138+
-t mcr.microsoft.com/azurelinux/imagecustomizer:0.17.0 \
125139
-i "$HOME/staging/image.vhdx" \
126140
-c "$HOME/staging/image-config.yaml" \
127141
-f vhdx \

docs/imagecustomizer/telemetry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Image Customizer can be run in two ways:
1818
- As a container image downloaded from Microsoft Artifact Registry
1919
- As a binary built from the GitHub repository
2020

21-
Telemetry is collected in both cases.
21+
Telemetry is collected in both cases.
2222

2323
## How to opt out
2424

@@ -31,7 +31,7 @@ docker run \
3131
--privileged=true \
3232
-v /dev:/dev \
3333
-v "$HOME/staging:/mnt/staging:z" \
34-
mcr.microsoft.com/azurelinux/imagecustomizer:0.15.0 \
34+
mcr.microsoft.com/azurelinux/imagecustomizer:0.17.0 \
3535
imagecustomizer \
3636
--image-file "/mnt/staging/image.vhdx" \
3737
--config-file "/mnt/staging/image-config.yaml" \

0 commit comments

Comments
 (0)