forked from oras-project/oras-www
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the ORAS website with new design and Docusaurus framework (ora…
…s-project#147) * feat: initial commit for docusaurus migration (oras-project#140) * feat: initial commit for docusaurus migration Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * use admonitions instead of block quotes Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * truncate blog post Signed-off-by: Asmit Malakannawar <[email protected]> * use admonitions in blog post Signed-off-by: Asmit Malakannawar <[email protected]> * feat: add netlify.toml file Signed-off-by: Asmit Malakannawar <[email protected]> * add netlify-plugin-cache Signed-off-by: Asmit Malakannawar <[email protected]> * fix links Signed-off-by: Asmit Malakannawar <[email protected]> * rename folders, add content and fix links Signed-off-by: Asmit Malakannawar <[email protected]> * remove old docs Signed-off-by: Asmit Malakannawar <[email protected]> --------- Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * feat: add announcement bar and feature section update (oras-project#145) * feat: initial commit for docusaurus migration Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * use admonitions instead of block quotes Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * truncate blog post Signed-off-by: Asmit Malakannawar <[email protected]> * use admonitions in blog post Signed-off-by: Asmit Malakannawar <[email protected]> * feat: add netlify.toml file Signed-off-by: Asmit Malakannawar <[email protected]> * add netlify-plugin-cache Signed-off-by: Asmit Malakannawar <[email protected]> * fix links Signed-off-by: Asmit Malakannawar <[email protected]> * rename folders, add content and fix links Signed-off-by: Asmit Malakannawar <[email protected]> * remove old docs Signed-off-by: Asmit Malakannawar <[email protected]> * feat: add anouncement bar and features content Signed-off-by: Asmit Malakannawar <[email protected]> --------- Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * fix: redirects issue (oras-project#146) * feat: initial commit for docusaurus migration Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * use admonitions instead of block quotes Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> * truncate blog post Signed-off-by: Asmit Malakannawar <[email protected]> * use admonitions in blog post Signed-off-by: Asmit Malakannawar <[email protected]> * feat: add netlify.toml file Signed-off-by: Asmit Malakannawar <[email protected]> * add netlify-plugin-cache Signed-off-by: Asmit Malakannawar <[email protected]> * fix links Signed-off-by: Asmit Malakannawar <[email protected]> * rename folders, add content and fix links Signed-off-by: Asmit Malakannawar <[email protected]> * remove old docs Signed-off-by: Asmit Malakannawar <[email protected]> * feat: add anouncement bar and features content Signed-off-by: Asmit Malakannawar <[email protected]> * add redirect files Signed-off-by: Asmit Malakannawar <[email protected]> * fix redirect issues Signed-off-by: Asmit Malakannawar <[email protected]> --------- Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> --------- Signed-off-by: Asmit2952 <[email protected]> Signed-off-by: Asmit Malakannawar <[email protected]> Co-authored-by: Asmit Malakannawar <[email protected]>
- Loading branch information
1 parent
1cef15b
commit 4ab2c1b
Showing
144 changed files
with
40,511 additions
and
2,882 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
# Environments, etc | ||
env | ||
site | ||
# Dependencies | ||
/node_modules | ||
|
||
# Poetry | ||
poetry.lock | ||
# Production | ||
/build | ||
|
||
# VS Code | ||
.vscode | ||
debug | ||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Jetbrains | ||
.idea | ||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
Binary file added
BIN
+32.1 KB
...2021-09-15-oras-artifacts-draft-specification-release/img/net-monitor-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 17 additions & 14 deletions
31
...-artifacts-draft-specification-release.md → ...cts-draft-specification-release/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,17 @@ | ||
# ORAS Artifacts Draft Specification Release – Adding Secure Supply Chain Artifacts References | ||
|
||
_Steve Lasker_ | ||
|
||
Today, the [OCI Registry As Storage (ORAS)](https://oras.land/) project maintainers are happy to announce the first draft release of [artifacts-spec](https://github.com/oras-project/artifacts-spec/releases/tag/1.0.0-draft.1). The artifacts-spec defines how OCI distribution-based registry users can attach references to images, helm charts, and other [OCI Artifacts](https://github.com/opencontainers/artifacts). | ||
|
||
<figure> | ||
<img src="/blog/oras-artifacts-draft-specification-release/net-monitor-graph.svg" width="300" /> | ||
</figure> | ||
|
||
As cloud native development continues to grow, we have seen increased community interest in evolving registries to natively store, discover, and pull a graph of supply chain artifacts. Artifact references are important for many use cases such as adding Software Bill of Materials (SBoM), security scan results, and container image signing. With the release of the artifacts specification, end-user tooling can now implement discovery that makes it feasible to determine if there are any references attached to a container image, answering the key question: “What SBOMs or signatures are associated with this container image?” | ||
|
||
|
||
The ORAS Project was accepted in June 2021 as a Cloud Native Computing Foundation (CNCF) Sandbox project. It is important that we hear from the community as we advance the artifact-spec capability; if you maintain or are implementing a container registry, we are particularly [interested in your feedback](https://github.com/oras-project/artifacts-spec#community). Working together, we can improve supply chain artifact security in the cloud native ecosystem. | ||
--- | ||
slug: oras-artifacts-draft-specification-release | ||
title: ORAS Artifacts Draft Specification Release – Adding Secure Supply Chain Artifacts References | ||
authors: slasker | ||
tags: [oras, artifact] | ||
--- | ||
|
||
Today, the [OCI Registry As Storage (ORAS)](https://oras.land/) project maintainers are happy to announce the first draft release of [artifacts-spec](https://github.com/oras-project/artifacts-spec/releases/tag/1.0.0-draft.1). The artifacts-spec defines how OCI distribution-based registry users can attach references to images, helm charts, and other [OCI Artifacts](https://github.com/opencontainers/artifacts). | ||
|
||
<!--truncate--> | ||
|
||
 | ||
|
||
As cloud native development continues to grow, we have seen increased community interest in evolving registries to natively store, discover, and pull a graph of supply chain artifacts. Artifact references are important for many use cases such as adding Software Bill of Materials (SBoM), security scan results, and container image signing. With the release of the artifacts specification, end-user tooling can now implement discovery that makes it feasible to determine if there are any references attached to a container image, answering the key question: “What SBOMs or signatures are associated with this container image?” | ||
|
||
|
||
The ORAS Project was accepted in June 2021 as a Cloud Native Computing Foundation (CNCF) Sandbox project. It is important that we hear from the community as we advance the artifact-spec capability; if you maintain or are implementing a container registry, we are particularly [interested in your feedback](https://github.com/oras-project/artifacts-spec#community). Working together, we can improve supply chain artifact security in the cloud native ecosystem. |
File renamed without changes
File renamed without changes
239 changes: 122 additions & 117 deletions
239
docs/blog/oras-0.14-and-future.md → ...2022-09-27-oras-0.14-and-future/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,117 +1,122 @@ | ||
# ORAS 0.14 and Future: Empower Container Secure Supply Chain | ||
|
||
_[Feynman Zhou](https://twitter.com/FeynmanZhou), CNCF Ambassador, ACR Product Manager_ | ||
|
||
The [OCI Registry As Storage (ORAS)](https://oras.land/) project maintainers announced v0.14 release for the ORAS CLI recently. ORAS v0.14 introduces four new top-level commands and new options to manage supply chain artifacts across different container registries and multi-cloud environments. | ||
|
||
## What's new in ORAS 0.14 | ||
|
||
 | ||
|
||
Please see the [Release Notes](https://github.com/oras-project/oras/releases/tag/v0.14.0) for details. | ||
|
||
Prior to ORAS CLI v0.14 release, the ORAS Go library, also released v2.0.0-rc.2 to support [artifacts-spec v1.0.0-rc.2](https://github.com/oras-project/artifacts-spec/releases/tag/v1.0.0-rc.2) and provides new functions to enable developers to build your own OCI client tool. | ||
|
||
As cloud native development continues to grow, we have seen increased community interest in evolving registries to natively store, pull, copy, and discover a graph of supply chain artifacts. Artifact references are important for many use cases such as adding Software Bill of Materials (SBoM), security scan results, and container image signatures. | ||
|
||
This blog will demonstrate how to use ORAS CLI v0.14 to copy an image from a public registry validated by Microsoft to a private registry, then attach an SBoM to it and discover the reference in a tree graph. | ||
|
||
 | ||
|
||
> Note: we will use MAR (Microsoft Artifact Registry) and ACR (Azure Container Registry) for demonstration purpose only. There will be another [blog posts](https://github.com/oras-project/oras-www/issues/54) to demonstrate how to use ORAS with Amazon ECR and Google GAR soon. | ||
## Install ORAS 0.14 | ||
|
||
Install the latest release of ORAS on a Linux environment: | ||
|
||
``` | ||
curl -LO https://github.com/oras-project/oras/releases/download/v0.14.1/oras_0.14.1_linux_amd64.tar.gz | ||
mkdir -p oras-install/ | ||
tar -zxf oras_0.14.1_*.tar.gz -C oras-install/ | ||
mv oras-install/oras /usr/local/bin/ | ||
rm -rf oras_0.14.1_*.tar.gz oras-install/ | ||
``` | ||
|
||
> Note: You can also refer to the [installation guide](https://oras.land/cli/) for other different platforms. | ||
## Copy an image from Registry A to Registry B | ||
|
||
In this demo, we'll use ORAS to copy the container image from the public MAR registry to my private ACR registry. You can use your preferred container registry with ORAS. | ||
|
||
``` | ||
oras copy mcr.microsoft.com/mmlspark/spark2.4:1.0.0 feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
``` | ||
|
||
## Using SBOM Tool to generate a SBOM | ||
|
||
An SBOM creates a machine-readable inventory of the software components that make up a given software product. Generating SBOM is a first step in Supply Chain Security. | ||
|
||
You can use [Docker SBOM](https://docs.docker.com/engine/sbom/) or [SBOM Tool](https://github.com/microsoft/sbom-tool) to generate a SBOM for the target image. | ||
|
||
SBOM Tool can be used to create SPDX 2.2 compatible SBOMs for any variety of artifacts. In this demo, we use SBOM Tool to create SPDX 2.2 compatible SBOM for the sample Spark image. | ||
|
||
Install the SBOM Tool within a Linux environment: | ||
|
||
``` | ||
curl -Lo sbom-tool https://github.com/microsoft/sbom-tool/releases/latest/download/sbom-tool-linux-x64 | ||
chmod +x sbom-tool | ||
``` | ||
|
||
Generate a SBOM for the Spark image stored in ACR: | ||
|
||
``` | ||
sbom-tool generate -di feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 \ | ||
-b ./foo \ | ||
-pn bar \ | ||
-pv 0.1 \ | ||
-bc ./foo \ | ||
-ps MyCompany \ | ||
-nsb http://mycompany.com | ||
``` | ||
|
||
Then it will create a SBOM `manifest.spdx.json` in `foo/_manifest/spdx_2.2`. | ||
|
||
## Attach the SBOM to this image | ||
|
||
Next, let's attach the generate SBOM to this Spark image stored in ACR: | ||
|
||
``` | ||
$ oras attach feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 foo/_manifest/spdx_2.2/manifest.spdx.json --artifact-type example/sbom | ||
Uploading 97a5dc071dd1 manifest.spdx.json | ||
Uploaded 97a5dc071dd1 manifest.spdx.json | ||
Attached to feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
Digest: sha256:7592c8026675e463e7ced9b7ed369c2962b354a69b842423e8ctestdigest | ||
``` | ||
|
||
## View the graph of artifacts | ||
|
||
A linked graph of supply chain artifacts can be viewed through the ORAS discovery command: | ||
|
||
``` | ||
$ oras discover feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
Discovered 1 artifacts referencing feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
Digest: sha256:28de427f1df8cdb99bc98536b489d75cc496a2d37c3b9266248etestdigest | ||
Artifact Type Digest | ||
example/sbom sha256:7592c8026675e463e7ced9b7ed369c2962b354a69b842423e8ctestdigest | ||
``` | ||
|
||
## ORAS Present and Future | ||
|
||
ORAS has been integrated and adopted by some industry-leading ISVs and projects, such as [soci-snapshotter](https://github.com/awslabs/soci-snapshotter) by AWS, [KubeApps](https://github.com/vmware-tanzu/kubeapps) by VMware Tanzu, [UOR Framework](https://universalreference.io/) by Red Hat etc. | ||
|
||
ORAS 0.15 and future milestones will provide more capabilities to easily manage OCI content and interact with registries. It will empower the container secure supply chain and focus on the following areas: | ||
|
||
- Be able to manage repository, tag, manifest, and blob | ||
- Support and migrate to OCI reference types | ||
- Support push/pull artifacts from OCI Image Layout | ||
- E2E testing | ||
|
||
See the ORAS [Roadmap](https://github.com/oras-project/community/blob/main/Roadmap.md) for more details. | ||
|
||
## Join the ORAS community | ||
|
||
The ORAS Project was accepted in June 2021 as a Cloud Native Computing Foundation (CNCF) Sandbox project. It is important that we hear from the community as we advance the artifact-spec capability; if you maintain or are implementing a container registry, we are particularly interested in your feedback. Working together, we can improve supply chain artifact security in the cloud native ecosystem. | ||
|
||
- [Follow the ORAS Twitter](https://twitter.com/intent/follow?screen_name=orasproject) | ||
- [Join the Slack channel in CNCF](https://slack.cncf.io/) and find us at **oras** channel | ||
--- | ||
slug: oras-0.14-and-future | ||
title: ORAS 0.14 and Future - Empower Container Secure Supply Chain | ||
authors: fzhou | ||
tags: [oras, artifact] | ||
--- | ||
|
||
The [OCI Registry As Storage (ORAS)](https://oras.land/) project maintainers announced v0.14 release for the ORAS CLI recently. ORAS v0.14 introduces four new top-level commands and new options to manage supply chain artifacts across different container registries and multi-cloud environments. | ||
|
||
<!--truncate--> | ||
|
||
## What's new in ORAS 0.14 | ||
|
||
 | ||
|
||
Please see the [Release Notes](https://github.com/oras-project/oras/releases/tag/v0.14.0) for details. | ||
|
||
Prior to ORAS CLI v0.14 release, the ORAS Go library, also released v2.0.0-rc.2 to support [artifacts-spec v1.0.0-rc.2](https://github.com/oras-project/artifacts-spec/releases/tag/v1.0.0-rc.2) and provides new functions to enable developers to build your own OCI client tool. | ||
|
||
As cloud native development continues to grow, we have seen increased community interest in evolving registries to natively store, pull, copy, and discover a graph of supply chain artifacts. Artifact references are important for many use cases such as adding Software Bill of Materials (SBoM), security scan results, and container image signatures. | ||
|
||
This blog will demonstrate how to use ORAS CLI v0.14 to copy an image from a public registry validated by Microsoft to a private registry, then attach an SBoM to it and discover the reference in a tree graph. | ||
|
||
 | ||
|
||
> Note: we will use MAR (Microsoft Artifact Registry) and ACR (Azure Container Registry) for demonstration purpose only. There will be another [blog posts](https://github.com/oras-project/oras-www/issues/54) to demonstrate how to use ORAS with Amazon ECR and Google GAR soon. | ||
|
||
## Install ORAS 0.14 | ||
|
||
Install the latest release of ORAS on a Linux environment: | ||
|
||
``` | ||
curl -LO https://github.com/oras-project/oras/releases/download/v0.14.1/oras_0.14.1_linux_amd64.tar.gz | ||
mkdir -p oras-install/ | ||
tar -zxf oras_0.14.1_*.tar.gz -C oras-install/ | ||
mv oras-install/oras /usr/local/bin/ | ||
rm -rf oras_0.14.1_*.tar.gz oras-install/ | ||
``` | ||
|
||
> Note: You can also refer to the [installation guide](https://oras.land/cli/) for other different platforms. | ||
## Copy an image from Registry A to Registry B | ||
|
||
In this demo, we'll use ORAS to copy the container image from the public MAR registry to my private ACR registry. You can use your preferred container registry with ORAS. | ||
|
||
``` | ||
oras copy mcr.microsoft.com/mmlspark/spark2.4:1.0.0 feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
``` | ||
|
||
## Using SBOM Tool to generate a SBOM | ||
|
||
An SBOM creates a machine-readable inventory of the software components that make up a given software product. Generating SBOM is a first step in Supply Chain Security. | ||
|
||
You can use [Docker SBOM](https://docs.docker.com/engine/sbom/) or [SBOM Tool](https://github.com/microsoft/sbom-tool) to generate a SBOM for the target image. | ||
|
||
SBOM Tool can be used to create SPDX 2.2 compatible SBOMs for any variety of artifacts. In this demo, we use SBOM Tool to create SPDX 2.2 compatible SBOM for the sample Spark image. | ||
|
||
Install the SBOM Tool within a Linux environment: | ||
|
||
``` | ||
curl -Lo sbom-tool https://github.com/microsoft/sbom-tool/releases/latest/download/sbom-tool-linux-x64 | ||
chmod +x sbom-tool | ||
``` | ||
|
||
Generate a SBOM for the Spark image stored in ACR: | ||
|
||
``` | ||
sbom-tool generate -di feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 \ | ||
-b ./foo \ | ||
-pn bar \ | ||
-pv 0.1 \ | ||
-bc ./foo \ | ||
-ps MyCompany \ | ||
-nsb http://mycompany.com | ||
``` | ||
|
||
Then it will create a SBOM `manifest.spdx.json` in `foo/_manifest/spdx_2.2`. | ||
|
||
## Attach the SBOM to this image | ||
|
||
Next, let's attach the generate SBOM to this Spark image stored in ACR: | ||
|
||
``` | ||
$ oras attach feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 foo/_manifest/spdx_2.2/manifest.spdx.json --artifact-type example/sbom | ||
Uploading 97a5dc071dd1 manifest.spdx.json | ||
Uploaded 97a5dc071dd1 manifest.spdx.json | ||
Attached to feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
Digest: sha256:7592c8026675e463e7ced9b7ed369c2962b354a69b842423e8ctestdigest | ||
``` | ||
|
||
## View the graph of artifacts | ||
|
||
A linked graph of supply chain artifacts can be viewed through the ORAS discovery command: | ||
|
||
``` | ||
$ oras discover feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
Discovered 1 artifacts referencing feynmanacr.azurecr.io/mmlspark/spark2.4:1.0.0 | ||
Digest: sha256:28de427f1df8cdb99bc98536b489d75cc496a2d37c3b9266248etestdigest | ||
Artifact Type Digest | ||
example/sbom sha256:7592c8026675e463e7ced9b7ed369c2962b354a69b842423e8ctestdigest | ||
``` | ||
|
||
## ORAS Present and Future | ||
|
||
ORAS has been integrated and adopted by some industry-leading ISVs and projects, such as [soci-snapshotter](https://github.com/awslabs/soci-snapshotter) by AWS, [KubeApps](https://github.com/vmware-tanzu/kubeapps) by VMware Tanzu, [UOR Framework](https://universalreference.io/) by Red Hat etc. | ||
|
||
ORAS 0.15 and future milestones will provide more capabilities to easily manage OCI content and interact with registries. It will empower the container secure supply chain and focus on the following areas: | ||
|
||
- Be able to manage repository, tag, manifest, and blob | ||
- Support and migrate to OCI reference types | ||
- Support push/pull artifacts from OCI Image Layout | ||
- E2E testing | ||
|
||
See the ORAS [Roadmap](https://github.com/oras-project/community/blob/main/Roadmap.md) for more details. | ||
|
||
## Join the ORAS community | ||
|
||
The ORAS Project was accepted in June 2021 as a Cloud Native Computing Foundation (CNCF) Sandbox project. It is important that we hear from the community as we advance the artifact-spec capability; if you maintain or are implementing a container registry, we are particularly interested in your feedback. Working together, we can improve supply chain artifact security in the cloud native ecosystem. | ||
|
||
- [Follow the ORAS Twitter](https://twitter.com/intent/follow?screen_name=orasproject) | ||
- [Join the Slack channel in CNCF](https://slack.cncf.io/) and find us at **oras** channel |
Oops, something went wrong.