From 080c6bb6049f71871f2e16dc7ae70aafc4f001b3 Mon Sep 17 00:00:00 2001 From: Yi Zha <107919912+yizha1@users.noreply.github.com> Date: Fri, 14 Oct 2022 23:37:22 +0800 Subject: [PATCH] doc: update doc after new release (#395) Signed-off-by: Yi Zha --- README.md | 33 ++++++++++++++++++--------------- docs/hello-signing.md | 9 ++++++--- 2 files changed, 24 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1ae1bb879..78bcb6bdb 100644 --- a/README.md +++ b/README.md @@ -8,25 +8,29 @@ Notation is a CLI project to add signatures as standard items in the registry ec ## Table of Contents -- [Notation Quick Start](#notation-quick-start) -- [Contributing](#contributing) -- [Core Documents](#core-documents) -- [Community](#community) -- [Release Management](#release-management) -- [Support](#support) -- [Code of Conduct](#code-of-conduct) -- [License](#license) - + - [Notation Quick Start](#notation-quick-start) + - [Documents](#documents) + - [Community](#community) + - [Development and Contributing](#development-and-contributing) + - [Notary v2 Community Meeting](#notary-v2-community-meeting) + - [Release Management](#release-management) + - [Support](#support) + - [Code of Conduct](#code-of-conduct) + - [License](#license) + ## Notation Quick Start - Install the Notation CLI from [Notation Releases][notation-releases]: - ```bash - curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.10.0-alpha.3/notation_0.10.0-alpha.3_linux_amd64.tar.gz - tar xvzf notation.tar.gz -C ~/bin notation - ``` + + ```bash + curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.11.0-alpha.4/notation_0.11.0-alpha.4_linux_amd64.tar.gz + tar xvzf notation.tar.gz -C ~/bin notation + ``` + - Run a local instance of the [CNCF Distribution Registry][cncf-distribution], with [ORAS Artifacts][artifact-manifest] support: + ```bash - docker run -d -p 5000:5000 ghcr.io/oras-project/registry:v1.0.0-rc + docker run -d -p 5000:5000 ghcr.io/oras-project/registry:v1.0.0-rc2 ``` - Build, push, sign, verify the `net-monitor` software: @@ -43,7 +47,6 @@ Notation is a CLI project to add signatures as standard items in the registry ec > Note: Signatures are persisted as [ORAS Artifacts manifests][artifact-manifest]. - ## Documents - [Hello World for Notation: Local signing and verification](docs/hello-signing.md) diff --git a/docs/hello-signing.md b/docs/hello-signing.md index a034d8d66..a19c6d3d7 100644 --- a/docs/hello-signing.md +++ b/docs/hello-signing.md @@ -47,15 +47,16 @@ ACME Rockets will only deploy software that's been scanned and approved by the A - Install [Docker Desktop](https://www.docker.com/products/docker-desktop) for local docker operations - Run a local instance of the [CNCF Distribution Registry][cncf-distribution], with [ORAS Artifacts][artifact-manifest] support. + ```bash - docker run -d -p ${PORT}:5000 ghcr.io/oras-project/registry:v0.0.3-alpha + docker run -d -p ${PORT}:5000 ghcr.io/oras-project/registry:v1.0.0-rc2 ``` - Acquire the Notation CLI (Notation releases can be found at: [Notation Releases][notation-releases]) ```bash #LINUX, including WSL - curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.7.1-alpha.1/notation_0.7.1-alpha.1_linux_amd64.tar.gz + curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.11.0-alpha.4/notation_0.11.0-alpha.4_linux_amd64.tar.gz tar xvzf notation.tar.gz -C ~/bin notation ``` @@ -93,7 +94,9 @@ To get things started quickly, the Notation cli supports self-generated signing ```bash notation sign $IMAGE ``` + To sign with COSE envelope + ```bash notation sign --envelope-type cose $IMAGE ``` @@ -176,6 +179,6 @@ Here are the additional steps to simulate a fully qualified DNS name for wabbit- - Continue with [Getting Started](#getting-started), but skip the environment variable configurations -[notation-releases]: https://github.com/notaryproject/notation/releases/tag/v0.7.1-alpha.1 +[notation-releases]: https://github.com/notaryproject/notation/releases/tag/v0.11.0-alpha.4 [artifact-manifest]: https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md [cncf-distribution]: https://github.com/oras-project/distribution