Skip to content

Commit

Permalink
doc: update doc after new release (notaryproject#395)
Browse files Browse the repository at this point in the history
Signed-off-by: Yi Zha <[email protected]>
  • Loading branch information
yizha1 authored Oct 14, 2022
1 parent b9f1fb5 commit 080c6bb
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 18 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand Down
9 changes: 6 additions & 3 deletions docs/hello-signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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

0 comments on commit 080c6bb

Please sign in to comment.