You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-20Lines changed: 34 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,40 +1,45 @@
1
1
# Ratify
2
2
3
3
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.
6
7
7
8
**WARNING:** This is experimental code. It is not considered production-grade
8
9
by its developers, nor is it "supported" software.
9
10
10
11
## Table of Contents
11
-
-[Ratify Quick Start](#ratify-quick-start)
12
+
13
+
-[Quick Start](#quick-start)
12
14
-[Documents](#documents)
13
15
-[Code of Conduct](#code-of-conduct)
14
16
-[Release Management](#release-management)
15
17
-[Licensing](#licensing)
16
18
-[Trademark](#trademark)
17
19
18
-
## Ratify Quick Start
20
+
## Quick Start
19
21
20
-
### Setup
22
+
### Setup
21
23
22
-
- Build the ```ratify``` binary
24
+
- Build the `ratify` binary
23
25
24
26
```bash
25
27
git clone https://github.com/deislabs/ratify.git
26
28
go build -o ~/bin ./cmd/ratify
27
29
```
28
30
29
-
- Build the ```ratify``` plugins and install them in the home directory
31
+
- Build the `ratify` plugins and install them in the home directory
30
32
31
33
```bash
32
34
go build -o ~/.ratify/plugins/ ./plugins/verifier/sbom
33
35
```
34
36
35
-
-```ratify``` is ready to use
37
+
-`ratify` is ready to use
36
38
37
39
```bash
40
+
$ ratify --help
41
+
Ratify is a reference artifact tool for managing and verifying reference artifacts
42
+
38
43
Usage:
39
44
ratify [flags]
40
45
ratify [command]
@@ -54,15 +59,18 @@ Use "ratify [command] --help" for more information about a command.
54
59
```
55
60
56
61
### 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
+
58
65
- 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`
61
68
62
-
This section outlines instructions for each of the above steps.
69
+
This section outlines instructions for each of the above steps.
63
70
64
71
#### **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.
66
74
67
75
- 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.
68
76
@@ -73,22 +81,25 @@ export REPO=net-monitor
73
81
export IMAGE=${REGISTRY}/${REPO}:v1
74
82
75
83
docker run -d -p ${PORT}:5000 ghcr.io/oras-project/registry:v0.0.3-alpha
0 commit comments