Skip to content

Commit d8f3566

Browse files
authored
Fixed markdown linting errors and links (#71)
Signed-off-by: Sajay Antony <[email protected]>
1 parent 6d3d6ce commit d8f3566

File tree

1 file changed

+34
-20
lines changed

1 file changed

+34
-20
lines changed

README.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,45 @@
11
# Ratify
22

33
The project provides a framework to integrate scenarios that require
4-
verification of references and aim to provide a set of interfaces that can
5-
be consumed by various systems that can participate in artifact verification.
4+
verification of reference artifacts and provides a set of interfaces
5+
that can be consumed by various systems that can participate in
6+
artifact ratification.
67

78
**WARNING:** This is experimental code. It is not considered production-grade
89
by its developers, nor is it "supported" software.
910

1011
## Table of Contents
11-
- [Ratify Quick Start](#ratify-quick-start)
12+
13+
- [Quick Start](#quick-start)
1214
- [Documents](#documents)
1315
- [Code of Conduct](#code-of-conduct)
1416
- [Release Management](#release-management)
1517
- [Licensing](#licensing)
1618
- [Trademark](#trademark)
1719

18-
## Ratify Quick Start
20+
## Quick Start
1921

20-
### Setup
22+
### Setup
2123

22-
- Build the ```ratify``` binary
24+
- Build the `ratify` binary
2325

2426
```bash
2527
git clone https://github.com/deislabs/ratify.git
2628
go build -o ~/bin ./cmd/ratify
2729
```
2830

29-
- Build the ```ratify``` plugins and install them in the home directory
31+
- Build the `ratify` plugins and install them in the home directory
3032

3133
```bash
3234
go build -o ~/.ratify/plugins/ ./plugins/verifier/sbom
3335
```
3436

35-
- ```ratify``` is ready to use
37+
- `ratify` is ready to use
3638

3739
```bash
40+
$ ratify --help
41+
Ratify is a reference artifact tool for managing and verifying reference artifacts
42+
3843
Usage:
3944
ratify [flags]
4045
ratify [command]
@@ -54,15 +59,18 @@ Use "ratify [command] --help" for more information about a command.
5459
```
5560

5661
### Verify a Graph of Supply Chain Content
57-
To get started with ```Ratify```, the basic steps involve
62+
63+
To get started with `ratify`, follow the step below.
64+
5865
- Create a graph of Supply Chain Content
59-
- Discover the graph using ```ratify```
60-
- Verify the graph using ```ratify```
66+
- Discover the graph using `ratify`
67+
- Verify the graph using `ratify`
6168

62-
This section outlines instructions for each of the above steps.
69+
This section outlines instructions for each of the above steps.
6370

6471
#### **Create a graph of Supply Chain Content**
65-
A graph of supply chain content can be created with different tools that can manage individual supply chain objects within the graph. For this quick start, the steps outlined in [Notary V2 project] (https://deploy-preview-48--notarydev.netlify.app/blog/2021/announcing-notation-alpha1/) will be used to create a sample graph with [```notation```](https://github.com/notaryproject/notation) and [```oras```](https://github.com/oras-project/oras/releases/tag/v0.2.1-alpha.1) CLI.
72+
73+
A graph of supply chain content can be created with different tools that can manage individual supply chain objects within the graph. For this quick start, the steps outlined in [Notary V2 project] (https://notaryproject.dev/blog/2021/announcing-notation-alpha1/) will be used to create a sample graph with [`notation`](https://github.com/notaryproject/notation) and [`ORAS`](https://github.com/oras-project/oras/releases/tag/v0.2.1-alpha.1) CLI.
6674

6775
- Run a local instance of the [CNCF Distribution Registry](https://github.com/oras-project/distribution), with [ORAS Artifacts](https://github.com/oras-project/artifacts-spec/blob/main/artifact-manifest.md) support.
6876

@@ -73,22 +81,25 @@ export REPO=net-monitor
7381
export IMAGE=${REGISTRY}/${REPO}:v1
7482

7583
docker run -d -p ${PORT}:5000 ghcr.io/oras-project/registry:v0.0.3-alpha
76-
```
84+
```
85+
7786
- Build & Push an image
7887

7988
```bash
8089
docker build -t $IMAGE https://github.com/wabbit-networks/net-monitor.git#main
8190

8291
docker push $IMAGE
8392
```
84-
- Sign the image and push the signature using ```notation```
93+
94+
- Sign the image and push the signature using `notation`
8595

8696
registry.
8797

8898
```bash
8999
notation cert generate-test --default "wabbit-networks.io"
90100
notation sign --plain-http $IMAGE
91101
```
102+
92103
- Generate a sample SBoM and push to registry
93104

94105
```bash
@@ -103,7 +114,7 @@ oras push ${REGISTRY}/${REPO} \
103114
sbom.json:application/json
104115
```
105116

106-
- Sign the SBoM and push the signature using ```notation```
117+
- Sign the SBoM and push the signature using `notation`
107118

108119
```bash
109120
# Capture the digest of the SBOM, to sign it
@@ -113,6 +124,7 @@ SBOM_DIGEST=$(oras discover -o json \
113124

114125
notation sign --plain-http $REGISTRY/$REPO@$SBOM_DIGEST
115126
```
127+
116128
This completes the creation of the supply chain graph.
117129

118130
#### **Create config with signature and SBoM verifiers**
@@ -156,16 +168,18 @@ cat <<EOF > ~/.ratify/config.json
156168
}
157169
EOF
158170
```
159-
#### Discover the graph
160171

161-
> Please make sure that the subject is referenced with ```digest``` rather
172+
#### Discover the graph
173+
174+
> Please make sure that the subject is referenced with `digest` rather
162175
than with the tag.
176+
163177
```bash
164178
export IMAGE_DIGEST_REF=$(docker image inspect $IMAGE | jq -r '.[0].RepoDigests[0]')
165179

166180
# Discover the graph
167181
ratify discover -s $IMAGE_DIGEST_REF
168-
```
182+
```
169183

170184
#### Verify the graph
171185

@@ -189,8 +203,8 @@ FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
189203
[[email protected]](mailto:[email protected]) with any additional
190204
questions or comments.
191205

192-
193206
## Release Management
207+
194208
The Ratify release process is defined in [RELEASES.md](./RELEASES.md).
195209

196210
## Licensing

0 commit comments

Comments
 (0)