Skip to content

chore: update to 1.3.0-rc2 #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update to 1.3.0-rc2 #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 22 additions & 57 deletions versioned_docs/version-1.3.0-beta/commands/oras_attach.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,17 @@ warning: Do NOT modify this generated file
** This command is in preview and under development. **

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

## Examples

Attach file 'hi.txt' with artifact type 'doc/example' to manifest 'hello:v1' in registry 'localhost:5000':
Attach file 'hi.txt' with 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 All @@ -58,18 +46,6 @@ Attach file 'hi.txt' and add manifest annotations:
oras attach --artifact-type doc/example --annotation "key=val" localhost:5000/hello:v1 hi.txt
```

[Experimental] Attach file 'hi.txt' and format output in JSON:

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

[Experimental] Attach file 'hi.txt' and format output with Go template:

```bash
oras attach --artifact-type doc/example localhost:5000/hello:v1 hi.txt --format go-template --template "{{.digest}}"
```

Attach file 'hi.txt' and export the pushed manifest to 'manifest.json':

```bash
Expand All @@ -85,35 +61,24 @@ 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
--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
'text': Print in text format (default "text")
-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] disable progress bars
--oci-layout set target as an OCI image layout
--oci-layout-path string [Experimental] set the path for the OCI image layout target
-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
-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
```
11 changes: 3 additions & 8 deletions versioned_docs/version-1.3.0-beta/commands/oras_blob_delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,18 @@ oras blob delete --descriptor --force localhost:5000/hello@sha256:9a201d228ebd96

```
--ca-file string server certificate authority file for the remote registry
--cert-file string client certificate file for the remote registry
-d, --debug output debug logs (implies --no-tty)
-d, --debug debug mode
--descriptor output the descriptor
-f, --force ignore nonexistent references, never prompt
-H, --header stringArray add custom headers to requests
-h, --help help for delete
--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
--oci-layout set target as an OCI image layout
--oci-layout-path string [Experimental] set the path for the OCI image layout target
-p, --password string registry password or identity token
--password-stdin read password from stdin
--password-stdin read password or identity token from stdin
--plain-http allow insecure connections to registry without SSL check
--pretty prettify JSON objects printed to stdout
--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
```
11 changes: 3 additions & 8 deletions versioned_docs/version-1.3.0-beta/commands/oras_blob_fetch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,19 @@ oras blob fetch --oci-layout --output - layout.tar@sha256:9a201d228ebd966211f7d1

```
--ca-file string server certificate authority file for the remote registry
--cert-file string client certificate file for the remote registry
-d, --debug output debug logs (implies --no-tty)
-d, --debug debug mode
--descriptor output the descriptor
-H, --header stringArray add custom headers to requests
-h, --help help for fetch
--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] disable progress bars
--oci-layout set target as an OCI image layout
--oci-layout-path string [Experimental] set the path for the OCI image layout target
-o, --output path output file path, use - for stdout
-p, --password string registry password or identity token
--password-stdin read password from stdin
--password-stdin read password or identity token from stdin
--plain-http allow insecure connections to registry without SSL check
--pretty prettify JSON objects printed to stdout
--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
```
11 changes: 3 additions & 8 deletions versioned_docs/version-1.3.0-beta/commands/oras_blob_push.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,25 +66,20 @@ oras blob push --oci-layout layout-dir hi.txt

```
--ca-file string server certificate authority file for the remote registry
--cert-file string client certificate file for the remote registry
-d, --debug output debug logs (implies --no-tty)
-d, --debug debug mode
--descriptor output the descriptor
-H, --header stringArray add custom headers to requests
-h, --help help for push
--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
--media-type string specify the returned media type in the descriptor if --descriptor is used (default "application/vnd.oci.image.layer.v1.tar")
--no-tty [Preview] disable progress bars
--oci-layout set target as an OCI image layout
--oci-layout-path string [Experimental] set the path for the OCI image layout target
-p, --password string registry password or identity token
--password-stdin read password from stdin
--password-stdin read password or identity token from stdin
--plain-http allow insecure connections to registry without SSL check
--pretty prettify JSON objects printed to stdout
--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]
--size int provide the blob size (default -1)
-u, --username string registry username
-v, --verbose verbose output
```
20 changes: 6 additions & 14 deletions versioned_docs/version-1.3.0-beta/commands/oras_cp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ warning: Do NOT modify this generated file

# oras cp

Copy artifacts from one target to another. When copying an image index, all of its manifests will be copied
Copy artifacts from one target to another

```bash
oras cp [flags] <from>{:<tag>|@<digest>} <to>[:<tag>[,<tag>][...]]
Expand Down Expand Up @@ -48,7 +48,7 @@ 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
localhost:5000/net-monitor:v1 localhost:6000/net-monitor-copy:v1
```

Copy certain platform of an artifact:
Expand All @@ -73,38 +73,30 @@ oras cp --concurrency 10 localhost:5000/net-monitor:v1 localhost:5000/net-monito

```
--concurrency int concurrency level (default 3)
-d, --debug output debug logs (implies --no-tty)
-d, --debug debug mode
--from-ca-file string server certificate authority file for the remote source registry
--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-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-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-oci-layout-path string [Experimental] set the path for the source OCI image layout target
--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] disable progress bars
--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-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-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-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-oci-layout-path string [Experimental] set the path for the destination OCI image layout target
--to-password string destination registry password or identity token
--to-plain-http allow insecure connections to destination registry without SSL check
--to-registry-config path path of the authentication file for destination registry
--to-resolve host:port:address[:address_port] customized DNS for destination registry, formatted in host:port:address[:address_port]
--to-username string destination registry username
-v, --verbose verbose output
```
Loading