Skip to content

Commit 21e02c1

Browse files
committed
Update pre-requisites
Signed-off-by: Steve Lasker <[email protected]>
1 parent fe953a9 commit 21e02c1

File tree

2 files changed

+35
-37
lines changed

2 files changed

+35
-37
lines changed

articles/container-registry/container-registry-oci-artifacts.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,10 @@ To demonstrate this capability, this article shows how to use the [OCI Registry
1616

1717
## Prerequisites
1818

19-
* **Azure container registry** - Create a container registry in your Azure subscription. For example, use the [Azure portal](container-registry-get-started-portal.md) or the [Azure CLI][az-acr-create].
20-
* **Azure CLI** - Version `2.29.1` or later is recommended. Run `az --version `to find the required. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
21-
* **ORAS CLI** - Download and install the ORAS CLI `v0.16.0` for your operating system from the [ORAS installation guide](https://oras.land/cli/).
22-
* **Docker** - ORAS optionally leverages the Docker desktop credential store for authentication.
23-
If Docker Desktop is installed, it must be running.
24-
You can use [Docker installed locally][docker-install] to build and push a container image, reference an existing container image or use [ACR Build][az-acr-build] to build remotely, in Azure.
19+
* **Azure container registry** - Create a container registry in your Azure subscription. For example, use the [Azure portal](container-registry-get-started-portal.md) or [az acr create][az-acr-create].
20+
* **Azure CLI** - Version `2.29.1` or later is required. See [Install Azure CLI](/cli/azure/install-azure-cli) for installation and/or upgrade.
21+
* **ORAS CLI** - Version `v0.16.0` is required. See: [ORAS installation][oras-install-docs].
22+
* **Docker (Optional)** - While Docker Desktop is not required, the `oras` cli utilizes the Docker desktop credential store for storing credentials. If Docker Desktop is installed, it must be running for `oras login`.
2523

2624
## Configure a registry
2725

@@ -206,12 +204,10 @@ tree ./download
206204

207205
## Remove the artifact (optional)
208206

209-
To remove the artifact from your Azure container registry, use the [az acr repository delete][az-acr-repository-delete] command. The following example removes the artifact you stored there:
207+
To remove the artifact from your registry, use the `oras manifest delete` command.
210208

211-
```azurecli
212-
az acr repository delete \
213-
--name $REGISTRY \
214-
--image samples/artifact:readme
209+
```bash
210+
oras manifest delete $REGISTRY/samples/artifact:readme
215211
```
216212

217213
## Next steps
@@ -222,9 +218,11 @@ az acr repository delete \
222218

223219
<!-- LINKS - external -->
224220
[iana-mediatypes]: https://www.rfc-editor.org/rfc/rfc6838
221+
[oras-install-docs]: https://oras.land/cli/
225222
[oras-push-multifiles]: https://oras.land/cli/1_pushing/#pushing-artifacts-with-multiple-files
226223
<!-- LINKS - internal -->
227224
[acr-landing]: https://aka.ms/acr
228225
[acr-authentication]: /azure/container-registry/container-registry-authentication?tabs=azure-cli
229226
[az-acr-create]: /container-registry/container-registry-get-started-azure-cli
230227
[az-acr-repository-delete]: /cli/azure/acr/repository#az_acr_repository_delete
228+
[azure-cli-install]: /cli/azure/install-azure-cli

articles/container-registry/container-registry-oras-artifacts.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,25 @@ ms.custom: references_regions, devx-track-azurecli
1111

1212
# Push and pull supply chain artifacts using Azure Registry (Preview)
1313

14-
Use an Azure container registry to store and manage a graph of supply chain artifacts, including signatures, software bill of materials (SBoM), security scan results or other types.
14+
Use an Azure container registry to store and manage a graph of supply chain artifacts, including signatures, software bill of materials (SBOM), security scan results and other types.
1515

1616
![Graph of artifacts, including a container image, signature and signed software bill of materials](./media/container-registry-artifacts/oras-artifact-graph.svg)
1717

1818
To demonstrate this capability, this article shows how to use the [OCI Registry as Storage (ORAS)](https://oras.land) CLI to `push`, `discover` and `pull` a graph of supply chain artifacts to an Azure container registry.
19+
Storing individual (root) OCI Artifacts are covered in [Push and pull OCI artifacts](container-registry-oci-artifacts.md).
1920

20-
Storing individual (root) OCI Artifacts are covered in [Push and pull OCI artifact](container-registry-oci-artifacts.md).
2121
To store a graph of artifacts, a reference to a `subject` artifact is defined using the [OCI Artifact Manifest][oci-artifact-manifest], which is part of the [pre-release OCI 1.1 Distribution specification][oci-1_1-spec].
22-
OCI 1.1 Artifact Manifest support is a preview feature and subject to [limitations](#preview-limitations).
22+
OCI 1.1 Artifact Manifest support is an ACR preview feature and subject to [limitations](#preview-limitations).
2323

2424
## Prerequisites
2525

26-
* **Azure container registry** - Create a container registry in your Azure subscription. For example, use the [Azure portal](container-registry-get-started-portal.md) or the [Azure CLI][az-acr-create].
27-
* **Azure CLI** - Version `2.29.1` or later is recommended. Run `az --version `to find the required. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
28-
* **ORAS CLI** - Download and install the ORAS CLI `v0.16.0` for your operating system from the [ORAS installation guide][oras-install-docs].
29-
* **Docker** - ORAS optionally leverages the Docker desktop credential store for authentication.
30-
If Docker Desktop is installed, it must be running.
31-
To complete the walkthrough, a container image is referenced.
32-
You can use [Docker installed locally][docker-install] to build and push a container image, reference an existing container image or use [ACR Build][az-acr-build] to build remotely, in Azure.
33-
You can use [Docker installed locally][docker-install] to build and push a container image, reference an existing container image or use [ACR Build][az-acr-build] to build remotely, in Azure.
26+
* **Azure container registry** - Create a container registry in your Azure subscription. For example, use the [Azure portal](container-registry-get-started-portal.md) or the [Azure CLI][az-acr-create].
27+
*See [Preview limitations](#preview-limitations) for Azure cloud support.*
28+
* **Azure CLI** - Version `2.29.1` or later is required. See [Install Azure CLI](/cli/azure/install-azure-cli) for installation and/or upgrade.
29+
* **ORAS CLI** - Version `v0.16.0` is required. See: [ORAS installation][oras-install-docs].
30+
* **Docker (Optional)** - To complete the walkthrough, a container image is referenced.
31+
You can use [Docker installed locally][docker-install] to build and push a container image, or use [`acr build`][az-acr-build] to build remotely in Azure.
32+
While Docker Desktop is not required, the `oras` cli utilizes the Docker desktop credential store for storing credentials. If Docker Desktop is installed, it must be running for `oras login`.
3433

3534
## Preview limitations
3635

@@ -145,44 +144,44 @@ myregistry.azurecr.io/net-monitor:v1
145144

146145
## Creating a deep graphs of artifacts
147146

148-
The OCI v1.1 Specification enables deep graphs, enabling signed software bill of materials (SBoM) and other artifact types.
147+
The OCI v1.1 Specification enables deep graphs, enabling signed software bill of materials (SBOM) and other artifact types.
149148

150-
### Create a sample SBoM
149+
### Create a sample SBOM
151150

152151
```bash
153-
echo '{"version": "0.0.0.0", "artifact": "'${IMAGE}'", "contents": "good"}' > sbom.json
152+
echo '{"version": "0.0.0.0", "artifact": "'${IMAGE}'", "contents": "good"}' > SBOM.json
154153
```
155154

156-
### Attach a sample SBoM to the image in the registry
155+
### Attach a sample SBOM to the image in the registry
157156

158157
```bash
159158
oras attach $IMAGE \
160-
./sbom.json:application/json \
161-
--artifact-type sbom/example
159+
./SBOM.json:application/json \
160+
--artifact-type SBOM/example
162161
```
163162

164-
### Sign the SBoM
163+
### Sign the SBOM
165164

166165
Artifacts that are pushed as references, typically don't have tags as they're considered part of the subject artifact. To push a signature to an artifact that is a child of another artifact, use the `oras discover` with `--artifact-type` filtering to find the digest.
167166

168167
```bash
169168
SBOM_DIGEST=$(oras discover -o json \
170-
--artifact-type sbom/example \
169+
--artifact-type SBOM/example \
171170
$IMAGE | jq -r ".manifests[0].digest")
172171
```
173172

174-
Create a signature of an SBoM
173+
Create a signature of an SBOM
175174

176175
```bash
177-
echo '{"artifact": "'$IMAGE@$SBOM_DIGEST'", "signature": "pat hancock"}' > sbom-signature.json
176+
echo '{"artifact": "'$IMAGE@$SBOM_DIGEST'", "signature": "pat hancock"}' > SBOM-signature.json
178177
```
179178

180-
### Attach the SBoM signature
179+
### Attach the SBOM signature
181180

182181
```bash
183182
oras attach $IMAGE@$SBOM_DIGEST \
184183
--artifact-type 'signature/example' \
185-
./sbom-signature.json:application/json
184+
./SBOM-signature.json:application/json
186185
```
187186

188187
### View the graph
@@ -199,7 +198,7 @@ myregistry.azurecr.io/net-monitor:v1
199198
│ └── sha256:555ea91f39e7fb30c06f3b7aa483663f067f2950dcb...
200199
├── readme/example
201200
│ └── sha256:1a118663d1085e229ff1b2d4d89b5f6d67911f22e55...
202-
└── sbom/example
201+
└── SBOM/example
203202
└── sha256:4280eef9adb632b42cf200e7cd5a822a456a558e4f3142da6b...
204203
└── signature/example
205204
└── sha256:a31ab875d37eee1cca68dbb14b2009979d05594d44a075bdd7...
@@ -255,7 +254,7 @@ tree ./download
255254

256255
## View the repository and tag listing
257256

258-
The OCI Artifact Manifest enables artifact graphs to be pushed, discovered, pulled and copied without having to assign tags. Artifact manifests enables a tag listing to focus on the artifacts users think about, as opposed to the signatures and SBoMs that are associated with the container images, helm charts and other artifacts.
257+
The OCI Artifact Manifest enables artifact graphs to be pushed, discovered, pulled and copied without having to assign tags. Artifact manifests enables a tag listing to focus on the artifacts users think about, as opposed to the signatures and SBOMs that are associated with the container images, helm charts and other artifacts.
259258

260259
### View a list of tags
261260

@@ -321,7 +320,7 @@ The signature is untagged, but tracked as a `oras.artifact.manifest` reference t
321320

322321
## Delete all artifacts in the graph
323322

324-
Support for the OCI v1.1 Specification enables deleting the graph of artifacts associated with the root artifact. Use the [az acr repository delete][az-acr-repository-delete] command to delete the signature, SBoM and the signature of the SBoM.
323+
Support for the OCI v1.1 Specification enables deleting the graph of artifacts associated with the root artifact. Use the [az acr repository delete][az-acr-repository-delete] command to delete the signature, SBOM and the signature of the SBOM.
325324

326325
```azurecli
327326
az acr repository delete \
@@ -361,3 +360,4 @@ az acr manifest list-metadata \
361360
[az-acr-create]: /container-registry/container-registry-get-started-azure-cli
362361
[az-acr-build]: /cli/azure/acr#az_acr_build
363362
[az-acr-repository-delete]: /cli/azure/acr/repository#az_acr_repository_delete
363+
[azure-cli-install]: /cli/azure/install-azure-cli

0 commit comments

Comments
 (0)