Skip to content

Commit

Permalink
chore: Update command docs for 1.1 and 1.2 (#349)
Browse files Browse the repository at this point in the history 
Just ran the refresh script for 1.1 and 1.2. This is the same change
that was merged in #319 but
it is for 1.1 and 1.2.

Closes: #350

Signed-off-by: Terry Howe <terrylhowe@gmail.com>
  • Loading branch information
Terry Howe authored Jun 25, 2024
1 parent 534b3f7 commit 38c814c
Show file tree
Hide file tree
Showing 23 changed files with 242 additions and 72 deletions.
1 change: 1 addition & 0 deletions versioned_docs/version-1.1/commands/oras_attach.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras attach
sidebar_position: 10
warning: Do NOT modify this generated file
---

# oras attach
Expand Down
16 changes: 8 additions & 8 deletions ...d_docs/version-1.1/commands/oras_copy.mdx → ...ned_docs/version-1.1/commands/oras_cp.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: oras copy
title: oras cp
sidebar_position: 50
warning: Do NOT modify this generated file
---

# oras copy
# oras cp

Copy artifacts from one target to another.
Copy artifacts from one target to another

```bash
oras copy [flags] <from>{:<tag>|@<digest>} <to>[:<tag>[,<tag>][...]]
oras cp [flags] <from>{:<tag>|@<digest>} <to>[:<tag>[,<tag>][...]]
```
## Examples
Expand All @@ -19,13 +20,13 @@ Copy an artifact between registries:
oras cp localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
```
Download an artifact into an OCI layout folder:
Download an artifact into an OCI image layout folder:
```bash
oras cp --to-oci-layout localhost:5000/net-monitor:v1 ./downloaded:v1
```
Upload an artifact from an OCI layout folder:
Upload an artifact from an OCI image layout folder:
```bash
oras cp --from-oci-layout ./to-upload:v1 localhost:5000/net-monitor:v1
Expand All @@ -46,8 +47,7 @@ oras cp -r localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
Copy an artifact and referrers using specific methods for the Referrers API:
```bash
oras cp -r --from-distribution-spec v1.1-referrers-api --to-distribution-spec v1.1-referrers-tag \
localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
oras cp -r --from-distribution-spec v1.1-referrers-api --to-distribution-spec v1.1-referrers-tag localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
```
Copy certain platform of an artifact:
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_discover.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras discover
sidebar_position: 30
sidebar_position: 60
warning: Do NOT modify this generated file
---

# oras discover
Expand Down
20 changes: 20 additions & 0 deletions versioned_docs/version-1.1/commands/oras_help.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: oras help
sidebar_position: 70
warning: Do NOT modify this generated file
---

# oras help

Help provides help for any command in the application.
Simply type oras help [path to command] for full details.

```bash
oras help [command] [flags]
```

## Options

```
-h, --help help for help
```
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_login.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras login
sidebar_position: 50
sidebar_position: 80
warning: Do NOT modify this generated file
---

# oras login
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_logout.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras logout
sidebar_position: 60
sidebar_position: 90
warning: Do NOT modify this generated file
---

# oras logout
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_pull.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras pull
sidebar_position: 70
sidebar_position: 140
warning: Do NOT modify this generated file
---

# oras pull
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_push.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras push
sidebar_position: 80
sidebar_position: 150
warning: Do NOT modify this generated file
---

# oras push
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_tag.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras tag
sidebar_position: 90
sidebar_position: 180
warning: Do NOT modify this generated file
---

# oras tag
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.1/commands/oras_version.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras version
sidebar_position: 100
sidebar_position: 190
warning: Do NOT modify this generated file
---

# oras version
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1.1/how_to_guides/distributing_oci_layouts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ tar -xf ./hello-world.tar -C hello-world

## Push the OCI Image to a Repository

You may use [`oras copy`](../commands/oras_copy.mdx) to push the OCI Image from your local disk to a repository.
You may use [`oras copy`](../commands/oras_cp.mdx) to push the OCI Image from your local disk to a repository.

In the following example, we are pushing the image to a local registry like zot:

Expand Down
67 changes: 45 additions & 22 deletions versioned_docs/version-1.2/commands/oras_attach.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras attach
sidebar_position: 10
warning: Do NOT modify this generated file
---

# oras attach
Expand All @@ -9,17 +10,29 @@ sidebar_position: 10
** This command is in preview and under development. **

```bash
oras attach [flags] --artifact-type=<type> <name>{:<tag>|@<digest>} <file>[:<type>] [...]
oras attach [flags] --artifact-type=<type> <name>{:<tag>|@<digest>} <file>[:<layer_media_type>] [...]
```

## Examples

Attach file 'hi.txt' with type 'doc/example' to manifest 'hello:v1' in registry 'localhost:5000':
Attach file 'hi.txt' with aritifact type 'doc/example' to manifest 'hello:v1' in registry 'localhost:5000':

```bash
oras attach --artifact-type doc/example localhost:5000/hello:v1 hi.txt
```

Attach file 'hi.txt' to a specific artifact with platform 'linux/amd64' in multi-arch index 'hello:v1'

```bash
oras attach --artifact-type doc/example --platform linux/amd64 localhost:5000/hello:v1 hi.txt
```

Push file "hi.txt" with the custom layer media type 'application/vnd.me.hi':

```bash
oras attach --artifact-type doc/example localhost:5000/hello:v1 hi.txt:application/vnd.me.hi
```

Attach file "hi.txt" using a specific method for the Referrers API:

```bash
Expand Down Expand Up @@ -60,24 +73,34 @@ oras attach --oci-layout --artifact-type doc/example layout-dir:v1 hi.txt
## Options

```
-a, --annotation stringArray manifest annotations
--annotation-file string path of the annotation file
--artifact-type string artifact type
--ca-file string server certificate authority file for the remote registry
--concurrency int concurrency level (default 5)
-d, --debug debug mode
--disable-path-validation skip path validation
--distribution-spec string [Preview] set OCI distribution spec version and API option for target. options: v1.1-referrers-api, v1.1-referrers-tag
--export-manifest path path of the pushed manifest
-H, --header stringArray add custom headers to requests
-h, --help help for attach
--insecure allow connections to SSL registry without certs
--oci-layout set target as an OCI image layout
-p, --password string registry password or identity token
--password-stdin read password or identity token from stdin
--plain-http allow insecure connections to registry without SSL check
--registry-config path path of the authentication file for registry
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
-u, --username string registry username
-v, --verbose verbose output
-a, --annotation stringArray manifest annotations
--annotation-file string path of the annotation file
--artifact-type string artifact type
--ca-file string server certificate authority file for the remote registry
--cert-file string client certificate file for the remote registry
--concurrency int concurrency level (default 5)
-d, --debug output debug logs (implies --no-tty)
--disable-path-validation skip path validation
--distribution-spec string [Preview] set OCI distribution spec version and API option for target. Options: v1.1-referrers-tag, v1.1-referrers-api
--export-manifest path path of the pushed manifest
--format string [Experimental] Format output using a custom template:
'json': Print in JSON format
'go-template': Print output using the given Go template
-H, --header stringArray add custom headers to requests
-h, --help help for attach
--identity-token string registry identity token
--identity-token-stdin read identity token from stdin
--insecure allow connections to SSL registry without certs
--key-file string client private key file for the remote registry
--no-tty [Preview] do not show progress output
--oci-layout set target as an OCI image layout
-p, --password string registry password or identity token
--password-stdin read password from stdin
--plain-http allow insecure connections to registry without SSL check
--platform os[/arch][/variant][:os_version] [Preview] attach to an arch-specific subject in the form of os[/arch][/variant][:os_version]
--registry-config path path of the authentication file for registry
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
--template string [Experimental] Template string used to format output
-u, --username string registry username
-v, --verbose verbose output
```
29 changes: 18 additions & 11 deletions ...d_docs/version-1.2/commands/oras_copy.mdx → ...ned_docs/version-1.2/commands/oras_cp.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: oras copy
title: oras cp
sidebar_position: 50
warning: Do NOT modify this generated file
---

# oras copy
# oras cp

Copy artifacts from one target to another.
Copy artifacts from one target to another

```bash
oras copy [flags] <from>{:<tag>|@<digest>} <to>[:<tag>[,<tag>][...]]
oras cp [flags] <from>{:<tag>|@<digest>} <to>[:<tag>[,<tag>][...]]
```
## Examples
Expand All @@ -19,13 +20,13 @@ Copy an artifact between registries:
oras cp localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
```
Download an artifact into an OCI layout folder:
Download an artifact into an OCI image layout folder:
```bash
oras cp --to-oci-layout localhost:5000/net-monitor:v1 ./downloaded:v1
```
Upload an artifact from an OCI layout folder:
Upload an artifact from an OCI image layout folder:
```bash
oras cp --from-oci-layout ./to-upload:v1 localhost:5000/net-monitor:v1
Expand All @@ -46,8 +47,7 @@ oras cp -r localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
Copy an artifact and referrers using specific methods for the Referrers API:
```bash
oras cp -r --from-distribution-spec v1.1-referrers-api --to-distribution-spec v1.1-referrers-tag \
localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
oras cp -r --from-distribution-spec v1.1-referrers-api --to-distribution-spec v1.1-referrers-tag localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
```
Copy certain platform of an artifact:
Expand All @@ -72,25 +72,32 @@ oras cp --concurrency 10 localhost:5000/net-monitor:v1 localhost:5000/net-monito
```
--concurrency int concurrency level (default 3)
-d, --debug debug mode
-d, --debug output debug logs (implies --no-tty)
--from-ca-file string server certificate authority file for the remote source registry
--from-distribution-spec string [Preview] set OCI distribution spec version and API option for source target. options: v1.1-referrers-api, v1.1-referrers-tag
--from-cert-file string client certificate file for the remote source registry
--from-distribution-spec string [Preview] set OCI distribution spec version and API option for source target. Options: v1.1-referrers-tag, v1.1-referrers-api
--from-header stringArray add custom headers to source requests
--from-identity-token string source registry identity token
--from-insecure allow connections to source SSL registry without certs
--from-key-file string client private key file for the remote source registry
--from-oci-layout set source target as an OCI image layout
--from-password string source registry password or identity token
--from-plain-http allow insecure connections to source registry without SSL check
--from-registry-config path path of the authentication file for source registry
--from-resolve host:port:address[:address_port] customized DNS for source registry, formatted in host:port:address[:address_port]
--from-username string source registry username
-h, --help help for cp
--no-tty [Preview] do not show progress output
--platform os[/arch][/variant][:os_version] request platform in the form of os[/arch][/variant][:os_version]
-r, --recursive [Preview] recursively copy the artifact and its referrer artifacts
--resolve host:port:address[:address_port] base DNS rules formatted in host:port:address[:address_port] for --from-resolve and --to-resolve
--to-ca-file string server certificate authority file for the remote destination registry
--to-distribution-spec string [Preview] set OCI distribution spec version and API option for destination target. options: v1.1-referrers-api, v1.1-referrers-tag
--to-cert-file string client certificate file for the remote destination registry
--to-distribution-spec string [Preview] set OCI distribution spec version and API option for destination target. Options: v1.1-referrers-tag, v1.1-referrers-api
--to-header stringArray add custom headers to destination requests
--to-identity-token string destination registry identity token
--to-insecure allow connections to destination SSL registry without certs
--to-key-file string client private key file for the remote destination registry
--to-oci-layout set destination target as an OCI image layout
--to-password string destination registry password or identity token
--to-plain-http allow insecure connections to destination registry without SSL check
Expand Down
22 changes: 17 additions & 5 deletions versioned_docs/version-1.2/commands/oras_discover.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: oras discover
sidebar_position: 30
sidebar_position: 60
warning: Do NOT modify this generated file
---

# oras discover
Expand Down Expand Up @@ -62,19 +63,30 @@ oras discover --oci-layout -v -o tree layout-dir:v1
```
--artifact-type string artifact type
--ca-file string server certificate authority file for the remote registry
-d, --debug debug mode
--distribution-spec string [Preview] set OCI distribution spec version and API option for target. options: v1.1-referrers-api, v1.1-referrers-tag
--cert-file string client certificate file for the remote registry
-d, --debug output debug logs (implies --no-tty)
--distribution-spec string [Preview] set OCI distribution spec version and API option for target. Options: v1.1-referrers-tag, v1.1-referrers-api
--format string [Experimental] Format output using a custom template:
'tree': Get referrers recursively and print in tree format
'table': Get direct referrers and output in table format
'json': Get direct referrers and output in JSON format
'go-template': Print direct referrers using the given Go template (default "tree")
-H, --header stringArray add custom headers to requests
-h, --help help for discover
--identity-token string registry identity token
--identity-token-stdin read identity token from stdin
--insecure allow connections to SSL registry without certs
--key-file string client private key file for the remote registry
--no-tty [Preview] do not show progress output
--oci-layout set target as an OCI image layout
-o, --output string format in which to display referrers (table, json, or tree). tree format will also show indirect referrers (default "table")
-o, --output string [Deprecated] format in which to display referrers (table, json, or tree). tree format will also show indirect referrers (default "tree")
-p, --password string registry password or identity token
--password-stdin read password or identity token from stdin
--password-stdin read password from stdin
--plain-http allow insecure connections to registry without SSL check
--platform os[/arch][/variant][:os_version] request platform in the form of os[/arch][/variant][:os_version]
--registry-config path path of the authentication file for registry
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
--template string [Experimental] Template string used to format output
-u, --username string registry username
-v, --verbose verbose output
```
20 changes: 20 additions & 0 deletions versioned_docs/version-1.2/commands/oras_help.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: oras help
sidebar_position: 70
warning: Do NOT modify this generated file
---

# oras help

Help provides help for any command in the application.
Simply type oras help [path to command] for full details.

```bash
oras help [command] [flags]
```

## Options

```
-h, --help help for help
```
Loading

0 comments on commit 38c814c

Please sign in to comment.